Skip to content

Commit

Permalink
fix: internal link
Browse files Browse the repository at this point in the history
  • Loading branch information
jannyHou committed Mar 27, 2018
1 parent 5d02235 commit 24b9188
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions docs/site/Decorators.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,8 @@ For more usage, refer to
- type: A [common name of OpenAPI primitive data type](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#data-types).
- name: Name of the parameter. It should be a `string`.

For example, to specify data from a query, a list of available shortcuts can be found in [API document](http://apidocs.loopback.io/@loopback%2fopenapi-v3/#param.query).
A list of available shortcuts for `query` can be found in [API document](http://apidocs.loopback.io/@loopback%2fopenapi-v3/#param.query),
along with the shortcuts for `path` and `header`.

An equivalent example using the shortcut decorator would be:

Expand All @@ -195,7 +196,7 @@ For more usage, refer to
}
```

You can find specific use cases in [Writing Controller methods](controllers.md#writing-controller-methods)
You can find specific use cases in [Writing Controller methods](Controllers.md#writing-controller-methods)

*The parameter location cookie is not supported yet, see*
*https://github.com/strongloop/loopback-next/issues/997*
Expand Down Expand Up @@ -241,7 +242,7 @@ For more usage, refer to
*To learn more about decorating models and the corresponding OpenAPI schema, please check
[model decorators](#model-decorators).*

This allows type information of the model to be visible to the spec generator and '@requestBody' can finally be used on the parameter:
This allows type information of the model to be visible to the spec generator so that `@requestBody` can be used on the parameter:

```ts
import {User} from '../models/user'
Expand Down Expand Up @@ -286,7 +287,7 @@ For more usage, refer to
@param.path.string('id') id: string,
@requestBody({
content: {
// leave the schema as empty object, the decorator will generate it.
// leave the schema as empty object, the decorator will generate it for both.
'application/text': {},
'application/xml': {},
}
Expand Down

0 comments on commit 24b9188

Please sign in to comment.