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

documented `requestBody` #878

Merged
merged 7 commits into from Feb 7, 2017

Conversation

Projects
None yet
5 participants
@fehguy
Contributor

fehguy commented Feb 1, 2017

This PR adds documentation for requestBody to describe inputs into operations.

This fixes #665, #303, #222, #418, #179, #874, #800, #303,

It clarifies #430

Show outdated Hide outdated versions/3.0.md
Show outdated Hide outdated versions/3.0.md
@whitlockjc

This comment has been minimized.

Show comment
Hide comment
@whitlockjc

whitlockjc Feb 2, 2017

Member

There are a few places where you use requestBody and I wonder what you think about using a link to the "Request Body Object" documentation itself instead? I see that in the "Content Object" section (https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.md#content-object) we're already doing this and that's why it came to mind.

Member

whitlockjc commented Feb 2, 2017

There are a few places where you use requestBody and I wonder what you think about using a link to the "Request Body Object" documentation itself instead? I see that in the "Content Object" section (https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.md#content-object) we're already doing this and that's why it came to mind.

Show outdated Hide outdated versions/3.0.md
# content transferred with base64 encoding
schema:
type: string
format: base64

This comment has been minimized.

@webron

webron Feb 2, 2017

Member

This is byte today. We can change, but needs to be updated in the other section as well.

@webron

webron Feb 2, 2017

Member

This is byte today. We can change, but needs to be updated in the other section as well.

This comment has been minimized.

@fehguy

fehguy Feb 3, 2017

Contributor

this will be a documentation concern

@fehguy

fehguy Feb 3, 2017

Contributor

this will be a documentation concern

Show outdated Hide outdated versions/3.0.md
Show outdated Hide outdated versions/3.0.md
Show outdated Hide outdated versions/3.0.md
Show outdated Hide outdated versions/3.0.md
@webron

This comment has been minimized.

Show comment
Hide comment
@webron

webron Feb 2, 2017

Member

Thanks for putting this together, @fehguy - this addresses a lot of important issues.

Following our discussions, one thing is missing and that's addressing custom serialization format with x-www-form-urlencoded. The defaults are mentioned. IIRC, these should fall under the Encoding Object.

If we choose to skip that, then the Encoding Object structure can be simplified.

Member

webron commented Feb 2, 2017

Thanks for putting this together, @fehguy - this addresses a lot of important issues.

Following our discussions, one thing is missing and that's addressing custom serialization format with x-www-form-urlencoded. The defaults are mentioned. IIRC, these should fall under the Encoding Object.

If we choose to skip that, then the Encoding Object structure can be simplified.

encoding:
historyMetadata:
# require XML content-type in utf-8 encoding
contentType: application/xml; charset=utf-8

This comment has been minimized.

@fehguy

fehguy Feb 3, 2017

Contributor

what about Content-Disposition?

@fehguy

fehguy Feb 3, 2017

Contributor

what about Content-Disposition?

This comment has been minimized.

@fehguy

fehguy Feb 3, 2017

Contributor

Waiting for @darrelmiller for feedback on this

@fehguy

fehguy Feb 3, 2017

Contributor

Waiting for @darrelmiller for feedback on this

This comment has been minimized.

@fehguy

fehguy Feb 3, 2017

Contributor

Let's add style here, great idea @webron ?

@fehguy

fehguy Feb 3, 2017

Contributor

Let's add style here, great idea @webron ?

fehguy added some commits Feb 3, 2017

Show outdated Hide outdated versions/3.0.md
@webron

This comment has been minimized.

Show comment
Hide comment
@webron

webron Feb 3, 2017

Member

LGTM (though Content-Type should be contentType).

Member

webron commented Feb 3, 2017

LGTM (though Content-Type should be contentType).

@darrelmiller

This comment has been minimized.

Show comment
Hide comment
@darrelmiller

darrelmiller Feb 4, 2017

Member

LGTM (though see comment about content-type, Ron might be wrong!)

Member

darrelmiller commented Feb 4, 2017

LGTM (though see comment about content-type, Ron might be wrong!)

@fehguy

This comment has been minimized.

Show comment
Hide comment
@fehguy

fehguy Feb 7, 2017

Contributor

@OAI/tdc shall we merge? (cha cha cha)

Contributor

fehguy commented Feb 7, 2017

@OAI/tdc shall we merge? (cha cha cha)

@whitlockjc

This comment has been minimized.

Show comment
Hide comment
@whitlockjc

whitlockjc Feb 7, 2017

Member

LGTM

Member

whitlockjc commented Feb 7, 2017

LGTM

@darrelmiller

This comment has been minimized.

Show comment
Hide comment
@darrelmiller
Member

darrelmiller commented Feb 7, 2017

:shipit:

@fehguy fehguy merged commit 17a389a into OpenAPI.next Feb 7, 2017

2 checks passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
continuous-integration/travis-ci/push The Travis CI build passed
Details

@fehguy fehguy deleted the issue-565 branch Feb 7, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment