Imported from registry/relations/cancel-job.md at commit 76a4a0c89924.

IRI Link Relation: cancel-job

Relation URI: https://iri.science/rels/cancel-job
CURIE: iri:cancel-job
Status: Provisional
Version: 1.0.0
Change controller: IRI technical subcommittee
Source representation type: DOE-IRI compute-system Resource representation or IRI v2 Job representation
Source resource type: urn:doe-iri:resource:compute:system when the source is a Resource; not applicable when the source is a Job
Target representation type: Selected-job cancellation operation entry point
OpenAPI operation: DELETE /api/v2/compute/cancel/{resource_id}/{job_id} (operationId: cancelJob)

This document defines the iri:cancel-job operation-affordance relationship used by DOE-IRI compute-system Resource and IRI v2 Job representations.

The canonical relation URI is https://iri.science/rels/cancel-job. With the canonical IRI CURIE template https://iri.science/rels/{rel}, iri:cancel-job expands to that URI. The relation URI identifies the link-relation semantics and is distinct from any target representation profile.

1. Relationship Metadata

2. Semantic Meaning

The iri:cancel-job relationship advertises the operation entry point through which a client may request cancellation of a selected job. Cancellation is an explicit state-changing invocation governed by OpenAPI, facility policy, and the selected job’s lifecycle state. The relation does not grant permission, assert that cancellation is currently valid, or guarantee success.

This relation does not redefine standard Task monitoring or Task lifecycle semantics and does not assign Task deletion as job cancellation.

3. Source, Target, and Operation Context

The relationship MAY originate from either:

1. a DOE-IRI Resource whose exact resource_type is urn:doe-iri:resource:compute:system; or
2. an IRI v2 Job representation for one selected job.

On a compute-system Resource, the producer MUST bind resource_id to the represented Resource’s adapter context. It MAY leave only job_id as a URI template variable, in which case the link MUST set templated to true. Expansion identifies a selected job in that Resource context and grants no permission to cancel arbitrary job identifiers.

On a Job representation, the producer MUST bind both resource_id and job_id. The producer MUST retain the compute-system operation context because a client cannot infer resource_id from job_id. A Job-source link MUST be a concrete URI, not a template with either identifier unresolved.

The adapter MUST implement the mapped operation for the applicable context. Resource Type hierarchy alone does not make generic compute, node, CPU, or GPU Resources eligible. When supported_endpoints is present on a Resource source, advertising iri:cancel-job requires "compute" in that array; the rule does not apply to Job representations, and the reverse implication does not apply. Authorization-suppressed omission does not make a retained "compute" category inconsistent.

A representation advertising iri:cancel-job MUST also advertise at least one applicable service-desc link whose deployed OpenAPI description contains the binding in Section 7. The operation link MUST NOT carry an IRI representation profile.

4. Cardinality

Each eligible source representation MAY advertise zero or one cancellation entry point:

Compute System  -- iri:cancel-job -->  Selected-job cancellation operation
       1                    0..1

Job             -- iri:cancel-job -->  Selected-job cancellation operation
 1                           0..1

The HAL relation uses a singular link object when supplied.

5. Stability and Availability

On a compute-system Resource, the relation describes a configured operation affordance and SHOULD remain stable across ordinary changes in load, capacity, queue state, or health. On a Job, the relation may also be omitted or withdrawn when cancellation is not applicable to the selected job’s lifecycle state.

The relation does not prove that the target is currently healthy, reachable, or available, or that a cancellation request is valid. Clients MUST use the governing OpenAPI contract and handle ordinary invocation failures.

6. Authorization, Visibility, and Omission

Authorization MAY affect visibility of the operation affordance. A provider MAY omit iri:cancel-job when the requester is not authorized to discover or use the entry point. On a Job representation, the producer MAY also omit it when cancellation is not applicable to that job.

Presence grants no permission and guarantees no successful cancellation. Omission means only that the affordance is not advertised in this representation; it does not prove that cancelling jobs is unsupported everywhere or permanently unavailable.

Links MUST NOT contain credentials or secrets. A client MUST NOT automatically forward credentials to an unrelated origin solely because an operation link or service description names it.

7. OpenAPI Contract and Binding

The current operation mapping is:

DELETE /api/v2/compute/cancel/{resource_id}/{job_id}
operationId: cancelJob
x-iri-relation: ["https://iri.science/rels/cancel-job"]

OpenAPI remains authoritative for path parameters, responses, errors, and security behavior. Clients MUST follow the advertised target and the applicable deployed OpenAPI description; they MUST NOT construct a URL or infer an HTTP method from the relation name. In particular, clients MUST treat the advertised target as a potentially destructive DELETE invocation and apply caller policy before following it. The canonical relation URI, rather than operationId, is the machine-readable binding key.

8. HAL Representation

Compute-system Resource with producer-bound resource_id and templated job_id:

{
  "id": "system-a",
  "resource_type": "urn:doe-iri:resource:compute:system",
  "supported_endpoints": ["compute"],
  "_links": {
    "curies": [
      {
        "name": "iri",
        "href": "https://iri.science/rels/{rel}",
        "templated": true
      }
    ],
    "iri:cancel-job": {
      "href": "https://api.example.org/api/v2/compute/cancel/system-a/{job_id}",
      "templated": true
    },
    "service-desc": {
      "href": "https://api.example.org/openapi.json",
      "type": "application/vnd.oai.openapi+json;version=3.1"
    }
  }
}

Job with both identifiers bound:

{
  "id": "job-42",
  "_links": {
    "curies": [
      {
        "name": "iri",
        "href": "https://iri.science/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "https://api.example.org/api/v2/compute/status/system-a/job-42"
    },
    "iri:cancel-job": {
      "href": "https://api.example.org/api/v2/compute/cancel/system-a/job-42"
    },
    "service-desc": {
      "href": "https://api.example.org/openapi.json",
      "type": "application/vnd.oai.openapi+json;version=3.1"
    }
  }
}

9. Governing Sources

• Resource operation-affordance RFC
• IRI v2 compute OpenAPI
• Common Resource profile
• Compute-system Resource Definition Profile
• Job profile

DOE Integrated Research Infrastructure — Link Relation: cancel-job