Skip to content

Deprecated clarfications around arrays #753

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

Merged
merged 7 commits into from
Sep 2, 2019
Merged

Deprecated clarfications around arrays #753

merged 7 commits into from
Sep 2, 2019

Conversation

philsturgeon
Copy link
Collaborator

No description provided.

@philsturgeon
Copy link
Collaborator Author

I think I fixed it?

@Relequestual
Copy link
Member

I'm unsure what it ought to mean...

My feeling is that people will only look to use this if they know what they want to indicate.

@philsturgeon Say the first item in items is deprecated. Does that mean the second item then becomes the first version? I can't see it means anything else. Right?

@handrews
Copy link
Contributor

@Relequestual some languages allow undefined array positions.

But really it means "it won't look like this anymore soon", it does not say what it will look like. The default assumption is that it goes away, but you could also just use it to indicate an overall change. I guess.

@handrews
Copy link
Contributor

@philsturgeon @Relequestual what still needs to be done here?

@philsturgeon
Copy link
Collaborator Author

philsturgeon commented Jul 12, 2019 via email

@Relequestual
Copy link
Member

Relequestual commented Jul 19, 2019

@philsturgeon I guess the objective of this PR is to align with the expectations of people who see this when enclosed in an OpenAPI spec document, right?

As such, can you encourage someone from the OpenAPI spec team to take a little look and agree that this change meets said objective? I took a little look at the spec, but I can't see this expectation. Am I reading it wrong? Does this expectation come from somewhere else?

I've made a further review. One question, one suggested language change.
I think this is certinly clearer from where we started! Direction of travel is good! =]

@handrews
Copy link
Contributor

handrews commented Aug 9, 2019

@philsturgeon @Relequestual any update on this?

@philsturgeon
Copy link
Collaborator Author

I was trying to get an OAI person to review this. I'll bump it on their slack. We'll give it a few more days then just merge.

@Relequestual
Copy link
Member

I've added a comment on the review.

My query is regarding, if deprecated changes behaviour when items is an array of schemas, to indicate that one of the subschemas will be deprecated, how is the position known?

See my review comment.

@handrews handrews added this to the draft-08 milestone Aug 25, 2019
@philsturgeon philsturgeon merged commit 71612be into master Sep 2, 2019
@philsturgeon philsturgeon deleted the deprecated branch September 2, 2019 22:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants