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

OpenAPI for server-server API is not published #1649

Closed
richvdh opened this issue Sep 26, 2023 · 0 comments · Fixed by #1657
Closed

OpenAPI for server-server API is not published #1649

richvdh opened this issue Sep 26, 2023 · 0 comments · Fixed by #1657
Labels
aesthetic A suggestion or issue relating to the representation of the spec

Comments

@richvdh
Copy link
Member

richvdh commented Sep 26, 2023

The OpenAPI specs for most of the APIs are available at https://spec.matrix.org/{version}/{api}/api.json. Examples:

However, the server-server api is not there. Previously, this was due to invalid data (#14), but that is now fixed. We should update

scripts/dump-openapi.py \
--base-url "https://spec.matrix.org${{ needs.calculate-baseurl.outputs.baseURL }}" \
--api application-service \
-r "$RELEASE" \
-o spec/application-service-api/api.json
scripts/dump-openapi.py \
--base-url "https://spec.matrix.org${{ needs.calculate-baseurl.outputs.baseURL }}" \
--api client-server \
-r "$RELEASE" \
-o spec/client-server-api/api.json
scripts/dump-openapi.py \
--base-url "https://spec.matrix.org${{ needs.calculate-baseurl.outputs.baseURL }}" \
--api push-gateway \
-r "$RELEASE" \
-o spec/push-gateway-api/api.json
to publish the APIs.

@richvdh richvdh added the aesthetic A suggestion or issue relating to the representation of the spec label Sep 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
aesthetic A suggestion or issue relating to the representation of the spec
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant