Discussions

Ask a Question
ANSWERED

Can a page show endpoint object

Can we show a page with endpoint object rendererd from OAS ? Similar to the below example where accounts endpoint shows a page (section) with account object ? <https://stripe.com/docs/api/accounts/object#account_object> Thanks for your help.
ANSWERED

Recipe content

Am I correct in my assessment that we can't format the content in a recipe? Including adding links?
ANSWERED

Displaying recursive data results from an API

My api response returns data with the following structure ```json json { "data": [ { "id": "", "name": "", "children": [ { "id": "", "name": "", "children": [ ] }, { "id": "", "name": "", "children": [ ] }, ] } ] } ``` The children contains other children and so on, what is the best way to do so?

Why does the API URL title on the sidebar of my API documentation keep changing?

I keep changing the title from API URL to API Documentation because I wanted to change the way it looked and it keeps returning back to API URL. I change the text, it saves it automatically and then I check on the preview of my documentation site, but when I come back the next day, it is back to API URL. I am the only person writing API documentation and none of the other two on my account have changed anything. What's going on? Am I not supposed to change that text?
ANSWERED

Is there a way to use a glossary term in a variable definition?

For example, I'm using variables to house basic, one-paragraph definitions for each of our API endpoints. They use glossary terms. When I copy and paste the paragraph from a page into a variable definition field, the glossary term does not work.
ANSWERED

Different alt text with the image widget?

The image widget uses the same text for the caption of a figure and for the alt text of the image. However, you might want different text, because these items have different audiences. You might use a brief description for the caption and a more detailed description for the alt text. I know I can specify alt text via "plain" markdown: ``` ![This is alt text](https://example.com/path/to/image.png) ``` But then I lose the benefits of the image widget. Is there any way to do it?
ANSWERED

Templating

I'm curious if there's a way to implement a template in Readme? The use case is that I create a content in which that content can just be reference to different pages. Illustration: ``` <template id="contact-us">Contact Us</template> Guide: How To Write Writing is.... Need more help? <template/> Guide: How to Run Running is... Need more help? <template/> ``` In this way I will not copy-paste "Contact Us" content whenever I need it. And if I need to update Contact Us i will just update the source.
ANSWERED

Enhancement request

In the try it provide a way to set global header values so that you don't have to cut and paste into every endpoint that you want to try.
ANSWERED

How do you add an image using the new community discussions editor?

I cannot see a way to add an image to help explain my problem.... <https://v.usetapes.com/yLjdvMHiiJ>

Rendered code is not working well when using multipart/form-data

Hello I face an issue when using multipart/form-data and object in body. Here is snapshot of current openapi 3.0 ![](https://files.readme.io/f430275-image.png) The problem is with `initials` and its content: `alignment` and` y` In documentation generated code looks like this: ![](https://files.readme.io/9957dc7-image.png) 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