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

Update 3.0.4 Spec for Style Values #3685

Merged
merged 1 commit into from
Apr 18, 2024

Conversation

charjr
Copy link
Contributor

@charjr charjr commented Mar 28, 2024

Closes #3682

@handrews handrews added the param serialization Issues related to parameter and/or header serialization label Mar 28, 2024
Copy link
Contributor

@mikekistler mikekistler left a 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.

Comment on lines 1057 to 1058
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.
Copy link
Contributor

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.

Comment on lines 1057 to 1058
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.
Copy link
Contributor

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:

Suggested change
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.

Copy link
Member

@karenetheridge karenetheridge Apr 4, 2024

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"

Copy link
Contributor

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

@lornajane lornajane requested a review from a team April 17, 2024 10:19
Copy link
Contributor

@lornajane lornajane left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @charjr

@lornajane lornajane merged commit 827aaa8 into OAI:v3.0.4-dev Apr 18, 2024
1 check passed
@handrews handrews added this to the v3.0.4 milestone May 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
param serialization Issues related to parameter and/or header serialization
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants