Discussions

Ask a Question

Need help on accessing Bearer token with out API_KEY from JWT.

Hi I am working on Read me integration with a custom login hook. My requirement is to redirect from the readme portal to our custom login page and once the login is completed. I will load ReadMe with authentication. We have Login API which contains tokens to access. When I went through the reference. It was expecting some API KEY in JWT Token. But my requirement is client will provide me Access token in the api response and they are expecting to redirect with that access token and paste it in header. Is there any way to accomplish this requirement?
ANSWERED

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.
ANSWERED

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?
ANSWERED

Is it possible to show a page without navigation panel, header and footer?

I need to pull the pages (html) into an external product (load in IFRAME) and would like to get the page only without the navigation panel, header and footer...is it possible? I assume some sort of url paramter that turns these off ... Thx, David
ANSWERED

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
ANSWERED
ANSWERED

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>
ANSWERED

Can someone show me a sample of how they are using the ChangeLog feature?

Hi all, Can someone explain the Changelog feature to me more in-depth? Meaning, how to explain to our users how to follow our feed? I think that is what it is supposed to do? Example: I'm putting the custom HTML/CSS widget at the top of each of our Changelogs with the changelog.js script in it and then I'm using them as "Release Notes" basically for each of our releases. This way, I get something like a mini TOC that builds when the ChangeLog feature is clicked on. ![Capture.PNG](https://files.readme.io/f01939f-Capture.PNG) However, the part that I'm missing is how do customer's "subscribe" to this? Is that how it is used?

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> ```
ANSWERED

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