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

feat: better openapi docs #1300

Merged
merged 41 commits into from
Nov 29, 2024
Merged

feat: better openapi docs #1300

merged 41 commits into from
Nov 29, 2024

Conversation

B4nan
Copy link
Member

@B4nan B4nan commented Nov 22, 2024

This PR overhauls our OpenAPI setup completely:

Things to discuss:

  • index page now only redirects, maybe we should move the content from the introduction section (so outside of OpenAPI specs)
  • folder structure
  • OpenAPI tests and schemathesis
  • nested readmes in openapi folder

@github-actions github-actions bot added this to the 103rd sprint - Tooling team milestone Nov 22, 2024
@github-actions github-actions bot added the t-tooling Issues with this label are in the ownership of the tooling team. label Nov 22, 2024
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Pull Request Tookit has failed!

Pull request is neither linked to an issue or epic nor labeled as adhoc!

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Pull Request Tookit has failed!

Pull request is neither linked to an issue or epic nor labeled as adhoc!

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Pull Request Tookit has failed!

Pull request is neither linked to an issue or epic nor labeled as adhoc!

@B4nan B4nan added the adhoc Ad-hoc unplanned task added during the sprint. label Nov 22, 2024
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Pull Request Tookit has failed!

Pull request is neither linked to an issue or epic nor labeled as adhoc!

@TC-MO
Copy link
Contributor

TC-MO commented Nov 25, 2024

I took a look and I think the easiest way will be to just exclude /source/api from mdlint, vale & typos

@B4nan
Copy link
Member Author

B4nan commented Nov 25, 2024

That's exactly what I am trying to do, it works for typos, still battling with the other two.

@B4nan B4nan force-pushed the new-api-docs branch 2 times, most recently from 4b0b2c7 to 6c695c7 Compare November 25, 2024 18:26
@B4nan B4nan merged commit 990e279 into master Nov 29, 2024
7 of 8 checks passed
@B4nan B4nan deleted the new-api-docs branch November 29, 2024 15:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
adhoc Ad-hoc unplanned task added during the sprint. t-tooling Issues with this label are in the ownership of the tooling team.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants