swagger-ui icon indicating copy to clipboard operation
swagger-ui copied to clipboard

feat(json-schema): support x-additionalPropertiesName

Open eltoder opened this issue 1 year ago • 0 comments

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...

  • [x] Features (non-breaking change which adds functionality)

My changes...

  • [x] 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.
  • [x] My changes can and should be tested by unit and/or integration tests.
  • [x] 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.
  • [x] All new and existing tests passed.

eltoder avatar Jun 07 '24 22:06 eltoder