Discussions

Hi, I am trying to set the Personalized Docs Webhook for my application. I added enpoint and served it with ngrok. I tested that endpoint through the Postman and it's giving me correct result. It's working. Here is the CURL: curl --location --request POST '<https://8407-85-114-46-238.eu.ngrok.io/webhook>' --header 'Content-Type: application/json' --data-raw '{ "email": "test" }' But when I test it in the 3. step of Personalized Docs I am getting: Endpoint not found! Did you forget the path in your server URL (e.g., /webhook)? With Network response: 400 status code and json response {type: "not-found"} Can you provide me more information about why am I getting this response?

Hi All, I have a startup account and would like to keep my project private. But, I want to share my project with 20 external users. What is the best option to achieve it? Thanks, Manish

Eg. so we can get a list of current questions, and post responses to questions via the API? Thanks Ben

When trying to edit category through command, getting error Command: rdme openapi --key=$README_API_KEY --id=$CATEGORY_ID Error: request to <https://dash.readme.com/api/v1/api-registry> failed, reason: unable to get local issuer certificate

Hi. It seems like readme does not support 'including' a page, header, footer, etc. in other pages. (as in other tools like jekyll - <https://jekyllrb.com/docs/includes/>) However, it would be much easier if we could handle any recurring parts in similar roles of pages - for instance, common 'if you have further questions' section in FAQ sibling pages - in 'include' fashion. Is there a plan to support a function like this, or is there any well-known or officially-guided workaround to do this? Thank you.

We are using Readme for our API documentation, we use OAS document to add the APIs Reference, now we want to Add Badges to indivdual API endpoint (like Alpha, Beta, Stable)

Hi there! Are there plans to allow users to collapse the sidebar in editing mode? It takes up a large chunk of screen space, especially for users with lower resolutions and/or smaller laptop screens.

after updating readme.io through github using OAS3.0.1 file. I am unable to see the complete request example in readme.io. Please help me to resolve this issue.

build Unknown error (Cannot read property 'slug' of null). <https://docs.readme.com/main/reference> and include the following link to your API log:

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._