Skip to content

Commit

Permalink
docs: Render OpenAPI content into md document, remove generated ymls …
Browse files Browse the repository at this point in the history
…from git (DEV-3443) (#3254)
  • Loading branch information
seakayone authored May 28, 2024
1 parent d7d7db7 commit 7f7c0b6
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 5,146 deletions.
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,6 @@ venv/

# exclude generated openapi
docs/03-endpoints/generated-openapi/*
!docs/03-endpoints/generated-openapi/openapi-admin-api.yml

# exclude test reports generated by xunit-viewer
/index.html
Expand Down
7 changes: 3 additions & 4 deletions docs/03-endpoints/api-admin/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
We provide an [OpenAPI](https://spec.openapis.org/oas/latest.html) specification.
We provide an [OpenAPI](https://spec.openapis.org/oas/latest.html) specification for certain endpoints and are working on providing this for all endpoints.
The latest version is located at [api.dasch.swiss/api/docs/docs.yaml](https://api.dasch.swiss/api/docs/docs.yaml).
For an interactive documentation of all API endpoints,
please visit [api.dasch.swiss/api/docs/](https://api.dasch.swiss/api/docs/).
For an interactive documentation of all API endpoints, please visit [api.dasch.swiss/api/docs/](https://api.dasch.swiss/api/docs/).

[OAD](../generated-openapi/openapi-admin-api.yml)
[OAD(./docs/03-endpoints/generated-openapi/openapi-admin-api.yml)]
Loading

0 comments on commit 7f7c0b6

Please sign in to comment.