Discussions
How do I get example responses to display?
I have examples included in the OpenApi.json but the example does not display in the readme.com. The example do display in both swaggerUI and redoc.
The example is included in the component.schema object and looks like the following...
```
{
"components": {
"schemas": {
"Video": {
"required": [
"title"
],
"type": "object",
"properties": {
"title": {
"maxLength": 255,
"type": "string"
},
"summary": {
"maxLength": 2000,
"type": "string",
"nullable": true
}
},
"example": "video example object"
}
}
}
}
```
Posted by Rachelle over 2 years ago
Let customers download open api spec
The admin dashboard has a way to export the api to oas spec file
But it doesn't seem like there's a way for the public facing api spec page to download an oas json file
That would be useful for customers if they prefer exploring the api with tools like Postman etc
Posted by Michael De Razon over 2 years ago
3-level nested TOC - Possible?
Beyond the page and then a page nested under it, is it possible to create a third hierarchical level?
Something like this:
Page - Level 1
Nested Page - Level 2
Nested Page - Level 2
Further Nested Page - Level 3
Page - Level 1
Posted by Paula Stern over 2 years ago
Is there a way to expand or hide content?
In my organization's API guides, we sometimes need to list a lot (like, 30) API endpoints, which all are related to a specific functionality. Including such a list to a table or in the document body has a real negative impact on readability.
In our internal wiki (Confluence), I can create a table with an expand macro, so the user can toggle between viewing and hiding the list of endpoints.
Do you have any suggestions on how to work around this in ReadMe?
Posted by Katri Metsävuo over 1 year ago
Is there a way to add comments using Readme's markdown?
I'd like to add a comment to a topic in readme that internal users will be able to see, but that will not get picked up and published, such as:
..
internal RST comment
<!--- internal GitHub markdown comment --->
<!--internal HTML comment-->
Is that possible in a ReadMe file? I'm not seeing anything in the markdown reference, and would like to avoid trial and error if possible.
Posted by Alison over 2 years ago
Enum value used as example appears twice in combo box
Hello,
When declaring in my OpenAPI spec a field such as:
```
"carColor":{"type":"string","example":"WHITE","description":"Color of the car","enum":["WHITE","BLACK","BLUE"]}
```
... then the field appears in Readme with a combo box with the possible values: `WHITE`, `WHITE`, `BLACK`, `BLUE`. If I select the first `WHITE` value, it won't be included in the generated JSON in the right pane (it does work with the other values).
Is there a way to have this value appear only once, be included in the generated JSON and still keep this value as an example?
Thank you,
Eric
Posted by Eric T about 2 years ago
Github for all documentation
Hi, we want to use github as our source of truth for all our product documentation (not just api definitions).
Is it possible to manage the documentation repository with our standard engineering flows, then publish to readme becomes a merge to a branch ?
We include images in our documentation, would it support this as well?
Posted by Troy Sellers about 2 years ago
Upload multiple images at once
Is there was a way to upload all of the images I need for my team's guides into ReadMe at once? In previous Markdown-based doc repos, I've seen things like an "attachments" folder, where you can upload all of the things you want to link to in your docs - is there any feature like that in ReadMe? I've also seen the suggestion in [this post](https://docs.readme.com/discuss/60ef30cc442bc901a01f3aaa) that we can host our images on a separate site like Imgur, but it would be much more convenient for my team if we were able to keep all of our images on ReadMe.
Thanks in advance!
Posted by Sarah Eberhardt almost 2 years ago
Syncing via CLI: "Path `category` is required."
Hi there!
I'm trying to sync a folder of markdown guides up to Readme.
My documents all have the [required header](https://docs.readme.com/docs/importing-documentation#expected-file-format) (title, excerpt) and are otherwise plain markdown in a flat directory structure (ie. they're all in one folder with no subfolders).
```
$ npx rdme docs docs/guides --key={MY_KEY} --version=1.0
> We couldn't save this doc (Path `category` is required.).
```
I'm not really sure what that error message means... Where should I put a category? Should they be in a particular subdirectory?
Posted by Oliver Fawcett about 2 years ago
Moving a page to a newer version
Hi. Novice user here. I created a new page in a live version of our guide and then made that new page live, not realizing that another editor had already branched a new draft version. Several days later that draft was published, thus removing my new page from our live site. My question is how do I move that page to the new version? I can see that dragging and dropping the page within the old version is easy, but I can't seem to drag it into the new version and republish it live. Do I have to recreate the page in its entirely or is there a way to drag or clone it to the currently live version? Thank you,.
Posted by Scott over 2 years ago