Discussions
503/520 errors when attempting to upload openapi schema - "your upload request timed out"
We are attempting to upload schema -- it had worked earlier but is now giving errors. Cannot tell if this is user error, or server errors
Have attempted using curl as well as `rdme` cli tool
```Text rdme cli tool
(3.10.5) [huvr] npx --yes rdme openapi $SWAGGER_SCHEMA_FILE --key=$README_API_KEY --id=$README_API_DEFINITION_ID
β Validating API definition located at xx_path_xx/schema.yaml... done! β
β Staging your API definition for upload... done! π
β Updating your API docs in ReadMe...
We're sorry, your upload request timed out. Please try again or split your file up into smaller chunks.
```
```Text curl
$ curl \
"--request" "PUT" \
"--url" "https://dash.readme.com/api/v1/api-specification/${README_API_DEFINITION_ID}" \
"--user" "${README_API_KEY}:" \
"--header" "Accept: application/json"\
"--header" "Content-Type: multipart/form-data"\
"--form" "spec=@${SWAGGER_SCHEMA_FILE}" \
HTTP/2 520
```
Attempted creating a new file,
```
$ npx --yes rdme openapi $SWAGGER_SCHEMA_FILE --key=$README_API_KEY
β Would you like to use an existing project version or create a new one? Β· update
β Select your desired version Β· 3
β Validating API definition located at xx_path_xx/schema.yaml... done! β
β Staging your API definition for upload... done! π
β Would you like to update an existing OAS file or create a new one? Β· create
β Creating your API docs in ReadMe...
We're sorry, your upload request timed out. Please try again or split your file up into smaller chunks.
```
this^ DOES appear to work, even though it gave an error message
```
curl \
"--request" "GET" \
"--url" "https://dash.readme.com/api/v1/api-specification/" \
"--user" "${README_API_KEY}:" \
"--header" "Accept: application/json"
[{ "source":"cli", ... }] <--- has newly created spec
```
file is ~400K:
```
$ ls -hl $SWAGGER_SCHEMA_FILE
-rw-r--r-- 1 xx_user_xx staff 421K Aug 23 16:18 xx_path_xx/schema.yaml
```
- any guidance on "split your file up into smaller chunks"?
- is there a "status" page for readme.com?
Posted by David Wolgemuth over 1 year ago
Multiple API Definitions
Hi,
I have a readme project where I would like to upload multiple api definitions
OAS_v1.yaml
OAS_v2.yaml
Now I want to show OAS_v2.yaml for those who are logged in, but not to public. Is there a way to customize the UI experience of API references section?
Posted by Naveen Velicheti over 1 year ago
Making a redirect take effect?
What more needs to be done to make a redirect take effect, beyond deploying the updated group redirect list? (I am using the Enterprise version, so we have a group.) I ask because the "source" page is still loaded if I use the original URL, even in an incognito/private window, which shouldn't have anything cached. Do I need to delete the original page?
Posted by Janet Swisher over 1 year ago
Chrome left side navigation missing
Recently, when using Chrome, the left had side navigation is missing all the information that was there. the left side slide out but is blank.
Any hints on to debug this or get the links back?
Posted by Kevin Mueller over 1 year ago
Internal Documentation protection
I have used custom login to authenticate our end users from global landing page. Now I also have enabled protection for internal documentation with protection type as project members only.
I want my end users post login to get redirected to internal documents/pages had they bookmarked those. However despite my IDP sends in this way <https://domain.readme.io/internalpage?auth_token=JWT>
readme is still making user to relogin again. So my questions are as below.
1. if ProtectionType is project members only, are those pages visible only for teammates but not the end users?
2. if I change protection type to custom login, what custom login uri should I give? as I might have multiple internal pages to get redirected.
Posted by Naveen Velicheti over 1 year ago
How to add NodeJS code examples
Trying to add NodeJS code examples, and there are no option. So had to select JS as type. But in that way, I'm not being able to write any instruction on how to install the package. Same for Python, Java and other languages. There should be way to explicitly say, how the dev is going to include/install the package into their system.
Please let me know, if there is any way to do this, that I might have missed or any wayaround.
Thanks in advance, even if there is no way to do so, please do let me know any ideas on how to solve this issue with existing system.
Posted by Zahid Hasan Pranto over 1 year ago
Auto generated code examples along with given examples code in suggestion
If any code example is added then the auto generated codes are grouped under the three dots (more option).
So if I want to keep both auto generated and the my own custom code examples in the plain sight and not buried under the three dots then what should be done, if there is any way.
Thanks in advance.
Posted by Zahid Hasan Pranto over 1 year ago
Link to Pages
On beta version it's not working as decribed at the regular version.
When adding brackets (\[]) it's not offering pages.
Is there a different way on the beta version?
Posted by Readme for Jifiti over 1 year ago
Changlog Content is not rendering.
<https://docs.os1.delhivery.com/changelog>
for some reason the content has stopped rendering.
Any idea why?
Posted by Don over 1 year ago
3rd Sub page
How do I add a 3rd sub page?
Posted by The Deer over 1 year ago