Skip to content

Fix agent API spec accuracy #4498

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
mintlify wants to merge 1 commit into from
+35 −6
Closed

Fix agent API spec accuracy #4498

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 35 additions & 6 deletions admin-openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,11 +88,17 @@
"200": {
"description": "Agent job created successfully (streaming response). X-Session-Id Header is sent back in the response",
"headers": {
"X-Message-Id": {
"X-Session-Id": {
"schema": {
"type": "string"
},
"description": "Message identifier for the created job"
"description": "Unique identifier for the created agent session"
},
"X-Branch-Name": {
"schema": {
"type": "string"
},
"description": "Git branch name where the agent is making changes"
}
},
"content": {
Expand Down Expand Up @@ -159,8 +165,8 @@
},
"haultReason": {
"type": "string",
"enum": ["completed", "github_missconfigured", "error"],
"description": "Reason for session halt."
"enum": ["completed", "processing", "interrupted", "github_missconfigured", "error"],
"description": "Reason for session halt. `completed` — the job finished successfully. `processing` — the job is still running. `interrupted` — the job was interrupted before finishing. `github_missconfigured` — the GitHub integration is not properly configured. `error` — an unrecoverable error occurred."
},
"pullRequestLink": {
"type": "string",
Expand Down Expand Up @@ -232,6 +238,29 @@
"type": "string"
},
"description": "Your project ID. Can be copied from the [API keys](https://dashboard.mintlify.com/settings/organization/api-keys) page in your dashboard."
},
{
"name": "skip",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 0,
"default": 0
},
"description": "Number of jobs to skip for pagination."
},
{
"name": "take",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 12
},
"description": "Number of jobs to return. Maximum is 100."
}
],
"responses": {
Expand Down Expand Up @@ -267,8 +296,8 @@
},
"haultReason": {
"type": "string",
"enum": ["completed", "github_missconfigured", "error"],
"description": "Reason for session halt."
"enum": ["completed", "processing", "interrupted", "github_missconfigured", "error"],
"description": "Reason for session halt. `completed` — the job finished successfully. `processing` — the job is still running. `interrupted` — the job was interrupted before finishing. `github_missconfigured` — the GitHub integration is not properly configured. `error` — an unrecoverable error occurred."
},
"pullRequestLink": {
"type": "string",
Expand Down
Loading