Skip to content

Commit

Permalink
docs(MPDZBS-877): update docs for zmscitizenapi
Browse files Browse the repository at this point in the history
  • Loading branch information
Tom Fink authored and Tom Fink committed Nov 26, 2024
1 parent 5d9a5dc commit f653a22
Show file tree
Hide file tree
Showing 19 changed files with 879 additions and 112 deletions.
6 changes: 1 addition & 5 deletions zmsapi/public/doc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,4 @@ https://it-at-m.github.io/eappointment/zmsapi/public/doc/index.html

* To access all paths resolved via redoc or the open api documentation, a resolved swagger.json must be created from the swagger.yaml. This is done via the swagger cli with a call to ``bin/doc``. This call executes the above npm command ``npm run doc`` and subsequently creates a full swagger.json.

To render the open-api doc by redoc and swagger, appropriate files such as swagger-ui files are fetched in the CI process and stored at https://eappointment.gitlab.io/zmsapi/.

* If a new entity definition should be added, the reference must be set here under definitions.

Translated with www.DeepL.com/Translator (free version)
To render the open-api doc by redoc and swagger, appropriate files such as swagger-ui files are fetched in the CI process and stored at https://eappointment.gitlab.io/zmsapi/.
4 changes: 0 additions & 4 deletions zmscitizenapi/composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,6 @@
"scripts": {
"clean": "rm -f public/doc/assets/*.* && rm -f public/_test/assets/*.*",
"command": "bin/configure",
"wget-files": [
"wget https://eappointment.gitlab.io/zmsapi/doc/swagger.json -O public/doc/swagger.json",
"wget https://eappointment.gitlab.io/zmsapi/doc/assets/redoc.min.js -O public/doc/assets/redoc.min.js"
],
"post-install-cmd": [
"@wget-files"
],
Expand Down
Loading

0 comments on commit f653a22

Please sign in to comment.