Discussions

<https://preview.readme.io/reference/findPetsByTags> like the example above, i want my response (200/404) to have meaning names such as "successful operation". Where can i change that?

Hi, excited to try readme. Do you have any tips to auto generate openAPI specs from api endpoints in django rest framework?

Do you have a way to automate responses to questions received on the discussions section? I was thinking perhaps some webhook or something, and then through an API submit a response. Thank you.

after updating readme.io through github using OAS3.0.1 file. I am unable to see the complete request example in readme.io. Please help me to resolve this issue.

We host our API documentation on readme (see here: <https://docs.edgeimpulse.com/reference>). While we use the OpenAPI integration for our REST API, we are also working on generating and hosting Python API documentation for our Python SDK. At the moment, I have been learning and tinkering with sphinx and pydoc-markdown for markdown generation. Neither seems to provide the output required for readme without modifications to their code or some custom add-ons. Does anyone have any recommendations on tools that can read Python docstrings to produce good API documentation hosted on readme?

I'd like to retrieve ALL docs in a project. This includes all my reference docs plus any guides and custom pages I've created. Is there a way to do this via the API? I tried using the Search docs endpoint with a wildcard but only got limited results. I don't see a List All Docs endpoint.

Hi, While uploading the Swagger ".json" file on readme.io, I'm facing the below error: [block:image] { "images": [ { "image": [ "https://files.readme.io/448b0ca-image.png", null, null ], "align": "center" } ] } [/block] Relevant JSON block from the Swagger file: ``` "getProductInventorySnapshot": { "type": "object", "properties": { "sku": { "required": true, "type": "string", "example": "TEST-750" }, "upc": { "type": "integer", "example": "816136021655" } } } ``` Based on the requirements, that parameter has to be the "string" type but the error is saying to change it to an array. I'm not sure why. Also, there are already other end-point having params with with "string" type and there is no issue with that. Any help would be appreciated. Thanks

Is there a way to connect our product Doc markdown files to GitHub when we make edits in the ReadMe platform? Our team wants to ensure we have records in multiple places and I am having trouble figuring out how to set it up?

It seems readme is only available in a cloud-based server model. Or do you also provide an in-house server model?

Hi - i have implemented the Segment integration and I am surprised not to see search events being sent to segment. Unless I missed something or I am the only one interested in such data, I was wondering if there was a plan to add such events to the segment integration. I am interested in sending search events to destinations: - [AnyTrack attribution platform](https://anytrack.io) - [Hubspot](https://hubspot.com)