Discussions

Ask a Question

Custom login: How should the logout feature be implemented?

We've implemented the custom login page (<https://docs.readme.com/docs/custom-login-page>) with JWT, everything works as expected, but the logout button shown in Readme.io does nothing. In the settings, we set the page users should be forwarded to, users are forwarded, but after opening Readme.io the session is still valid.

Nav item for Link URL not working?

I've tried editing both the right nav and left nav in Site Navigation, but my Link URL is only showing on the deprecated version page and not the main version page.

How can we render a multipart request correctly?

Today we have the following request: ```curl curl --request POST \ --url http://{host} \ --header 'Content-Type: multipart/form-data' \ --header 'Authorization: Bearer <TOKEN>' \ --form ' service={ "id": "svc12345", "sourceType": "my-alerting-solution", "sourceInstance": "my-company", "name": "my-service", "description": "The one and only service with 110% uptime", "data": { "number_of_incidents": "2", "monitoring_dashboard": "https://my-company.my-alerting-solution.com/my-service" } };type=application/json' --form 'bom=@<file>' ``` But when we see it on Readme it's rendered like this: ![](https://files.readme.io/50eb4c7-Screenshot_2022-10-14_at_12.22.50.png) Is there a way to render it like this and not as a form: ![](https://files.readme.io/0efe8e6-Screenshot_2022-10-14_at_12.25.19.png) Thanks

Refreshing/side nav is too laborious

Every time I edit something that affects the side nav, I have to refresh and when I do that I am returned to the top of the side nav and often have to spend some time hunting for where I left off in that nav. Sometimes, I get interrupted at that moment and totally lose my place and forget what I was doing so this is risky to my authoring process. Two things that would reduce the time and effort here: 1) Refresh the site whenever I save edits to a page that affects the side nav (a prompt to do that would be fine), and 2) Hold my place in that nav when refreshing.

Why does the API URL title on the sidebar of my API documentation keep changing?

I keep changing the title from API URL to API Documentation because I wanted to change the way it looked and it keeps returning back to API URL. I change the text, it saves it automatically and then I check on the preview of my documentation site, but when I come back the next day, it is back to API URL. I am the only person writing API documentation and none of the other two on my account have changed anything. What's going on? Am I not supposed to change that text?

Manually added "What's next" pages do not get title updates.

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?

Documentation Offline due to Infinite Redirect

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?

API Endpoint Request and Response Parameters are no longer showing all of a sudden

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?

API Validation - should match against

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?