Get the content of an OpenAPI spec at a site revision

Retrieves the content of the OpenAPI spec version the site revision pins. A spec the site revision does not record returns 404.

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$
siteIdstringRequired

The unique id of the site

siteRevisionIdstringRequired

The unique id of the site revision

specSlugstringRequired

Slug of the OpenAPI specification

Responses
200

OK

application/json

Content of the specification available through filesystem or public URL.

filesystemobjectRequired

Filesystem containing all specifications.

get/orgs/{organizationId}/sites/{siteId}/revisions/{siteRevisionId}/openapi/{specSlug}/content
GET /v1/orgs/{organizationId}/sites/{siteId}/revisions/{siteRevisionId}/openapi/{specSlug}/content HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "filesystem": {},
  "urls": {
    "source": "https://example.com",
    "public": null
  }
}

Last updated

Was this helpful?

Powered by GitBook