Discussions
Is there a way to embed your OpenAPI calls in the Guides
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.
Posted by Zach almost 2 years ago
OAuth2 bearer token with apiKey in JWT token??
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!
Posted by Domenic Datti almost 2 years ago
reviewing documents
What is the suggested workflow in Readme for SMEs to review and comment on both published and unpublished content?
Posted by Don Glover almost 2 years ago
Is there a way to create multiple API endpoints with the same HTTP method and path?
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.
Posted by [email protected] about 2 years ago
Can you change the "password" help text in "Try It" to something else?
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]
Posted by Joe Duffy about 2 years ago
Is there any mermaid.js support
Looking to render things like sequence diagrams, state diagrams etc.
Posted by Peng Ying about 2 years ago
Bulleted lists in a table cell
Hello, when I place a bulleted list in a table cell, it saves as a random display of italic sentences and \*. Is this a bug?
Posted by [email protected] about 2 years ago
Updating Ref Markdown via API
Hi there, is it possible to update the body content of an API Ref page via API call? I see that custom pages and docs can be updated, but it would be convenient to update ref markdown as well!
Posted by Jake Strang about 2 years ago
Suggested edit button is not displayed in any of the pages.
We used to have suggested edit button on every page but I just noticed it's gone. I checked the configuration but the feature is still enabled so I don't know why it's gone. Please advise how to fix the issue.
<https://developers.tripla.ai/reference/introduction>
Posted by Kaku about 2 years ago
Platform Security
What level of security does readme.io have in place? Or, anything related to security of the platform?
Posted by Bryan about 2 years ago