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

fix: update spec generation to align with reality #620

Merged
merged 3 commits into from
Dec 4, 2024

Conversation

ecshreve
Copy link
Contributor

@ecshreve ecshreve commented Dec 4, 2024

What does this do?

  • Various changes to swagger docs to align with public documentation and actual endpoint responses.

How was it tested?

  • localhost
  • a lot of playing around with schema generators

Is there a Github issue this is resolving?

#619
#358
#352 (was fixed awhile ago, but should definitely be good to close this issue now)

Was any impacted documentation updated to reflect this change?

This is docs, sort of

Here's a fun image for your troubles

random photo - update me

@ecshreve ecshreve changed the title WIP - fix: update spec generation to align with reality fix: update spec generation to align with reality Dec 4, 2024
@ecshreve ecshreve force-pushed the ecs/oapi-schema-gen branch 2 times, most recently from 75cbb18 to f5f5962 Compare December 4, 2024 04:47
@@ -201,7 +201,7 @@ class-spells-path:
content:
application/json:
schema:
$ref: '../schemas/combined.yml#/APIReferenceList'
Copy link
Contributor Author

Choose a reason for hiding this comment

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

fwiw, in a versioned world i would totally look at reworking the actual endpoint implementation for all of these to return a more uniform shape for "spells with a level". but if feels more important to have the docs match the actual response first.

@bagelbits bagelbits merged commit f49a053 into 5e-bits:main Dec 4, 2024
11 checks passed
Copy link

github-actions bot commented Dec 4, 2024

🎉 This PR is included in version 3.10.2 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants