Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/fix issue 464 #473

Merged
merged 3 commits into from
Nov 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
[[per_job-provenance_run_content-negotiation]]
[[per_job-provenance_prov_content-negotiation]]
[permission]
====
[%metadata]
label:: /per/provenance/run-content-negotiation
label:: /per/provenance/prov-content-negotiation
part:: Content negotiation MAY be supported to provide alternate representations of the response.
part:: The server MAY support the following additional content type: `application/ld+json` for PROV-O as JSON-LD
part:: The server MAY support the following additional content type: `application/xml` for PROV-XML
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
[[req_job-provenance_prov_get-op]]
[requirement]
====
[%metadata]
label:: /req/provenance/prov-get-op
part:: For every created jobs (path: `/jobs/{jobId}/prov`), the server SHALL support the HTTP GET operation.
part:: The parameter `{jobId}` is each `id` property in the job list response (JSONPath: `$.jobs[*].id`).
====
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
[[req_provenance_run_response]]
[[req_provenance_prov_response]]
[requirement]
====
[%metadata]
label:: /req/provenance/run-response
label:: /req/provenance/prov-response
part:: A successful execution of the operation SHALL be reported as a response with a HTTP status code '200'.
part:: Per default, the response SHALL contains a JSON document that conforms to the https://www.w3.org/submissions/prov-json/schema[schema for PROV-JSON].
part:: In case content-negotiation is used, the response MAY contain other representations including PROV-O as JSON-LD, PROV-XML or PROV-N.
Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -21,18 +21,18 @@ include::../requirements/provenance/inputs/REQ_get-op.adoc[]

include::../requirements/provenance/inputs/REQ_response.adoc[]

==== Run
==== Prov

The server MUST provide an endpoint to retrieve the run of a job.
The server MUST provide an endpoint to retrieve the provenance of a job.

===== Operation

include::../requirements/provenance/run/REQ_get-op.adoc[]
include::../requirements/provenance/prov/REQ_get-op.adoc[]

include::../recommendations/provenance/run/PER_content-negotiation.adoc[]
include::../recommendations/provenance/prov/PER_content-negotiation.adoc[]

===== Response

include::../requirements/provenance/run/REQ_response.adoc[]
include::../requirements/provenance/prov/REQ_response.adoc[]


2 changes: 2 additions & 0 deletions openapi/paths/processes-dru/pDeploy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ post:
responses:
201:
$ref: "../../schemas/processes-core/processSummary.yaml"
400:
$ref: "../../responses/processes-dru/rWorkflowNotFound.yaml"
403:
$ref: "../../responses/processes-dru/rImmutableProcess.yaml"
409:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,8 @@ put:
responses:
204:
$ref: "../../responses/processes-core/rEmpty.yaml"
400:
$ref: "../../responses/processes-dru/rWorkflowNotFound.yaml"
403:
$ref: "../../responses/processes-dru/rImmutableProcess.yaml"
404:
Expand Down
2 changes: 2 additions & 0 deletions openapi/paths/processes-dru/pProcessListDeploy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@ post:
responses:
201:
$ref: "../../schemas/processes-core/processSummary.yaml"
400:
$ref: "../../responses/processes-dru/rWorkflowNotFound.yaml"
403:
$ref: "../../responses/processes-dru/rImmutableProcess.yaml"
409:
Expand Down
2 changes: 2 additions & 0 deletions openapi/paths/processes-dru/pReplace.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ put:
responses:
204:
$ref: "../../responses/processes-core/rEmpty.yaml"
400:
$ref: "../../responses/processes-dru/rWorkflowNotFound.yaml"
403:
$ref: "../../responses/processes-dru/rImmutableProcess.yaml"
404:
Expand Down
3 changes: 3 additions & 0 deletions openapi/schemas/processes-job-management/headers.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
type: object
additionalProperties:
type: string
2 changes: 2 additions & 0 deletions openapi/schemas/processes-job-management/inputs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,5 @@ properties:
type: array
items:
$ref: "../processes-core/metadata.yaml"
headers:
$ref: "headers.yaml"
Loading