Skip to content

Commit

Permalink
openapi: Updated bundled JSON API definition
Browse files Browse the repository at this point in the history
  • Loading branch information
jerstlouis committed Sep 13, 2023
1 parent 9442b52 commit 2f2134c
Show file tree
Hide file tree
Showing 3 changed files with 3,673 additions and 24 deletions.
28 changes: 4 additions & 24 deletions openapi/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,29 +6,9 @@ The API definition can be visualized with [SwaggerUI](https://petstore.swagger.i
The lists of processes in the `/api` sub-directory should be tailored to the implementation & deployment, or those `/api/*` paths can be implemented dynamically by the server instead.
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
```
The `ogcapi-processes.bundled.json` was generated with `swagger-cli bundle` from `ogcapi-processes.yaml` and its dependencies included from the components sub-directories.

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

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 run the [update.sh](update.sh) script use to both update them and execute `swagger-cli bundle`.
Loading

0 comments on commit 2f2134c

Please sign in to comment.