Add sample values for string formats uuid, hostname, ipv4 and ipv6 #5033
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.
Description
This PR adds sample values for
type: string
withformat: uuid
,format: hostname
,format: ipv4
andformat: ipv6
. While these formats are not defined by the OpenAPI Specification, they are defined by the JSON Schema which is what OpenAPI's Schema Object is closely based on.will now produce
Motivation and Context
As a technical writer, I want Swagger UI to display meaningful examples even if the API definition does not include
example
values.Also fixes #4986.
How Has This Been Tested?
Tested manually, also added automated tests.
Screenshots
Checklist
My PR contains...
src/
is unmodified: changes to documentation, CI, metadata, etc.)package.json
)My changes...
Documentation
Automated tests