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

Fix proposal for #319 #327

Merged
merged 17 commits into from
Aug 21, 2023
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

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
[%metadata]
label:: /req/deploy-replace-undeploy/deploy/response-duplicate

part:: If a process with the same identifier already exists on the server, the satus code of the response SHALL be `303`.
part:: A response with HTTP status code `303` SHALL include a `Location` header with the URI of the duplicated processes (path: `/processes/{processId}`).
part:: If a process with the same identifier already exists on the server, the satus code of the response SHALL be `409`.
part:: A response with HTTP status code `409` MAY include a `Location` header with the URI of the duplicated processes (path: `/processes/{processId}`).
part:: The content of that response SHALL be based upon the OpenAPI
3.0 schema https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/schemas/exception.yaml[exception.yaml].
part:: The `type` of the exception SHALL be "http://www.opengis.net/def/exceptions/ogcapi-processes-2/1.0/duplicated-process".
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@
[%metadata]
label:: /req/deploy-replace-undeploy/deploy/response-immutable

part:: If a process with the same identifier already exists on the server and is immutable, the satus code of the response SHALL be `303`.
part:: A response with HTTP status code `303` SHALL include a `Location` header with the URI of the existing process (path: `/processes/{processId}`).
part:: The content of that response SHALL be based upon the OpenAPI
part:: If a process with the same identifier already exists on the server and is immutable, the satus code of the response SHALL be `403`.
part:: A response with HTTP status code `403` MAY include a `Location` header with the URI of the existing process (path: `/processes/{processId}`).
part:: The content of that response shall be based upon the OpenAPI
3.0 schema https://raw.githubusercontent.com/opengeospatial/ogcapi-processes/master/core/openapi/schemas/exception.yaml[exception.yaml].
part:: The `type` of the exception SHALL be "http://www.opengis.net/def/exceptions/ogcapi-processes-2/1.0/immutable-process".
====
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ include::../requirements/ogcapppkg/REQ_schema.adoc[]
.link:http://schemas.opengis.net/ogcapi/processes/part2/1.0/openapi/schemas/ogcapppkg.yaml[Schema for the OGC Application Package]
[source,yaml]
----
include::../openapi/schemas/ogcapppkg.yaml[]
include::../../../openapi/schemas/processes-dru/ogcapppkg.yaml[]
----

==== processDescription property
Expand Down
23 changes: 23 additions & 0 deletions openapi/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,27 @@ The list of supported paths should be ajusted in `ogcapi-processes-3.yaml`.

The `ogcapi-processes-3.bundled.json` was generated with `swagger-cli bundle` from `ogcapi-processes-3.yaml` and its dependencies included from the components sub-directories.

The `paths/processes-dru/pProcessListDeploy.yaml` and `paths/processes-dru/pProcessDescriptionReplaceUndeploy.yaml` files are generated by concatening multiple files in a single one. you can use the command below to update their value with the current schema:

```
cd openapi
# Refresh pProcessListDeploy.yaml content
rm paths/processes-dru/pProcessListDeploy.yaml ; \
for i in processes-core/pProcessList.yaml \
processes-dru/pDeploy.yaml ; \
do \
cat paths/$i >> paths/processes-dru/pProcessListDeploy.yaml;
done

# Refresh pProcessDescriptionReplaceUndeploy.yaml content
rm paths/processes-dru/pProcessDescriptionReplaceUndeploy.yaml; \
for i in processes-core/pProcessDescription.yaml \
processes-dru/pReplace.yaml \
processes-dru/pUndeploy.yaml ; \
do \
cat paths/$i >> paths/processes-dru/pProcessDescriptionReplaceUndeploy.yaml ;\
done

```

See also [SwaggerCLI](https://apitools.dev/swagger-cli/) and its [GitHub repository](https://github.com/APIDevTools/swagger-cli).
Loading