mirror of
https://github.com/Redocly/redoc.git
synced 2025-08-08 06:04:56 +03:00
Made a few minor edits
This commit is contained in:
parent
713ec84244
commit
84645a6ac1
|
@ -22,7 +22,7 @@ No. Slow load times are not due to file size but to the number of endpoints and
|
||||||
|
|
||||||
In order to speed up browser load times:
|
In order to speed up browser load times:
|
||||||
|
|
||||||
1. Make sure you have updated to the latest version of ReDoc.
|
1. Update to the latest version of ReDoc.
|
||||||
2. Create separate OpenAPI definitions for each endpoint.
|
2. Create separate OpenAPI definitions for each endpoint.
|
||||||
3. Host each endpoint on a separate instance of ReDoc.
|
3. Host each endpoint on a separate instance of ReDoc.
|
||||||
|
|
||||||
|
@ -30,7 +30,7 @@ In order to speed up browser load times:
|
||||||
|
|
||||||
**How can I use ReDoc to automatically generate code samples?**
|
**How can I use ReDoc to automatically generate code samples?**
|
||||||
|
|
||||||
Unfortunately, ReDoc does not support automatically generating code samples. It can, however, render them. You can use a tool like Postman to generate the code samples. Additionally, you can store each sample in a separate file and use scripts to bundle them into the spec. Consider using [Yeoman Generator](https://github.com/Rebilly/generator-openapi-repo) for this task.
|
Unfortunately, ReDoc does not support automatically generating code samples. However, it can render them. You can use a tool like Postman to generate the code samples. Additionally, you can store each sample in a separate file and use scripts to bundle them into the spec. Consider using [Yeoman Generator](https://github.com/Rebilly/generator-openapi-repo) for this task.
|
||||||
|
|
||||||
**I am seeing strange text such as `â€"204` in place of the `No Content` response icon.**
|
**I am seeing strange text such as `â€"204` in place of the `No Content` response icon.**
|
||||||
|
|
||||||
|
@ -44,7 +44,7 @@ Please add the following to the head section of your HTML:
|
||||||
|
|
||||||
**The width and height values of the logo appear to be mixed up.**
|
**The width and height values of the logo appear to be mixed up.**
|
||||||
|
|
||||||
They aren't mixed up. It is likely that it appears this way because by default `maxHeight` is set to the value of the width of the sidebar. This can, however, be overridden.
|
They aren't mixed up. It is likely that it appears this way because by default `maxHeight` is set to the value of the width of the sidebar. However, this can be overridden.
|
||||||
|
|
||||||
**What command do I use to make the third panel visible?**
|
**What command do I use to make the third panel visible?**
|
||||||
|
|
||||||
|
@ -54,11 +54,11 @@ You can achieve this with the following `redoc-cli` command:
|
||||||
|
|
||||||
### Extensions
|
### Extensions
|
||||||
|
|
||||||
**Using the `x-servers` vendor extension, I am getting the following error:**
|
**While using the `x-servers` vendor extension, I am getting the following error:**
|
||||||
|
|
||||||
Cannot read property 'startsWith' of undefined
|
Cannot read property 'startsWith' of undefined
|
||||||
|
|
||||||
This is most likely the result of prefixing you internal fields with `x-`. If you are prefacing your internal fields with `x-` (as in `x-description` and `x-url`), you must remove remove the `x-` prefixes (making the fields `description` and `url`, instead).
|
This is most likely the result of prefixing your internal fields with `x-`. If you are prefacing your internal fields with `x-` (as in `x-description` and `x-url`), you must remove the `x-` prefixes (making the fields `description` and `url`, instead).
|
||||||
|
|
||||||
**What is the purpose of the `x-extendedDiscriminator` extension?**
|
**What is the purpose of the `x-extendedDiscriminator` extension?**
|
||||||
|
|
||||||
|
@ -68,7 +68,7 @@ OpenAPI 3 introduced `mapping`. `x-extendedDiscriminator` was created to facilit
|
||||||
|
|
||||||
**Do you have any plans to include an `Add to Postman` button with ReDoc?**
|
**Do you have any plans to include an `Add to Postman` button with ReDoc?**
|
||||||
|
|
||||||
Unfortunately, this feature is outside the scope of the ReDoc project. You can, however, add the button manually in either the navbar or the Markdown description.
|
Unfortunately, this feature is outside the scope of the ReDoc project. However, you can add the button manually in either the navbar or the Markdown description.
|
||||||
|
|
||||||
**Has the ReDoc team considered adding the option to disable the side menu, thereby not rendering it to the DOM?**
|
**Has the ReDoc team considered adding the option to disable the side menu, thereby not rendering it to the DOM?**
|
||||||
|
|
||||||
|
@ -78,4 +78,4 @@ Adding this feature is currently under consideration.
|
||||||
|
|
||||||
**Do I need to have React installed in order to use ReDoc with Vue.js?**
|
**Do I need to have React installed in order to use ReDoc with Vue.js?**
|
||||||
|
|
||||||
Yes. ReDoc requires React to work. You do not, however, need to install any React components, just React and ReactDOM.
|
Yes. ReDoc requires React to work. However, you do not need to install any React components, just React and ReactDOM.
|
||||||
|
|
Loading…
Reference in New Issue
Block a user