Discussions
How to add "description" to response body parameters in the example code.
While adding the API endpoint in the API reference I am not able to find the option to add the API response body parameter description.
Posted by Shreyas Sridhar 6 months ago
Password protect just one page
Hello! Is it possible to password protect just one page of our documentation?
Posted by Emily Zhao 6 months ago
Discriminator doesn't seem to be recognized
Hello, we have the following section in our openapi definition file:
```
...
requestBody:
required: true
content:
application/json:
schema:
oneOf:
- $ref: "./components/auth.yml#/schemas/UserCredentialRequest"
- $ref: "./components/auth.yml#/schemas/RefreshTokenRequest"
- $ref: "./components/auth.yml#/schemas/AuthorizationCodeRequest"
discriminator:
propertyName: grant_type
mapping:
password: "./components/auth.yml#/schemas/UserCredentialRequest"
refresh_token: "./components/auth.yml#/schemas/RefreshTokenRequest"
authorization_code: "./components/auth.yml#/schemas/AuthorizationCodeRequest"
...
```
Somehow, the request body is not rendered in the UI, this is what we see:
<https://pasteboard.co/toDL5B2pvcA0.png>
Is it a bug or are we doing something wrong? The same exact openapi definition works with \[redocly](<https://redocly.com/>) without any changes.
Posted by null 6 months ago
How to remove auto generated examples
Hi, we are using an OpenAPI schema to create our API reference on Readme. We find that the auto generated language examples often confuse our users or put them on the wrong track (we'd prefer developers use our own SDK).
Is there a way to completely disable the auto generated examples when using an imported OAS, or at least limit the languages that are displayed? Alternately, is it possible to provide our own examples instead?
Posted by David Browne 6 months ago
Left menu items - ordering
What is the logic used to order the openapi tags in the rendered page? Is there a way to influence the order of the pages in the left menu? I read this: <https://docs.readme.com/main/docs/openapi-categories-pages-subpages#tags> - but I still don't understand how is the order of the menu in the left defined.
Let's say I have the following tags in my `openapi.yaml`:
```
tags:
- name: Page1
- name: Page2
- name: Page3
```
What I want is, to have menu items in the left pane of the docs page ordered in the same order as I specified in my `openapi.yaml` file. Currently the order is not preserved and I can't understand what algorithm is used to detect the order.
Posted by null 6 months ago
Add drop down in base URL section on right hand panel
How to add drop down for setting context in base URL section on right hand panel of developer portal
Posted by Rupika Mahajan 6 months ago
Python code example highlighting
Hello!
It looks like code highlighting on code snippets is not working for python - it works okay if I leave the code labelled as text, but everything goes grey if I mark it as python, this didn't start happening until a couple of weeks ago.
Thanks!
Posted by Bamber 6 months ago
Dynamic Variable
Hi,
We want to pass a dynamic variable for one of the Parameter in Post Request. The goal is to update/generate a UID in that parameter when users clicks on try it.
We are unable to pass the dynamic value, please guide us how to pass the dynamic value in a parameter in readme
Posted by Sai Charan 6 months ago
Getting Internal Server Error
Hello. When navigating to our project <https://riskcast.readme.io/> we are getting an internal server error. Can you help clarify why that is?
Posted by Reggie Arichabala 6 months ago
How to fill the Example / Response fields in JSON format for the following information? ENUM / String / Boolean
![](https://files.readme.io/dec3ec3-image.png)
How to Fill in the Example / Response fields in JSON format for the model, age, and gender information, following the structure below, base in the image
```Text json
{
"model": "Example", // string
"age": 30, // number
"gender": "Male" | "Female" // string Need ENUM
}
```
# EXAMPLE
?
## RESULTS
?
Posted by D. Silva 6 months ago