Skip to content

Fix: OpenAPI Schema for held_items#1248

Merged
Naramsim merged 5 commits intoPokeAPI:masterfrom
PraaneshSelvaraj:fix/serializer-openapi
May 31, 2025
Merged

Fix: OpenAPI Schema for held_items#1248
Naramsim merged 5 commits intoPokeAPI:masterfrom
PraaneshSelvaraj:fix/serializer-openapi

Conversation

@PraaneshSelvaraj
Copy link
Copy Markdown
Contributor

This PR updates the held_items schema in the PokemonDetail response to correctly reflect it as an array of objects (not a single object), matching actual API responses.

Fixes #1247

@Indyandie
Copy link
Copy Markdown
Contributor

@PraaneshSelvaraj you'll also need to regenerate the spec to apply your changes. If I remember correctly running the command below should do it.

make openapi-generate

@Naramsim would it be a bad idea to add openapi instructions some where in the docs?

@PraaneshSelvaraj
Copy link
Copy Markdown
Contributor Author

@Indyandie I regenerated openapi.yml. I only changed held_items, but a lot changed in the file. Did I do something wrong or was it just outdated?

@Indyandie
Copy link
Copy Markdown
Contributor

There have been lots of updates since the last generation.

@Naramsim maybe we can add some automation to regenerate the spec anytime there are relevant changes.

@PraaneshSelvaraj
Copy link
Copy Markdown
Contributor Author

@Indyandie Hey, Is this PR good to merge or should I add something else?

@Indyandie
Copy link
Copy Markdown
Contributor

Your changes should fix the issue.

@PraaneshSelvaraj
Copy link
Copy Markdown
Contributor Author

@Naramsim Hey, PR is good to merge now.

@Naramsim Naramsim merged commit d039123 into PokeAPI:master May 31, 2025
9 checks passed
@pokeapi-machine-user
Copy link
Copy Markdown

A PokeAPI/api-data refresh has started. In ~45 minutes the staging branch of PokeAPI/api-data will be pushed with the new generated data.

The staging branch will be deployed in our staging environment and the entire API will be ready to review.

A Pull Request (master<-staging) will be also created at PokeAPI/api-data and assigned to the PokeAPI Core team to be reviewed. If approved and merged new data will soon be available worldwide at pokeapi.co.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

openapi.yml API Error

4 participants