Discussions

Hi! I was wondering if there is a supported extension or way to hide internal APIs coming from a Swagger 2.0 spec? We want them to be in the Open API spec, but dont wont it be be publicly visibile in our API documentations since it could cause confusion. Thanks!

I accidentally deleted 2 categories from api reference with content. Is there any way to recover this?

can I pre-populate the api fields from the JSON data returned by webhooks ? if yes can you provide the docs for the same. thank.

I have custom variables that are configured in personalised docs and I want to use these variables as default values( pre-poulate the fileds) in my api's.

Hi fellow API developers We just recently started to document all our API stuff on readme, and I wonder if there is a way for my clients to register as a developer on my readme portal? As I would like to have a way of reaching out to them with news, updates etc. Is this possible in readme?

I have an endpoint that consumes a `multipart/form-data` It takes a file and other properties. some of the properties are objects. Below is how Readme renders the properties ``` const sdk = require('api')('@fr0sty/v1.0#3y00k1blog8la60'); sdk.uploadKnowledgeDocument({ newKey: 'New Value', appVisibility: 'visible', name: 'Product Release Monthly Webinar - May 2023', file: 'starbucks%20brand%20voice.pdf' }) .then(({ data }) => console.log(data)) .catch(err => console.error(err)); ``` `newKey` should be inside an object with a key of `metadata` and `appVisibility` should inside an object with key `settings` Below is how it should look. ``` const sdk = require('api')('@fr0sty/v1.0#3y00k1blog8la60'); sdk.uploadKnowledgeDocument({ metadata: { newKey: 'New Value'}, settings: {appVisibility: 'visible'}, name: 'Product Release Monthly Webinar - May 2023', file: 'starbucks%20brand%20voice.pdf' }) .then(({ data }) => console.log(data)) .catch(err => console.error(err)); ``` Stoplight & Swagger-UI produce the above result. Why does `Readme` not include the `metadata` & `settings` key in the object?

I assume that it's not currently possible to sync a Readme with a Symfony app except with GitHub Actions. It would be great to use API plateform features to automatically sync data and generate Readme content. I haven't found anything in discussions about this, is something like this possible and planned in the future?

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.

Hello! Is it possible to password protect just one page of our documentation?

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.