Redocly/redoc
1
1
Fork 0
mirror of https://github.com/Redocly/redoc.git synced 2025-08-06 05:10:20 +03:00
Code Issues Packages Projects Releases Wiki Activity

Updates instances of specification to defintion

Browse Source
This commit is contained in:
Heather Cloward 2021-08-15 22:37:50 -04:00
parent 3e6a3b2eb4
commit e04b987f8c
2 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/quickstart/html.md
View File

@ -157,7 +157,7 @@ To reference the Redoc script with a node modules link:
## Step 3 - Add the <redoc> element ## Step 3 - Add the <redoc> element
You can add the <redoc> element to your HTML page and reference your OpenAPI You can add the <redoc> 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. a globally exposed Redoc object.
### Using the `spec-url` attribute ### Using the `spec-url` attribute
@ -187,8 +187,8 @@ To add the <redoc> element with a globally exposed Redoc object:
```js ```js
Redoc.init(specOrSpecUrl, options, element, callback) Redoc.init(specOrSpecUrl, options, element, callback)
``` ```
- `specOrSpecUrl`: Either a JSON object with OpenAPI specification or a URL to the - `specOrSpecUrl`: Either a JSON object with the OpenAPI definition or a URL to the
specification in JSON or YAML format. definition in JSON or YAML format.
- `options`: See [options object](https://redoc.ly/docs/api-reference-docs/configuration/) reference. - `options`: See [options object](https://redoc.ly/docs/api-reference-docs/configuration/) reference.
- `element`: DOM element Redoc will be inserted into. - `element`: DOM element Redoc will be inserted into.
- `callback`(optional): Callback to be called after Redoc has been fully rendered. - `callback`(optional): Callback to be called after Redoc has been fully rendered.

10
docs/quickstart/intro.md
View File

@ -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: You will need an OpenAPI definition. For testing purposes, you can use one of the following sample OpenAPI definitions:
- OpenAPI 3.0 - OpenAPI 3.0
- [Rebilly Users OpenAPI Specification](https://raw.githubusercontent.com/Rebilly/api-definitions/master/openapi/users.yaml) - [Rebilly Users OpenAPI Definition](https://raw.githubusercontent.com/Rebilly/api-definitions/master/openapi/users.yaml)
- [Swagger Petstore Sample OpenAPI Specification](https://petstore3.swagger.io/api/v3/openapi.json) - [Swagger Petstore Sample OpenAPI Definition](https://petstore3.swagger.io/api/v3/openapi.json)
- OpenAPI 2.0 - OpenAPI 2.0
- [Thingful OpenAPI Specification](https://raw.githubusercontent.com/thingful/openapi-spec/master/spec/swagger.yaml) - [Thingful OpenAPI Definition](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) - [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. section in the documentation.
## Live demo online ## Live demo online