You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -571,7 +571,7 @@ Specify the `type` property when decorating response headers to prevent schema m
571
571
572
572
<a name="route.response.empty_body"></a>
573
573
##### Different content types responses
574
-
> 🛈 Note: Supported [only by OpenAPI v3](https://swagger.io/docs/specification/describing-responses/), not Swagger (OpenAPI v2).
574
+
> ℹ️ Note: Supported [only by OpenAPI v3](https://swagger.io/docs/specification/describing-responses/), not Swagger (OpenAPI v2).
575
575
576
576
Different content types are supported by `@fastify/swagger` and `@fastify`.
577
577
Use `content` for the response to prevent Fastify from failing to compile the schema:
@@ -622,7 +622,7 @@ Specify `type: 'null'` for the response to prevent Fastify from failing to compi
622
622
<a name="route.openapi"></a>
623
623
#### OpenAPI Parameter Options
624
624
625
-
> 🛈 Note: OpenAPI's terminology differs from Fastify's. OpenAPI uses "parameter" to refer to parts of a request that in [Fastify's validation documentation](https://fastify.dev/docs/latest/Reference/Validation-and-Serialization/) are called "querystring", "params", and "headers".
625
+
> ℹ️ Note: OpenAPI's terminology differs from Fastify's. OpenAPI uses "parameter" to refer to parts of a request that in [Fastify's validation documentation](https://fastify.dev/docs/latest/Reference/Validation-and-Serialization/) are called "querystring", "params", and "headers".
626
626
627
627
OpenAPI extends the [JSON schema specification](https://json-schema.org/specification.html) with options like `collectionFormat` for encoding array parameters.
628
628
@@ -686,13 +686,13 @@ There is a complete runnable example [here](examples/collection-format.js).
686
686
<a name="route.complex-serialization"></a>
687
687
#### Complex serialization in query and cookie, eg. JSON
688
688
689
-
> 🛈 Note: Supported [only by OpenAPI v3](https://swagger.io/docs/specification/describing-parameters/#schema-vs-content), not Swagger (OpenAPI v2).
689
+
> ℹ️ Note: Supported [only by OpenAPI v3](https://swagger.io/docs/specification/describing-parameters/#schema-vs-content), not Swagger (OpenAPI v2).
> 🛈 Note: Change Fastify's default query string parser to produce a JavaScript object conforming to the schema. See [example](examples/json-in-querystring.js).
695
+
> ℹ️ Note: Change Fastify's default query string parser to produce a JavaScript object conforming to the schema. See [example](examples/json-in-querystring.js).
696
696
697
697
```js
698
698
fastify.route({
@@ -901,7 +901,7 @@ Generates this in the OpenAPI v3 schema's `paths`:
901
901
<a name="route.links"></a>
902
902
#### Links
903
903
904
-
> 🛈 Note: Supported [only by OpenAPI v3](https://swagger.io/docs/specification/links), not Swagger (OpenAPI v2).
904
+
> ℹ️ Note: Supported [only by OpenAPI v3](https://swagger.io/docs/specification/links), not Swagger (OpenAPI v2).
905
905
906
906
Add OpenAPI v3 Links by adding a `links` property to the top-level options of a route. See:
0 commit comments