Discussions

A user made a suggested edit to a guide document that included a change to the doc title. The content of the suggestion was good, but they used headline case, which is not our style. When I went into "suggest additional edits", I did not see a way to edit their suggested title change. My solution was to accept their suggested edit and then make my own edit to fix the case of the title. But I wondered if I missed something.

I am unclear on how search results work if there are multiple versions in a project. From an enterprise standpoint, you can search from any project and it searches across multiple projects, some with multiple public versions. If search term is found in more than one version of the same project, what are the expected results? For example, we have v1, v2, and v3. v2 is the main (default) version. How do Search results behave in the following scenarios? - Search term is found only in v1. - Search term found in v1, v2, and v3.

A verification question: This topic leads me to understand that versioning is handled manually <https://docs.readme.com/docs/versions> meaning that version information is not extracted from the swagger document.

Is there a way to automatically pull in the parameter constraints to the parameter description? Currently, a user would need to click in each input box to see what the value constraints are.

Can i see the new editor

When you are writing the descriptive guides, it would be nice to be able to embed an interactive API call in the guide that can be tracked.

I have an API Reference that is imported via a swagger.json file using OpenAPI 3.0.1. I see that the full securityScheme object type is not supported: <https://docs.readme.com/docs/openapi-compatibility-chart#security-scheme-object> The documentation says to just use the JWT flow, which I have working in general, but I can not figure out how to get the apiKey I send through in the JWT token to generate as part of the api reference "try it" section like in this example: <https://docs.readme.com/docs/passing-data-to-jwt#oauth-and-api-key-authentication> Here is an example of one of my tokens. I would expect that if my api was setup properly, this apiKey would show up in the section where you can run the example requests, but it does not. ``` <https://jwt.ms/#id_token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiVGVzdCBOYW1lIiwiZW1haWwiOiJub3JlcGx5QG5vcmVwbHkuY29tIiwiYXBpS2V5IjoidGVzdGluZzEyMyIsImlhdCI6MTY1MDk4NDQxNH0.GnoCOgEZp8vxrGy9XP407ugup0n8kq8i6f10Nl85Nas> ``` I'm missing something here, and I'm hoping someone can shed some light for me. Thanks!

What is the suggested workflow in Readme for SMEs to review and comment on both published and unpublished content?

In this doc: <https://docs.readme.com/docs/additional-api-settings#section-add-your-endpoints-and-parameters> It says there is a naming limitation: **Please note that due to some current limitations in our API explorer, we currently do not support the creation of multiple API endpoint pages for the same HTTP method and path.** Is there a way around this? How do other clients typically handle this using readme.io? In our use case, we are using the same HTTP Method and Path however the body request is different.

We require an **email address** and **API token** to authenticate against and use our API. With ReadMe's "Try It" functionality, users are prompted to enter a **username** and **password** to try out our API from within ReadMe. Is there a way for us to change this text so users are not confused? [block:image] { "images": [ { "image": [ null, null ] } ] } [/block]