Upload an OpenAPI spec file

Upload an OpenAPI specification file directly for parsing and indexing

1 min read

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

Request example

curl --request POST \
  --url https://your-instance.example.com/api/parse-openapi-upload \
  --header 'Content-Type: multipart/form-data' \
  --form 'openapiFile=<file>'

Response

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

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

Body

multipart/form-data

openapiFilefilerequired#

A .json or .yaml OpenAPI specification file

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 an OpenAPI spec by URL Import a library bundle