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
After updating OAS 2.0 to 3.0 , we are getting slug of null issue while updating readme.io through github? could you provide me the solution for this
build
Unknown error (Cannot read property 'slug' of null). <https://docs.readme.com/main/reference> and include the following link to your API log:
Posted by Desetti Chandrasekhar 12 months ago
Markdown links do not render `[example][1]\n[1]: http://example`
Standard links as supported by Github, Pandok, CommonMark and most other markdown tools don't seem to work in Readme.com, even if the documentation says \["The engine also supports all standard markdown constructs"][1]
\[1]: <https://docs.readme.com/rdmd/docs/syntax-extensions#standard-markdown>
For example from the following 3 links, none will render:
```Text Markdown
Here are 3 styles of links that do not render: [example1][1], [example2][] and [example3][].
[1]\: http://example.com
[example2]\: http://example.com
[example3]\: http://example.com "link to example.com"
```
This style of links if far superior as it doesn't clutter the text with long links. What is the syntax to keep the link text and the URL separated in Readme.com markdown syntax?
CommonMark relevant spec paragraph: <https://spec.commonmark.org/0.30/#link-reference-definition>
Posted by Kevin about 1 year ago
Add Reference API in my application
Good morning dear,
a query you might be able to embed an api reference in my app outside of Readme.
Posted by Pedro Vera over 2 years ago
Updating API specification doesn't work
I am doing a PUT request, tried both with a JSON and YAML, I'm getting a 503 error.
The tried specifications are valid.
`curl -X PUT -T "openapi/spec301.json" -u "$README_KEY:" "https://dash.readme.com/api/v1/api-specification/$SPEC_ID"`
Response:
```html html
<!DOCTYPE html>
<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta charset="utf-8">
<title>Application Error</title>
<style media="screen">
html,
body,
iframe {
margin: 0;
padding: 0;
}
html,
body {
height: 100%;
overflow: hidden;
}
iframe {
width: 100%;
height: 100%;
border: 0;
}
</style>
</head>
<body>
<iframe src="//readme.com/error"></iframe>
</body>
</html>
```
Posted by Marcin Szle almost 2 years ago
API versioning
A verification question:
This topic leads me to understand that versioning is handled manually
<https://docs.readme.com/docs/versions>
meaning that version information is not extracted from the swagger document.
Posted by Don Glover almost 2 years ago
Search box
Hello there,
Is it possible to use search box as a custom html code? I don't want to use it as a button, I want to embed it to the page and if there is a way, I'll be happy
Posted by Tosun over 2 years ago
Additional options in curl command line
Hi,
In the code sample section when using curl, I would need to use additional options in the command line.
I could not find any place to tune the curl command line used.
Is that configurable somewhere ?
Kind regards,
Posted by Fred over 1 year ago
Search results for password-protected projects
If we require end users to log into to see a project, and enable robots.txt, is content from that project returned by search outside of Readme (like google?). I'm assuming the answer is no, but would like to confirm.
Posted by Sara about 2 years ago
Are you planning to include GPT-3 capabilities to generate answers based on an existing documentation in readme?
We have an extensive product documentation on Readme and would love to learn how we can potentially use GPT-3 to generate answers for our customers and customer support agents
Posted by Chris R about 1 year ago