[plugin-documentation] Fix uid type and format #10667
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There's no "uid" type defined by the spec. "uid" should be treated as type "string" with format "uid".
|
This pull request has been mentioned on Strapi Community Forum. There might be relevant details there: https://forum.strapi.io/t/errors-on-generated-documentation-swagger-openapi/2802/2 |
|
This pull request has been mentioned on Strapi Community Forum. There might be relevant details there: https://forum.strapi.io/t/are-strapi-maintainers-accepting-pull-requests/9157/1 |
|
Hi 👋 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There's no "uid" type defined by the spec. "uid" should be treated as type "string" with format "uid".
What does it do?
Fixes a bug where the documentation plugin generates an invalid spec when a UID field type is used.
Why is it needed?
OpenAPI code generators will error out as they cannot handle an invalid data type of "uid".
How to test it?
Add a "UID" field and re-generate the API documentation, then use https://editor.swagger.io/ to validate the spec.
Related issue(s)/PR(s)
I couldn't find any related github issues but found a bug report in the forums: https://forum.strapi.io/t/errors-on-generated-documentation-swagger-openapi/2802