From e04b987f8ce22d7b4149a32643c144802bc8f821 Mon Sep 17 00:00:00 2001 From: Heather Cloward Date: Sun, 15 Aug 2021 22:37:50 -0400 Subject: [PATCH] Updates instances of specification to defintion --- docs/quickstart/html.md | 6 +++--- docs/quickstart/intro.md | 10 +++++----- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/quickstart/html.md b/docs/quickstart/html.md index e493d519..411cbce8 100644 --- a/docs/quickstart/html.md +++ b/docs/quickstart/html.md @@ -157,7 +157,7 @@ To reference the Redoc script with a node modules link: ## Step 3 - Add the element You can add the element to your HTML page and reference your OpenAPI -specification using the `spec-url` attribute, or you can initialize Redoc using +definition using the `spec-url` attribute, or you can initialize Redoc using a globally exposed Redoc object. ### Using the `spec-url` attribute @@ -187,8 +187,8 @@ To add the element with a globally exposed Redoc object: ```js Redoc.init(specOrSpecUrl, options, element, callback) ``` -- `specOrSpecUrl`: Either a JSON object with OpenAPI specification or a URL to the - specification in JSON or YAML format. +- `specOrSpecUrl`: Either a JSON object with the OpenAPI definition or a URL to the + definition in JSON or YAML format. - `options`: See [options object](https://redoc.ly/docs/api-reference-docs/configuration/) reference. - `element`: DOM element Redoc will be inserted into. - `callback`(optional): Callback to be called after Redoc has been fully rendered. diff --git a/docs/quickstart/intro.md b/docs/quickstart/intro.md index c2152ec6..1a5ded45 100644 --- a/docs/quickstart/intro.md +++ b/docs/quickstart/intro.md @@ -25,13 +25,13 @@ The different options include using the following: You will need an OpenAPI definition. For testing purposes, you can use one of the following sample OpenAPI definitions: - OpenAPI 3.0 - - [Rebilly Users OpenAPI Specification](https://raw.githubusercontent.com/Rebilly/api-definitions/master/openapi/users.yaml) - - [Swagger Petstore Sample OpenAPI Specification](https://petstore3.swagger.io/api/v3/openapi.json) + - [Rebilly Users OpenAPI Definition](https://raw.githubusercontent.com/Rebilly/api-definitions/master/openapi/users.yaml) + - [Swagger Petstore Sample OpenAPI Definition](https://petstore3.swagger.io/api/v3/openapi.json) - OpenAPI 2.0 - - [Thingful OpenAPI Specification](https://raw.githubusercontent.com/thingful/openapi-spec/master/spec/swagger.yaml) - - [Fitbit Plus OpenAPI Specification](https://raw.githubusercontent.com/TwineHealth/TwineDeveloperDocs/master/spec/swagger.yaml) + - [Thingful OpenAPI Definition](https://raw.githubusercontent.com/thingful/openapi-spec/master/spec/swagger.yaml) + - [Fitbit Plus OpenAPI Definition](https://raw.githubusercontent.com/TwineHealth/TwineDeveloperDocs/master/spec/swagger.yaml) -For more information on OpenAPI specifications, refer to the [Learning OpenAPI 3](https://redoc.ly/docs/resources/learning-openapi/) +For more information on the OpenAPI specification, refer to the [Learning OpenAPI 3](https://redoc.ly/docs/resources/learning-openapi/) section in the documentation. ## Live demo online