-
Notifications
You must be signed in to change notification settings - Fork 9.1k
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
XML Object - an incomprehensible sentence #2106
Labels
clarification
requests to clarify, but not change, part of the spec
editorial
Wording and stylistic issues
media and encoding
Issues regarding media type support and how to encode data (outside of query/path params)
xml
Milestone
Comments
@hrennau , here's how I interpret that sentence:
Does that explain it better? If so, please feel free to submit a pull request with this change, so the Technical Specification Committee can review it. Your PR should be based on the |
PR merged for 3.0.4 and ported to 3.1.1 via PR #3921! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
clarification
requests to clarify, but not change, part of the spec
editorial
Wording and stylistic issues
media and encoding
Issues regarding media type support and how to encode data (outside of query/path params)
xml
In the OpenAPI spec, section "XML Object",
https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#xmlObject
the examples contain text which appears to me incomprehensible:
What does this tell us? What are "examples of the XML object definitions" - the examples in the spec? What is "a property definition of a Schema Object"? Is the sentence about where to put examples of the resulting XML? I have no clue what this sentence is meant to say. And I do not think this is entirely my fault.
The text was updated successfully, but these errors were encountered: