Skip to content

Commit 8ec43a7

Browse files
docs: add contentType to openapi-generator README
1 parent 5ef252c commit 8ec43a7

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

packages/openapi-generator/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -468,6 +468,8 @@ const SampleSchema = t.type({
468468

469469
These are some tags that you can use in your schema JSDocs are custom to this generator.
470470

471+
- `@contentType` allows you to override the default `application/json` content type for
472+
requests and responses. Can be applied at route, request body, or response body level.
471473
- `@private` allows you to mark any field as in any schema as private. The final spec
472474
will have `x-internal: true` for schemas with the `@private` tag.
473475
- `@deprecated` allows to mark any field in any schema as deprecated. The final spec
@@ -477,6 +479,8 @@ These are some tags that you can use in your schema JSDocs are custom to this ge
477479
import * as t from 'io-ts';
478480

479481
const Schema = t.type({
482+
/** @contentType application/xml */
483+
xmlField: t.string,
480484
/** @private */
481485
privateField: t.string,
482486
/** @deprecated */

0 commit comments

Comments
 (0)