TerribleDev/docs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge

Browse Source
This commit is contained in:
Ross McDonald
2018-02-07 18:13:13 -06:00
parent 5eedf20432 e6053aba82
commit 8ca0bef42f
1 changed files with 24 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
articles/modeling/shared-params-responses.md
View File

@@ -23,7 +23,8 @@ endpoints without having to duplicate effort.
![](../../assets/gifs/shared-params-responses-param.gif)
Shared parameters are supported in the following request property locations:
<<<<<<< HEAD
Shared parameters can be used as the following request properties:
* __path__ - The request URL _path_
* __query__ - The request URL query string
@@ -34,6 +35,24 @@ Shared parameters are supported in the following request property locations:
<!-- theme: info -->
> For more information the above properties, see the OpenAPIv2 Specification
[here](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#parameter-object)
=======
Shared parameters can be used as the following request properties:
* __path__ - Specifies that the shared parameter can only be used in an API endpoint as a URL _path_
* __query__ - Specifies that the shared parameter can only be used in an API
endpoint as an [URL query
string](https://en.wikipedia.org/wiki/Query_string)
* __header__ - Specifies that the shared parameter can only be used in an API
endpoint as a [HTTP Header field
object](https://en.wikipedia.org/wiki/List_of_HTTP_header_fields)
* __body__ - Specifies that the shared parameter can only be used in an API
endpoint as a [HTTP message
body](https://en.wikipedia.org/wiki/HTTP_message_body)
* __form-data__ - Specifies that the shared parameter can only be used in an
API endpoint as a HTTP body in the
[`multipart/form-data`](https://developer.mozilla.org/en-US/docs/Web/API/FormData)
format
>>>>>>> e6053aba82c6683bbb136fd84a89bd5acddc6ba0
Similar to generic request parameters, restrictions on the parameter values can
also be applied based on type, expected default value, minimum/maximum length,
@@ -55,7 +74,11 @@ files, projects, and other external sources.
## Shared Responses
Shared responses provide a way to re-use response objects across multiple API
<<<<<<< HEAD
endpoints without having to duplicate effort. Similar to shared components
=======
endpoints without having to duplicate effort. Similar to the shared properties
>>>>>>> e6053aba82c6683bbb136fd84a89bd5acddc6ba0
discussed above, shared responses allow you to reference a single response
multiple times without having to recreate each response manually. The added
benefit of this approach is that updates to the shared response object are