From ff492b5eb23098b9aca4532b9cd5e56f1c41ed04 Mon Sep 17 00:00:00 2001 From: redocly-bot Date: Thu, 28 Sep 2023 11:43:40 +0000 Subject: [PATCH] sync: Synced local 'docs/' with remote 'docs/redoc/' --- docs/config.md | 26 +++++++++++++------------- docs/deployment/html.md | 2 +- docs/index.md | 6 +++--- 3 files changed, 17 insertions(+), 17 deletions(-) diff --git a/docs/config.md b/docs/config.md index 411f91d6..36880135 100644 --- a/docs/config.md +++ b/docs/config.md @@ -249,18 +249,18 @@ For more information, refer to [Security definitions injection](./security-defin ### OpenAPI specification extensions Redoc uses the following [specification extensions](https://redocly.com/docs/api-reference-docs/spec-extensions/): -* [`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-codeSamples`](docs/redoc-vendor-extensions.md#x-codeSamples) - specify operation code samples -* [`x-examples`](docs/redoc-vendor-extensions.md#x-examples) - specify JSON example for requests -* [`x-nullable`](docs/redoc-vendor-extensions.md#x-nullable) - mark schema param as a nullable -* [`x-displayName`](docs/redoc-vendor-extensions.md#x-displayname) - specify human-friendly names for the menu categories -* [`x-tagGroups`](docs/redoc-vendor-extensions.md#x-tagGroups) - group tags by categories in the side menu -* [`x-servers`](docs/redoc-vendor-extensions.md#x-servers) - ability to specify different servers for API (backported from OpenAPI 3.0) -* [`x-ignoredHeaderParameters`](docs/redoc-vendor-extensions.md#x-ignoredHeaderParameters) - ability to specify header parameter names to ignore -* [`x-additionalPropertiesName`](docs/redoc-vendor-extensions.md#x-additionalPropertiesName) - ability to supply a descriptive name for the additional property keys -* [`x-summary`](docs/redoc-vendor-extensions.md#x-summary) - For Response object, use as the response button text, with description rendered under the button -* [`x-extendedDiscriminator`](docs/redoc-vendor-extensions.md#x-extendedDiscriminator) - In Schemas, uses this to solve name-clash issues with the standard discriminator -* [`x-explicitMappingOnly`](docs/redoc-vendor-extensions.md#x-explicitMappingOnly) - In Schemas, display a more descriptive property name in objects with additionalProperties when viewing the property list with an object +* [`x-logo`](./redoc-vendor-extensions.md#x-logo) - is used to specify API logo +* [`x-traitTag`](./redoc-vendor-extensions.md#x-traittag) - useful for handling out common things like Pagination, Rate-Limits, etc +* [`x-codeSamples`](./redoc-vendor-extensions.md#x-codesamples) - specify operation code samples +* [`x-examples`](./redoc-vendor-extensions.md#x-examples) - specify JSON example for requests +* [`x-nullable`](./redoc-vendor-extensions.md#x-nullable) - mark schema param as a nullable +* [`x-displayName`](./redoc-vendor-extensions.md#x-displayname) - specify human-friendly names for the menu categories +* [`x-tagGroups`](./redoc-vendor-extensions.md#x-taggroups) - group tags by categories in the side menu +* [`x-servers`](./redoc-vendor-extensions.md#x-servers) - ability to specify different servers for API (backported from OpenAPI 3.0) +* [`x-ignoredHeaderParameters`](./redoc-vendor-extensions.md#x-ignoredheaderparameters) - ability to specify header parameter names to ignore +* [`x-additionalPropertiesName`](./redoc-vendor-extensions.md#x-additionalpropertiesname) - ability to supply a descriptive name for the additional property keys +* [`x-summary`](./redoc-vendor-extensions.md#x-summary) - For Response object, use as the response button text, with description rendered under the button +* [`x-extendedDiscriminator`](./redoc-vendor-extensions.md#x-extendeddiscriminator) - In Schemas, uses this to solve name-clash issues with the standard discriminator +* [`x-explicitMappingOnly`](./redoc-vendor-extensions.md#x-explicitmappingonly) - In Schemas, display a more descriptive property name in objects with additionalProperties when viewing the property list with an object diff --git a/docs/deployment/html.md b/docs/deployment/html.md index 65c18693..1ac770ed 100644 --- a/docs/deployment/html.md +++ b/docs/deployment/html.md @@ -38,7 +38,7 @@ description. ``` -:::Success URL or local file +:::success URL or local file Set `spec-url` to a relative path if the file is local, e.g. `spec-url=my-api.yaml`. Use a full URL like the example above if it's hosted elsewhere. diff --git a/docs/index.md b/docs/index.md index 768c3ad2..ebcdd9de 100644 --- a/docs/index.md +++ b/docs/index.md @@ -50,13 +50,13 @@ Add your own `spec-url` to the `` tag; this attribute can also be a local ### More usage options -Check out the [deployment documentation](./deploment/index/md) for more options, and detailed documentation for each. +Check out the [deployment documentation](./deployment/intro.md) for more options, and detailed documentation for each. ## Configure Redoc Redoc is highly configurable. Each deployment option accepts configuration in a way that's appropriate to that platform, but the options are the same for each. For example: -* Using [Redocly CLI](../cli/index.md), configuration goes in the `redocly.yaml` file, or can be supplied as command line parameters, such as `--theme.openapi.disableSearch`. +* Using [Redocly CLI](../cli/index.mdx), configuration goes in the `redocly.yaml` file, or can be supplied as command line parameters, such as `--theme.openapi.disableSearch`. * Using HTML or React, configure by setting `option` in the tag. Here's a sample `redocly.yaml` configuration file, showing a few common settings and tweaking some of the visual theme settings: @@ -91,6 +91,6 @@ There are many, many more options available. Visit the [configuration reference] ## Next steps -* If you are new to OpenAPI, try the [OpenAPI starter project](../../cli/openapi-starter/) for a great introduction. +* If you are new to OpenAPI, try the [OpenAPI starter project](../cli/openapi-starter.md) for a great introduction. * Ready to build documentation from an existing OpenAPI file? Go to the [Redoc quickstart](./quickstart.md) and get started. * Learn more about the project by visiting [Redoc on GitHub](https://github.com/Redocly/redoc).