Parse an OpenAPI spec by URL

Queue a remote OpenAPI specification (JSON or YAML) for parsing and indexing

1 min read

posthttps://your-instance.example.com/api/parse-openapi

Request example

curl --request POST \
  --url https://your-instance.example.com/api/parse-openapi \
  --header 'Content-Type: application/json' \
  --data '{
  "openApiUrl": "<string>",
  "projectTitle": "<string>",
  "description": "<string>",
  "force": false
}'

Response

{
  "message": "Parse queued",
  "project": "/your-org/your-repo",
  "queueId": 5,
  "position": 1
}

posthttps://your-instance.example.com/api/parse-openapi

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#

projectstringrequired#

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

queueIdintegerrequired#

Numeric ID for this parse job

positioninteger#

Position in the queue. null if the job started immediately

Parse a Git repository Upload an OpenAPI spec file