Discussions

Currently, if a user opens the docs generated by readme.com all the pages are collapsed in the sidebar and the user needs to expand the pages to see the subpages. Is there any way to expand all sidebar pages/categories and see all subpages in the sidebar by default?

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)

There appears to be a bug in the way ReadMe is rendering descriptions of complex schemas that make use of `allOf` to combine multiple schema and reference objects. The behavior that I'm seeing is the description within the most nested object is being used instead of the description from the top-level object. Suppose your API spec is made up of two files, `sampleSpec.json` and `common.json`. Within those files you have the following sample schema objects defined: ``` # Within sampleSpec.json: "Party": { "title": "Party", "description": "Information about a party", "allOf": [ { "$ref": "common.json#/components/schemas/NameAddress" }, { "type": "object", "properties": { "phone": { "$ref": "common.json#/components/schemas/TelephoneNumber", "description": "Phone number" } } }, { "type": "object", "properties": { "entityType": { "$ref": "common.json#/components/schemas/EntityType" } "email": { "type": "string", "format": "email" } } } ], "type": "object" } # Within common.json: "NameAddress": { "title": "Name and Address", "description": "Individual or business name with address", "required": [ "name1" ], "allOf": [ { "properties": { "name1": { "$ref": "#/components/schemas/String64", "description": "Name line 1" }, "name2": { "$ref": "#/components/schemas/String64", "description": "Name line 2" } }, "type": "object" }, { "$ref": "#/components/schemas/Address" } ], "type": "object" }, "Address": { "title": "Address", "description": "Postal address", "required": [ "line1", "city", "country" ], "properties": { "line1": { "type": "string", "description": "Address line 1" }, "line2": { "type": "string", "description": "Address line 2" }, "line3": { "type": "string", "description": "Address line 3" }, "city": { "type": "string", "description": "City" }, "state": { "type": "string", "description": "State or province" }, "postalCode": { "type": "string", "maxLength": 10, "description": "Postal code" }, "country": { "oneOf": [ { "$ref": "#/components/schemas/Iso3166CountryCode" }, { "type": "string", "description": "Spelled-out country names -or- ISO 3166-2" } ], "description": "Country" } }, "type": "object" }, ``` When rendering the description for Party, I would expect to see _Information about a party_ However, ReadMe is rendering the text as _Postal address_. This is in conflict with ReadMe's docs @ <https://docs.readme.com/main/docs/openapi-compatibility-chart#reference-object>: _Prior to rendering your API documentation all $ref pointers are dereferenced. Additionally, as of OpenAPI 3.1, you can include summary and description fields in addition to the $ref pointer, which will override the summary and description fields of the referenced component. Everything else will be fully dereferenced._

As per title, thanks

Hi Is there any way to hide the login button on the header?  Thank you!

Hello, we have the following section in our openapi definition file: ``` ... requestBody: required: true content: application/json: schema: oneOf: - $ref: "./components/auth.yml#/schemas/UserCredentialRequest" - $ref: "./components/auth.yml#/schemas/RefreshTokenRequest" - $ref: "./components/auth.yml#/schemas/AuthorizationCodeRequest" discriminator: propertyName: grant_type mapping: password: "./components/auth.yml#/schemas/UserCredentialRequest" refresh_token: "./components/auth.yml#/schemas/RefreshTokenRequest" authorization_code: "./components/auth.yml#/schemas/AuthorizationCodeRequest" ... ``` Somehow, the request body is not rendered in the UI, this is what we see: <https://pasteboard.co/toDL5B2pvcA0.png> Is it a bug or are we doing something wrong? The same exact openapi definition works with \[redocly](<https://redocly.com/>) without any changes.

Hi, Could you please help me with couple of question? 1.Once the changes are promoted to production from staging is there any way we can rollback those changes? 2.At the moment we are unable to promote changes to production for a single page and instead need to promote all the changes(of all pages) in one go so is there any way here as well we can optimize it to promote the required changes only instead of promoting all at a single time. Thanks

can I setting to some users can edit and modify some endpoints del API-Reference? example: [email protected] can only edit and modify order's option of API-Reference and [email protected] can only edit and modify cards' option of API-reference.

1. I have created a new page in Guide. 2. I used '/Custom HTML' block and added a h4 tag in the HTML. 3. How can I get this heading to appear in 'Table of contents'

Can I provide redirects to third-party websites in ReadMe pages?