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

server-server YAML files are not valid #14

Closed
12 tasks
afranke opened this issue Feb 2, 2022 · 3 comments
Closed
12 tasks

server-server YAML files are not valid #14

afranke opened this issue Feb 2, 2022 · 3 comments
Labels
A-Tools Related to the process and tools for building the spec

Comments

@afranke
Copy link
Contributor

afranke commented Feb 2, 2022

Running node validator.js on each of the files in data/api/server-server reveals errors in the following ones:

  • invites-v1.yaml
  • invites-v2.yaml
  • joins-v1.yaml
  • joins-v2.yaml
  • keys_query.yaml
  • keys_server.yaml
  • knocks.yaml
  • leaving-v1.yaml
  • leaving-v2.yaml
  • third_party_invite.yaml
  • transactions.yaml
  • user_keys.yaml

I haven’t taken the time to look into the files in the definitions/ subdirectory, that should be checked too.

This is blocking publication (via CI) of the server-server OpenAPI JSON.

@richvdh richvdh transferred this issue from matrix-org/matrix-spec-proposals Mar 1, 2022
@turt2live turt2live added the A-Tools Related to the process and tools for building the spec label May 28, 2022
@zecakeh
Copy link
Contributor

zecakeh commented Sep 26, 2023

These files now pass validation, since they have been fixed before changing the validator in CI to Redocly-CLI.

Does that mean that the OpenAPI server-server definition should be generated in CI now?

@richvdh
Copy link
Member

richvdh commented Sep 26, 2023

Interesting. Yes it should, but it currently is not:

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

@richvdh
Copy link
Member

richvdh commented Sep 26, 2023

closing in favour of #1649

@richvdh richvdh closed this as completed Sep 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Tools Related to the process and tools for building the spec
Projects
None yet
Development

No branches or pull requests

4 participants