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.

Sign up for GitHub

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

Jump to bottom

Clarify deepObject applicability #2846

Merged
merged 3 commits into from
Feb 3, 2022
Merged

Clarify deepObject applicability #2846

merged 3 commits into from
Feb 3, 2022

Conversation

hkosova
Copy link
Contributor

@hkosova hkosova commented Jan 5, 2022 •
edited

This PR changes the description of the deepObject serialization style to mention "simple non-nested objects" instead of "nested objects". I think "nested objects" is a typo because @webron previously said that the deepObject behavior is not actually defined for nested objects.

when we defined deepObject in the spec, we explicitly chose to not mention what happens when the object has several levels in it, but in our conversations we went with 'not supported'. If you're looking for supporting that use case, it needs to be addressed by the spec first.

The "nested objects" phrase is confusing some tooling developers and users. I hope this change will help clarify things until #1706 is added to the spec.

darrelmiller
darrelmiller reviewed Feb 3, 2022
View reviewed changes
versions/3.1.1.md Outdated Show resolved Hide resolved
darrelmiller
darrelmiller reviewed Feb 3, 2022
View reviewed changes
versions/3.1.1.md Outdated Show resolved Hide resolved
@earth2marsh earth2marsh merged commit 49df1b2 into OAI:v3.1.1-dev Feb 3, 2022
@hkosova hkosova deleted the deepObject-wording branch February 3, 2022 19:36
@handrews handrews mentioned this pull request Apr 25, 2024
Open
@lornajane lornajane mentioned this pull request May 1, 2024
Merged
@handrews handrews added this to the v3.1.1 milestone May 17, 2024
@handrews handrews added clarification requests to clarify, but not change, part of the spec param serialization Issues related to parameter and/or header serialization labels May 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@darrelmiller darrelmiller darrelmiller approved these changes

Assignees
No one assigned
Labels
clarification requests to clarify, but not change, part of the spec param serialization Issues related to parameter and/or header serialization
Projects
None yet
Milestone
v3.1.1
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@hkosova @darrelmiller @earth2marsh @handrews