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.

Sign up for GitHub

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

Fix proposal for #319 #327

Show file tree
Hide file tree
Changes from 14 commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
38ce0b5
Fix proposal for #319
gfenoy May 30, 2023
0e403c8
Add missing paths files and addition of part 2 in ogcapi-processes.yaml
gfenoy May 30, 2023
0e4d928
Fix typo in name directory and ogcapi-processes
gfenoy May 30, 2023
dbac653
Fix issue when using swagger-cli bundle
gfenoy May 30, 2023
9f1e66f
Fix location of the reference section for Deploy, Replace and Undeploy
gfenoy May 30, 2023
62f3743
Fix references typo, adding r prefix
gfenoy May 30, 2023
c2b5051
Fix comment from @fmigneault #328
gfenoy May 30, 2023
24077f6
Add missing content types
gfenoy May 30, 2023
e98f6f7
Fix typo in rDeployProcess.yaml
gfenoy May 30, 2023
26e325b
Add required yaml files composed of various existing schemas
gfenoy May 30, 2023
16ba65b
Use CommonWorkflowLanguage.yml as schema for application/cwl+json
gfenoy May 31, 2023
1cfc632
Remove long comments from ogcapi-processes.yaml
gfenoy May 31, 2023
b47410e
Fix indentation and remove the CommonWorkflowLanguage.yml
gfenoy May 31, 2023
9843ce5
Fix typo in the README.
gfenoy May 31, 2023
e1e204f
Fix typo in README
gfenoy May 31, 2023
a8347b5
Add description for choosing workflow to be deployed using the w-param
gfenoy May 31, 2023
f0743bb
Update openapi/paths/processes-dru/pDeploy.yaml
gfenoy Jul 20, 2023
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
1 change: 0 additions & 1 deletion extensions/deploy_replace_undeploy/standard/openapi/examples/README.md
View file
Open in desktop

This file was deleted.

242 changes: 0 additions & 242 deletions extensions/deploy_replace_undeploy/standard/openapi/examples/openapi.yaml
View file
Open in desktop

This file was deleted.

1 change: 0 additions & 1 deletion extensions/deploy_replace_undeploy/standard/openapi/parameters/README.md
View file
Open in desktop

This file was deleted.

1 change: 0 additions & 1 deletion extensions/deploy_replace_undeploy/standard/openapi/responses/README.md
View file
Open in desktop

This file was deleted.

1 change: 0 additions & 1 deletion extensions/deploy_replace_undeploy/standard/openapi/schemas/README.md
View file
Open in desktop

This file was deleted.

17 changes: 0 additions & 17 deletions extensions/deploy_replace_undeploy/standard/openapi/schemas/ogcapppkg.yaml
View file
Open in desktop

This file was deleted.

7 changes: 0 additions & 7 deletions extensions/deploy_replace_undeploy/standard/openapi/schemas/staticIndicator.yaml
View file
Open in desktop

This file was deleted.

49 changes: 0 additions & 49 deletions extensions/deploy_replace_undeploy/standard/openapi/schemas/swagger/ogcapppkg.yaml
View file
Open in desktop

This file was deleted.

4 changes: 2 additions & 2 deletions ...tandard/requirements/deploy-replace-undeploy/deploy/REQ_response-duplicate.adoc
View file
Open in desktop
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
6 changes: 3 additions & 3 deletions ...tandard/requirements/deploy-replace-undeploy/deploy/REQ_response-immutable.adoc
View file
Open in desktop
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".
====
2 changes: 1 addition & 1 deletion extensions/deploy_replace_undeploy/standard/sections/clause_7_apppkg.adoc
View file
Open in desktop
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
View file
Open in desktop
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 bellow to update their value with the current schema:
Copy link
Member

@jerstlouis jerstlouis May 31, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @gfenoy . bellow is still wrong though :) (below)

Copy link
Contributor Author

@gfenoy gfenoy May 31, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your patience @jerstlouis

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@gfenoy No thank you for yours ;) Sorry for being so annoying finding things to fix :P


```
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