Discussions

Ask a Question
ANSWERED

Support pages directly from OpenAPI spec

Many APIs use `info.description` field to describe the API context (such as introduction and getting started), but currently according to the [OpenAPI Compatibility Chart](🔗) it currently does nothing. It will be very nice if pages could be created automatically using this field. Is there a way to do that without having to write those pages manually?

Production not show parameters and response which is available in staging

Hi, I have staging and production API document, later I changed URL of the API and publish to git hub, staging got synced with new URL and parameter and response, but production show only URL changes but parameter and response is not available now.
ANSWERED

What is the best practice for using Changelog for releases?

There seems to be no way to categorize changes. Categories could include functional areas or types of changes. Tags would be another great way to include ways for people to search specific areas of interest.
ANSWERED

Move body params to the top menu

Can we move `BODY PARAMS` to the top menu? [Detail](https://ibb.co/PrqhRz1)

How to use dynamic UUID in Readme?

Is there any feature to create a dynamic UUID for each request in API References? We can generate UUID in Postman using `{{$timestamp}}` ``` "object": { "id": "id-{{$timestamp}}", }, ```
ANSWERED

Is there any way to scroll a table?

In the editor, tables scroll. But they don't in the live Web page. Can I change this?

Authentication

How can I authenticate my username and password?

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

On the changelog page, is it possible to change the amount of content that shows?

How do I control how much is shown on the changelog summary page? Seems to awkwardly cut stuff off.
ANSWERED

Show Image preview in Try It! response

We have an API endpoint that is documented in OpenAPI as returning an image: ```Text Example "responses": { "200": { "description": "Return an image.", "content": { "image/png": {} } } } ``` The response header is set to `content-type:image/png` but we see garbled binary data in the Response preview underneath the "Try It!" button. Is it possible to configure the Response preview so that the actual image will be shown?