ReadMe Documentation

ReadMe Documentation

Welcome to the ReadMe Documentation, where you'll find comprehensive guides and community support to help you start working with ReadMe as quickly as possible!

Get Started

Re-syncing Your OpenAPI Document

On re-sync of your OpenAPI file, pages are merged with existing pages if they are present. We use operationId of the Operation Object to determine what pages are considered to be the same.

If on re-sync there is a new operationId, then a new page is created. If on re-sync an operationId is removed, then the page is removed.

If you do not have an operationId, we create one for you using the following algorithm.

With an endpoint like this:

{
  "/pet": {
    "post": {
    }
  }
}

We take the path /pet, remove any non-alphanumeric characters, lowercase it and concatenate it onto the end of the method. So the above would become post_pet.

❗️

We recommend you always provide an operationId for each of your endpoints to reduce the risk of data loss associated with us creating a unique ID for you.

Updated about a year ago


Re-syncing Your OpenAPI Document


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.