Parse a Git repository

Queue a GitHub or GitLab repository for parsing and indexing

1 min read

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

Request example

curl --request POST \
  --url https://your-instance.example.com/api/parse \
  --header 'Content-Type: application/json' \
  --data '{
  "repoUrl": "<string>",
  "branch": "<string>",
  "folders": [
    "<string>"
  ],
  "excludeFolders": [
    "<string>"
  ],
  "excludeFiles": [
    "<string>"
  ],
  "force": false
}'

Response

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

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

Body

application/json

repoUrlstringrequired#

HTTPS URL of the GitHub or GitLab repository

branchstring#

Branch to parse. Defaults to the repository's default branch

foldersstring[]#

Only index files under these paths. Empty means the entire repository

excludeFoldersstring[]#

Paths to skip during indexing

excludeFilesstring[]#

Glob patterns for files to exclude

forceboolean#

Re-parse even if the current commit is 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

Get documentation context Parse an OpenAPI spec by URL