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(json-schema): support x-additionalPropertiesName #10006

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

eltoder
Copy link

@eltoder eltoder commented Jun 7, 2024

x-additionalPropertiesName is a Redocly extension to display more descriptive property names in objects with additionalProperties[1]. This allows generating nicer looking and more informative documentation and examples than Swagger UI's current "additionalProp" name.

[1] https://redocly.com/docs/api-reference-docs/specification-extensions/x-additional-properties-name/

My PR contains...

  • Features (non-breaking change which adds functionality)

My changes...

  • are not breaking changes.

Documentation

I haven't found the right place to document the change, but happy to add documentation if such a place exists.

Automated tests

  • My changes can not or do not need to be tested.
  • My changes can and should be tested by unit and/or integration tests.
  • If yes to above: I have added tests to cover my changes.
  • If yes to above: I have taken care to cover edge cases in my tests.
  • All new and existing tests passed.

x-additionalPropertiesName is a Redocly extension to display more
descriptive property names in objects with additionalProperties[1].
This allows generating nicer looking and more informative documentation
and examples than Swagger UI's current "additionalProp" name.

[1] https://redocly.com/docs/api-reference-docs/specification-extensions/x-additional-properties-name/
@eltoder eltoder force-pushed the ft/x-additionalPropertiesName branch from b7ccc38 to 43baa87 Compare June 7, 2024 23:02
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.

1 participant