Skip to content

Describe parameters uniformly with location #651

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

Closed
wants to merge 3 commits into from

Conversation

DavidBiesack
Copy link
Contributor

Do not use the term "parameter type* to refer to parameter locations (#parameterIn), just used location uniformly. Parameter type should only refer to the type field (#parameterType)

Use same order and values/case in the list as in the description and allowed values for in.

David Biesack added 3 commits April 12, 2016 14:33
…s/case in description.

Instead of using parameter *types* (which is not defined) and parameter *locations*, just used *location* uniformly;
*parameter type* should only refer to the parameterType field, to avoid confusion.

Use same order and values/case in the list of locations as in the description's allowed values for `in`.
Do not use the term "parameter type to refer to parameter *locations* (#parameterIn), just used *location* uniformly.
Parameter type should only refer to the `type` field (`p#arameterType`)

Use same order and values/case in the list as in the description and allowed values for `in`.
@DavidBiesack
Copy link
Contributor Author

Fixes #663

@webron
Copy link
Member

webron commented Apr 19, 2016

@DavidBiesack - as the change goes, it should be against the new 3.0 branch. Right now, changes that would potentially go into 2.0 would either be typo fixes, 'bug fixes' (faulty examples for example) or critical clarifications, and this doesn't fall under any of these.

As for uniformity, this does have room in 3.0.

@DavidBiesack
Copy link
Contributor Author

By "new 3.0 branch" do you mean OpenAPI.next ? I do not see a branch named "3.0" on https://github.com/OAI/OpenAPI-Specification/branches/active

(I think I need to follow this process to change the PR to OpenAPI.next.)

@webron
Copy link
Member

webron commented Apr 20, 2016

Yeah, that's what I meant. Submitting a PR against a different branch should be simple, but you'd need to submit it against a different document too.

@DavidBiesack
Copy link
Contributor Author

will do.

@webron
Copy link
Member

webron commented May 19, 2016

@DavidBiesack - I don't recall if you submitted a new PR, but I'll close this one for now.

@ePaul
Copy link
Contributor

ePaul commented Feb 27, 2017

I just submitted a new pull request with basically the same content against the correct branch: #923.

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