Discussions

Typically, if when editing a document through the dashboard, I do not modify the "What's next" field at the very bottom, then when viewing the article, I will have two links: one to the previous page, and one to the next page. These links are described with the current titles of the pages they link to. That's great. However, if I manually add a page, e.g. I am editing page A, which has subpage A.1, but I want to link to page B in the same category, then I encounter difficulties when I change the title of page B. Then, if I change page B to be titled C, the "What's next" section in page A contains a link called "B" pointing to page C. Could the titles of these links be kept up to date with the titles of the pages?

I am trying to build a custom landing page where I would like to show a set of projects before login and then show another set of projects post login. I was hoping I can access allowedProjects from the User object, but thats not accessible. All I can get is {{user.name}} and no other user fields are visible on custom global landing page. Can you please help me understand why? is there some other setting I need to do?

When I visit the home page of my docs I get a "too many redirects" error. It seems to be trying to reach `/reference` but gets stuck in an infinite loop. We are using a custom domain but that was set up years ago and has been working fine until this week. In the Readme settings it says that the DNS is still set up correctly. I presume something has changed on the Readme side which has caused an infinite redirection loop? How do we get back online?

I just noticed today that all of a sudden, request and response parameters are no longer showing up in the API endpoint documentation pages. There were no recent changes to our OAS file. Previously, all of our endpoints rendered request and response parameters on the readme.com generated site, so this is a recent breakage. I checked that uploading our OAS file to another OpenAPI documentation generator (swagger.io) correctly renders the API endpoint request and response parameters. I also manually double checked the OAS file to see that the request and response parameters were correctly documented according to OpenAPI specification (we are using open api 3.1.0). I double checked all of the settings page on readme.com to ensure we didn't disable some kind of setting. What am I missing?

I got the following error validating my API: ``` Validation failed. /components/schemas/WebhookPayload<WebhookQuoteCarriersQualified> has an invalid name. Component names should match against: /^[a-zA-Z0-9.-_]+$/ ``` The thing is, it does match. I tried this on regex101.com and it matches for every "flavor" that they offer: PCRE, PCRE2, ECMAScript, Python, Golang, Java 8, and .NET. My best guess is that it doesn't like the \<> characters, but again, the regex produces a match. What's going on here?

Hi, I am trying to build my own global landing page and hence I want to understand parentProject and childProject structure. Can you please share a link where the Keys of the above objects and its structure is documented?

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,

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?