Much of the font styling has changed on our documentation site recently, but we have not made any recent modifications to our custom CSS. This leads me to believe that Readme changed some of the default styling. Can we get a detailed breakdown of the recent default CSS changes Readme made? These changes have made our documentation look considerably worse and I would like to fix it.
Posted by Ben Pearson 2 months ago
A property in the response schema or request body schema can have multiple settings. I.e. for strings types:maxLength, minLength, pattern and for integer types: minimum, exclusiveMinimum, maximum, exclusiveMaximum. I would like to see these property settings back in my API Reference, at each body params and in the response object. It would also be great if the value of the body param will be checked against these settings when clinking the "Try it" button.
Posted by Wouter Houwen 2 months ago
Posted by Jo Stichbury 2 months ago
Some of our routes do not read the path parameters when trying out a route. The render of the documentation recognises the path parameter but does not pass it on to the curl command that actually makes the call. How can I go about resolving this?
Posted by Sagini Abenga 2 months ago
Hello all, Our swagger documentation includes some sample JSON responses to one of our end-points, however once in readme, it's not displayed in the 'response' portion. I only see the response schema. Is there a way to make this visible in the documentation?
Posted by Jason Clark 2 months ago
Hello. Our auto-generated Swagger file contains lots of APIs, and many of them shouldn't be made its way into the documentation because they are not ready yet. Is there any way that we can mark each API whether it should be part of the documentation or not?
Posted by Byungjoon Lee 2 months ago
I am pasting the link into embed field it takes the correct URL but when I save and try to open the link it removes my line number Expected Url to open when l click on the link: https://github.com/firebase/snippets-android/blob/71642c5f40145a91c4199549fdd169175930dccf/storage/app/src/main/java/com/google/firebase/referencecode/storage/StorageActivity.java#L156-L167 -------------------------------------- Actual Url which opens: https://github.com/firebase/snippets-android/blob/71642c5f40145a91c4199549fdd169175930dccf/storage/app/src/main/java/com/google/firebase/referencecode/storage/StorageActivity.java: -------------------- Please look into this as it is critical for our documentation
Posted by Mangesh Yadav 2 months ago
For example, "$ref": "access-groups.json#/paths", "$ref": "agent-bulk-operations.json#/paths" According to ReadMe employee Gregory Koberger, the rdme CLI tool is supposed to automatically bundle all specs that are refed before uploading. However, the CLI tool is not doing this, it just fails with an error, Unable to resolve $ref pointer. See old discussion question where ReadMe said this was possible: https://docs.readme.com/discuss/5dd45061759acc002bdb0867
Posted by L Duvall 2 months ago
I can get all of the category IDs by hitting `/api/v1/version/:versionId`, but I cannot do anything with those IDs because `/api/v1/categories/:slug` only takes a slug, not an ID. There is no way to fetch all of the slugs. Either the versions API should return all slugs, or there should be an endpoint that returns categories by ID. Also, when POSTing to `/api/v1/docs`, it expects a category ID. Please standardize on whether API consumers should be using the ID or the slug.
Posted by Ben Iofel 3 months ago
We're looking to have an internal documentation site and an external documentation site. Looking through old questions, it looks like we need to do separate projects -- but all the questions I found we're several years old. Is this still the case?
Posted by James Wilson 3 months ago
When someone searches for a topic on our readme implementation they will get all content from Docs, Discussions, Changelog, etc. I want this to clearly indicate where the results are coming from so that users can better select which results they want to see. Ideally, there would be a way to filter search results by source/relevance/date...
Posted by Shawn Jaques 3 months ago