Discussions

Ask a Question
ANSWERED

How do I enable anonymous access to my help pages?

I am planning to login some customers for advanced features (API-related), but I don't want people to have to log in at all just to see the guides.
ANSWERED

Viewing API Call metrics by API key not working?

In the metrics view, I see an option to view API calls by users, either by entering their email or their API Key. When I entered the API key I see a user sending, nothing shows up in the API calls graph, though I can see that they're using that key in the request headers. Is this a bug on readme's system or is there something I'm doing wrong? It would be very helpful to view calls by API Key given that many of our users arent logged in with email addresses.
ANSWERED

Search results appearing for content no longer in a project

Hello! We recently migrated a project into 2 projects. Our mobile SDKs and our Web SDKs were all in a project We moved the SDKs to a new project and left the web documentation in the old project However, when I use the [search feature](https://docs.readme.com/docs/search) on the original project where we now keep our web API documentation, content is displayed in the results that have moved to the new SDK project. The original content URL is being returned as the search result, and the user then sees a 404 error since the content is no longer in that project. Is there a period of time search caches results? It's been several weeks since the project migration. Is there a way to remove these results from showing?
ANSWERED

readme CLI without publishing

I am trying to run command line to update the existing api definition with a modified one. rdme openapi [path to yaml] --key=rdme_xyz --id=abcd Now I would like to find out 2 things 1. Can I push this new yaml in a dryrun/unpublished mode? so that I can verify it on readme devportal as an admin. 2. Or Can I upload this as a new api definition instead and make it in unpublished mode?

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

Custom Global landing page, User object

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?

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?