feat(json-schema): support x-additionalPropertiesName - #10006
Merged
Conversation
eltoder
force-pushed
the
ft/x-additionalPropertiesName
branch
from
June 7, 2024 23:02
b7ccc38 to
43baa87
Compare
Contributor
|
@eltoder Please update your branch to align it with the base branch. |
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
force-pushed
the
ft/x-additionalPropertiesName
branch
from
July 8, 2025 15:56
43baa87 to
6bb0905
Compare
Contributor
Author
|
@cka121 done |
cka121
approved these changes
Jul 9, 2025
cka121
left a comment
cka121
left a comment
Contributor
There was a problem hiding this comment.
This PR adds a feature to allow custom naming of additional properties in sample output (including XML) via the x-additionalPropertiesName extension. The implementation is consistent, covered by test cases, allowing default values ensuring backward-compatible, and improves flexibility in sample generation.
swagger-bot
pushed a commit
that referenced
this pull request
Jul 16, 2025
# [5.27.0](v5.26.2...v5.27.0) (2025-07-16) ### Bug Fixes * permissions of files to allow running as non-root ([#10515](#10515)) ([679e73b](679e73b)) * sanitization of relative OpenAPI JSON paths ([#10528](#10528)) ([60dee8b](60dee8b)) ### Features * **json-schema:** support x-additionalPropertiesName ([#10006](#10006)) ([4bada92](4bada92))
Contributor
|
🎉 This PR is included in version 5.27.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
delendik-testops
pushed a commit
to ModiusOpenData/swagger-ui
that referenced
this pull request
Mar 3, 2026
delendik-testops
pushed a commit
to ModiusOpenData/swagger-ui
that referenced
this pull request
Mar 3, 2026
# [5.27.0](swagger-api/swagger-ui@v5.26.2...v5.27.0) (2025-07-16) ### Bug Fixes * permissions of files to allow running as non-root ([swagger-api#10515](swagger-api#10515)) ([679e73b](swagger-api@679e73b)) * sanitization of relative OpenAPI JSON paths ([swagger-api#10528](swagger-api#10528)) ([60dee8b](swagger-api@60dee8b)) ### Features * **json-schema:** support x-additionalPropertiesName ([swagger-api#10006](swagger-api#10006)) ([4bada92](swagger-api@4bada92))
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
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...
My 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