-
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
Update 3.0.4 Spec for Style Values #3685
Conversation
8f72236
to
46eca09
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Recommend revert change for spaceDelimited
and pipeDelimited
, or explain the behavior for objects.
versions/3.0.4.md
Outdated
spaceDelimited | `array`, `object` | `query` | Space separated array values. This option replaces `collectionFormat` equal to `ssv` from OpenAPI 2.0. | ||
pipeDelimited | `array`, `object` | `query` | Pipe separated array values. This option replaces `collectionFormat` equal to `pipes` from OpenAPI 2.0. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why add object
for these two styles? If we decide that we want this then I think the description should explain what this style means for objects and not just arrays.
versions/3.0.4.md
Outdated
spaceDelimited | `array`, `object` | `query` | Space separated array values. This option replaces `collectionFormat` equal to `ssv` from OpenAPI 2.0. | ||
pipeDelimited | `array`, `object` | `query` | Pipe separated array values. This option replaces `collectionFormat` equal to `pipes` from OpenAPI 2.0. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As discussed in TSC mtg:
spaceDelimited | `array`, `object` | `query` | Space separated array values. This option replaces `collectionFormat` equal to `ssv` from OpenAPI 2.0. | |
pipeDelimited | `array`, `object` | `query` | Pipe separated array values. This option replaces `collectionFormat` equal to `pipes` from OpenAPI 2.0. | |
spaceDelimited | `array`, `object` | `query` | Space separated array values or object properties. This option replaces `collectionFormat` equal to `ssv` from OpenAPI 2.0. | |
pipeDelimited | `array`, `object` | `query` | Pipe separated array values or object properties. This option replaces `collectionFormat` equal to `pipes` from OpenAPI 2.0. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"array values or object properties and values"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@mikekistler - this needs to be resolved before merged
46eca09
to
2b3889f
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @charjr
Closes #3682