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

XML Object - an incomprehensible sentence #2106

Open
hrennau opened this issue Jan 15, 2020 · 1 comment
Open

XML Object - an incomprehensible sentence #2106

hrennau opened this issue Jan 15, 2020 · 1 comment
Labels
clarification requests to clarify, but not change, part of the spec media and encoding Issues regarding media type support and how to encode data (outside of query/path params) xml

Comments

@hrennau
Copy link

hrennau commented Jan 15, 2020

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:

The examples of the XML object definitions are included inside a property definition of a Schema Object with a sample of the XML representation of it.

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.

@MikeRalphson MikeRalphson self-assigned this Jan 15, 2020
@tedepstein
Copy link
Contributor

tedepstein commented Feb 16, 2020

@hrennau , here's how I interpret that sentence:

Each of the following examples has three code snippets:

  1. A Schema Object in JSON syntax. The schema would be used to define a property within an object-typed schema, though the containing object schema is omitted for brevity. Property schemas are the only context in which an XML Object is meaningful.
  2. The same Schema Object in YAML syntax.
  3. An abbreviated XML example conforming to the Schema Object.

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 v3.0.3-dev branch.

@MikeRalphson MikeRalphson changed the title XMl Object - an incomprehensible sentence XML Object - an incomprehensible sentence Feb 21, 2023
@handrews handrews added clarification requests to clarify, but not change, part of the spec media and encoding Issues regarding media type support and how to encode data (outside of query/path params) labels Jan 28, 2024
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 media and encoding Issues regarding media type support and how to encode data (outside of query/path params) xml
Projects
None yet
Development

No branches or pull requests

4 participants