diff --git a/extensions/deploy_replace_undeploy/standard/20-044.adoc b/extensions/deploy_replace_undeploy/standard/20-044.adoc index a10d9783..19178eb5 100644 --- a/extensions/deploy_replace_undeploy/standard/20-044.adoc +++ b/extensions/deploy_replace_undeploy/standard/20-044.adoc @@ -39,6 +39,8 @@ include::sections/clause_8_docker.adoc[] include::sections/clause_9_cwl.adoc[] +include::sections/clause_10_argo.adoc[] + include::sections/clause_10_oas.adoc[] include::sections/clause_11_media_types.adoc[] diff --git a/extensions/deploy_replace_undeploy/standard/recommendations/deploy-replace-undeploy/deploy/REC_body-argo.adoc b/extensions/deploy_replace_undeploy/standard/recommendations/deploy-replace-undeploy/deploy/REC_body-argo.adoc new file mode 100644 index 00000000..6f2358c6 --- /dev/null +++ b/extensions/deploy_replace_undeploy/standard/recommendations/deploy-replace-undeploy/deploy/REC_body-argo.adoc @@ -0,0 +1,15 @@ +[[rec_deploy-replace-undeploy_deploy_body-argo]] +[recommendation] +==== +[%metadata] +label:: /rec/deploy-replace-undeploy/deploy/body-argo + +part:: If a process can be represented for the intended use as a <>, implementations should consider supporting the <> encoding for describing the process to be deployed to the API. + +part:: The media type `application/argo` shall be used to indicate that request body contains a processes description encoded as a <>. + +part:: If the Argo contains more than one workflow, an additional `w` query parameter may be used to reference the workflow id to be deployed. + +part:: The server should validate the Argo at the request time. In case, the server cannot find the `w` identifier within the workflow from the Argo provided, a 400 status code is expected with the type "worflow-not-found". + +==== diff --git a/extensions/deploy_replace_undeploy/standard/recommendations/deploy-replace-undeploy/replace/REC_body-argo.adoc b/extensions/deploy_replace_undeploy/standard/recommendations/deploy-replace-undeploy/replace/REC_body-argo.adoc new file mode 100644 index 00000000..79584c5b --- /dev/null +++ b/extensions/deploy_replace_undeploy/standard/recommendations/deploy-replace-undeploy/replace/REC_body-argo.adoc @@ -0,0 +1,10 @@ +[[rec_deploy-replace-undeploy_replace_body-argo]] +[recommendation] +==== +[%metadata] +label:: /rec/deploy-replace-undeploy/replace/body-argo + +part:: If a process can be described for the intended use as a <>, implementations should consider supporting the <> encoding for describing the replacement process. + +part:: The media type `application/argo` shall be used to indicate that request body contains a processes description encoded as <>. +==== diff --git a/extensions/deploy_replace_undeploy/standard/recommendations/ogcapppkg/REC_ogcapppkg_execution-unit-argo.adoc b/extensions/deploy_replace_undeploy/standard/recommendations/ogcapppkg/REC_ogcapppkg_execution-unit-argo.adoc new file mode 100644 index 00000000..5ba79d88 --- /dev/null +++ b/extensions/deploy_replace_undeploy/standard/recommendations/ogcapppkg/REC_ogcapppkg_execution-unit-argo.adoc @@ -0,0 +1,19 @@ +[[rec_ogcapppkg_execution-unit-argo]] +[recommendation] +==== +[%metadata] +label:: /rec/ogcapppkg/execution-unit-argo + +part:: If the execution unit is encoded in Argo then it is recommended that the contents of the execution unit be the properties: + * `type` and `href` if passed by reference + * `value` and `mediaType` if passed by value + +part:: The value of the `type` property shall be `application/argo`, when for `mediaType` it should be `application/argo+json`. + +part:: The value of the `href` property shall be a reference to the Argo encoded file. The value of the `value` property shall be the Argo encoded in json format. + +part:: If the Argo contains more than a single workflow identifier, an addition `w` query parameter may be used to target a specific workflow id to be deployed. + +part:: The server should validate the Argo at the request time. In case, the server cannot find the `w` identifier within the workflow from the Argo provided, a 400 status code is expected with the type "argo-worflow-not-exist". + +==== diff --git a/extensions/deploy_replace_undeploy/standard/requirements/requirements_class_argo.adoc b/extensions/deploy_replace_undeploy/standard/requirements/requirements_class_argo.adoc new file mode 100644 index 00000000..f84bc0cc --- /dev/null +++ b/extensions/deploy_replace_undeploy/standard/requirements/requirements_class_argo.adoc @@ -0,0 +1,11 @@ +[[rc_cwl]] +[requirements_class] +==== +[%metadata] +label:: http://www.opengis.net/spec/ogcapi-processes-2/1.0/req/argo +obligation:: requirement +subject:: Web API +inherit:: <> +inherit:: <> +inherit:: Argo Workflow Language <> +==== diff --git a/extensions/deploy_replace_undeploy/standard/sections/clause_10_argo.adoc b/extensions/deploy_replace_undeploy/standard/sections/clause_10_argo.adoc new file mode 100644 index 00000000..74bbc122 --- /dev/null +++ b/extensions/deploy_replace_undeploy/standard/sections/clause_10_argo.adoc @@ -0,0 +1,16 @@ +== Requirements Class "Argo" + +[[argo-overview]] +=== Overview + +include::../requirements/requirements_class_argo.adoc[] + +A server that implements this conformance class supports the use of Argo encoding when interacting with the deploy-replace-undeploy extension from a processes API. + +In consequence, the following recommandations become requirements: + + * <> + * <> + * <> + +