Skip to main content
posthttps://your-instance.example.com/api/parse-openapi
Request example
Response
posthttps://your-instance.example.com/api/parse-openapi

Authorization

Authorizationstringheaderrequired#
API key generated from Personal Settings. See Authentication.

Body

application/json
openApiUrlstringrequired#
URL of a JSON or YAML OpenAPI specification
projectTitlestring#
Display name for the project
descriptionstring#
Short description shown in the library list
forceboolean#
Re-parse even if already indexed

Default: false

Responses

application/json
Parse job accepted and queued
messagestringrequired#

Example:"Parse queued"

projectstringrequired#
Project identifier assigned to this library (e.g. /your-org/your-repo)

Example:"/your-org/your-repo"

queueIdintegerrequired#
Numeric ID for this parse job

Example:5

positioninteger#
Position in the queue. null if the job started immediately

Example:1