From 40c40cd3276f589155a806c59e778a79eea0971a Mon Sep 17 00:00:00 2001 From: Roman Hotsiy Date: Wed, 31 Aug 2016 22:45:34 +0300 Subject: [PATCH] Add x-nullable to the docs --- README.md | 1 + docs/redoc-vendor-extensions.md | 10 ++++++++++ 2 files changed, 11 insertions(+) diff --git a/README.md b/README.md index 1002eeb2..f378ba91 100644 --- a/README.md +++ b/README.md @@ -99,6 +99,7 @@ ReDoc makes use of the following [vendor extensions](http://swagger.io/specifica * [`x-logo`](docs/redoc-vendor-extensions.md#x-logo) - is used to specify API logo * [`x-traitTag`](docs/redoc-vendor-extensions.md#x-traitTag) - useful for handling out common things like Pagination, Rate-Limits, etc * [`x-code-samples`](docs/redoc-vendor-extensions.md#x-code-samples) - specify operation code samples +* [`x-nullable`](docs/redoc-vendor-extensions.md#nullable) - mark schema param as a nullable ### `` tag attributes * `spec-url` - relative or absolute url to your spec file; diff --git a/docs/redoc-vendor-extensions.md b/docs/redoc-vendor-extensions.md index 9f9ea251..e12ef1e5 100644 --- a/docs/redoc-vendor-extensions.md +++ b/docs/redoc-vendor-extensions.md @@ -106,3 +106,13 @@ yaml lang: JavaScript source: console.log('Hello World'); ``` + +### Schema Object vendor extensions +Extends OpenAPI [Schema Object](http://swagger.io/specification/#schemaObject) +#### x-code-samples +| Field Name | Type | Description | +| :------------- | :------: | :---------- | +| x-nullable | boolean | marks schema as a nullable | + +###### Usage in ReDoc +Schemas marked as `x-nullable` are marked in ReDoc with the label Nullable