Discussions

How to set default value null or empty string?

Hey, I have a problem with parameters in header using format openapi. What I have to do in my schema to send all parameter in one header json format? Now, when I add a parameter type object, e.g.: {params: {option1: value1; option2: value2}} readme build a example of code like: X-params: object X-option1: value1 X-option2: value2 How I can change this to: X-params: {option1: value1; option2: value2}

I reported several months ago that the sitemap.xml format of the docs was wrong. Still hasn't been fixed. And now, instead of building the sitemap with our custom domain, you've added the readme.io domain! ``` <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:news="http://www.google.com/schemas/sitemap-news/0.9" xmlns:xhtml="http://www.w3.org/1999/xhtml" xmlns:image="http://www.google.com/schemas/sitemap-image/1.1" xmlns:video="http://www.google.com/schemas/sitemap-video/1.1" data-tag-assistant-present=""> <url> <loc>https://anytrack.readme.io/</loc> <changefreq>daily</changefreq> <priority>0.3</priority> </url> <url> <loc>https://anytrack.readme.io/</loc> <changefreq>weekly</changefreq> <priority>0.3</priority> </url> <url> <loc>https://anytrack.readme.io/docs/what-is-anytrack</loc> <changefreq>daily</changefreq> <priority>0.3</priority> </url> <url> <loc>https://anytrack.readme.io/docs/for-whom</loc> <changefreq>daily</changefreq> <priority>0.3</priority> </url> <url> <loc>https://anytrack.readme.io/docs/why-anytrack</loc> <changefreq>daily</changefreq> <priority>0.3</priority> </url> <url> <loc>https://anytrack.readme.io/docs/getting-started</loc> <changefreq>daily</changefreq> <priority>0.3</priority> </url> ```

We have 2 versions of our product, with correlating documentation. One of them has API Reference and the other does not. I want show API Reference in the Top Navigation bar on Version 1, but not on Version 2. How do I do that? When I remove the API Reference link on dash.readme.com/project/\<project_name>/v1.0/usability, it is also removed from dash.readme.com/project/\<project_name>/v2.0/usability. I would expect separate behavior, since the version number is in the URL.

any api call rate limit on the readme apis Lilke 500 request in a min. ?

My OpenApi spec has multiple security schemes (see the example below). When viewing my API documentation, I can only see the first scheme. How do I select which one should be used in my ReadMe documentation? ``` securitySchemes: apigee_security: type: apiKey name: x-orgid in: header bearer: type: apiKey name: Authorization in: header ```

I have added a parameter as File in body params and content-type:[multipart/form-data], on click on Try it , it is giving me Failed to parse multipart servlet request ``` ``` ``` ```

Sometimes its necessary to draw a graph in documentation, so it would be great if you could provide something like <https://mermaid.js.org/intro/>

Hello I face an issue when using multipart/form-data and object in body. Here is snapshot of current openapi 3.0  The problem is with `initials` and its content: `alignment` and` y` In documentation generated code looks like this:  In shell generated, we can see `--form alignment=hello --form y=10` Whereas i would expect `--form initials[alignment]=hello --form initials[y]=10` When using `application/json` instead of `multipart/form-data `is works very well, so i'm assuming this is a generation code problem related to `multipart/form-data`. Within the same endpoint i'm also upload a file so i need to keep `multipart/form-data` You can see our public doc here: <https://developers.yousign.com/reference/post-signature_requests-signaturerequestid-documents> Could you help me one this one, or tell me when this will be fixed ? Thanks

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?