Discussions

Ask a Question
ANSWERED

Can I use custom variables from my Personalised-Docs to pre popuaate fields in my api-definitions ?

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

Error coming for few specs for version mismatch

What is this error - The version you specified (1.0.7) doesn't match any of the existing versions (1.0) in ReadMe. ?
ANSWERED

where can I find my readMe secret for custom webhooks

where can I find my readMe secret for custom webhooks

Let your customers register on readme

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?

Multipart/form-data properties are not generated correctly

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?

Synchronization with Symfony

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

Can you use a custom domain for API docs with free or startup plans?

Like the title says! I'm curious if you can use a custom domain when you aren't on the enterprise plan. Thanks!
ANSWERED

Remove a discussion thread

Is it possible to remove a discussion thread from the Discussions page? Thank you :)

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.