Skip to content

Describe parameters uniformly with location - #651

Closed
DavidBiesack wants to merge 3 commits into
OAI:masterfrom
DavidBiesack:param-types
Closed

DavidBiesack wants to merge 3 commits into
OAI:masterfrom
DavidBiesack:param-types

Conversation

@DavidBiesack

Copy link
Copy Markdown

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
Copy Markdown
Author

Fixes #663

@webron

webron commented Apr 19, 2016

Copy link
Copy Markdown
Member

@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
Copy Markdown
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

webron commented Apr 20, 2016

Copy link
Copy Markdown
Member

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
Copy Markdown
Author

will do.

@webron

webron commented May 19, 2016

Copy link
Copy Markdown
Member

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

@ePaul

ePaul commented Feb 27, 2017

Copy link
Copy Markdown
Contributor

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