Skip to content

Update OpenAPI Schemas #670

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

Merged
LinoGiger merged 1 commit into from
Jul 13, 2026
Merged

Update OpenAPI Schemas #670

Show file tree
Hide file tree
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
507 changes: 502 additions & 5 deletions openapi/schemas/identity.openapi.json
View file
Open in desktop

Large diffs are not rendered by default.

184 changes: 0 additions & 184 deletions openapi/schemas/leaderboard.openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6451,118 +6451,6 @@
"deprecated": true
}
},
"/leaderboard/{leaderboardId}/participant/{participantId}": {
"get": {
"tags": [
"Leaderboard"
],
"summary": "Gets a participant by its id.",
"parameters": [
{
"name": "leaderboardId",
"in": "path",
"description": "The id of the leaderboard the participant belongs to.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "participantId",
"in": "path",
"description": "The id of the participant to retrieve.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetParticipantByIdObsoleteEndpoint_Output"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationProblemDetails"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"403": {
"description": "Forbidden"
}
}
}
},
"/benchmark/standing/{leaderboardId}/{participantId}": {
"get": {
"tags": [
"Leaderboard"
],
"summary": "Gets a standing by leaderboard id and participant id.",
"parameters": [
{
"name": "leaderboardId",
"in": "path",
"description": "The id of the leaderboard the standing belongs to.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "participantId",
"in": "path",
"description": "The id of the participant whose standing should be retrieved.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetStandingByIdEndpoint_Output"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationProblemDetails"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"403": {
"description": "Forbidden"
}
}
}
},
"/leaderboard/combined-matrix/query": {
"get": {
"tags": [
Expand Down Expand Up @@ -12752,42 +12640,6 @@
}
}
},
"GetParticipantByIdObsoleteEndpoint_Output": {
"required": [
"id",
"name",
"benchmarkId",
"status",
"isDisabled"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the standing."
},
"name": {
"type": "string",
"description": "The name of the participant."
},
"benchmarkId": {
"type": "string",
"description": "The id of the benchmark this standing belongs to."
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/StandingStatus"
}
],
"description": "The status of the standing."
},
"isDisabled": {
"type": "boolean",
"description": "Whether the participant is disabled."
}
}
},
"GetPromptsByBenchmarkEndpoint_Output": {
"required": [
"id",
Expand Down Expand Up @@ -13721,42 +13573,6 @@
}
}
},
"GetStandingByIdEndpoint_Output": {
"required": [
"id",
"name",
"benchmarkId",
"status",
"isDisabled"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the standing."
},
"name": {
"type": "string",
"description": "The name of the participant."
},
"benchmarkId": {
"type": "string",
"description": "The id of the benchmark this standing belongs to."
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/StandingStatus"
}
],
"description": "The status of the standing."
},
"isDisabled": {
"type": "boolean",
"description": "Whether the participant is disabled."
}
}
},
"IAssetInput": {
"required": [
"_t"
Expand Down
47 changes: 47 additions & 0 deletions openapi/schemas/order.openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4393,6 +4393,28 @@
},
"description": "The result when a job definition has been created."
},
"CreateJobEndpoint_CostWarningModel": {
"required": [
"estimatedCost",
"availableBalance",
"shortfall"
],
"type": "object",
"properties": {
"estimatedCost": {
"type": "number",
"format": "double"
},
"availableBalance": {
"type": "number",
"format": "double"
},
"shortfall": {
"type": "number",
"format": "double"
}
}
},
"CreateJobEndpoint_Input": {
"required": [
"jobDefinitionId",
Expand Down Expand Up @@ -4450,6 +4472,14 @@
"recruitingStarted": {
"type": "boolean",
"description": "Whether recruiting was automatically started for the audience."
},
"costWarning": {
"allOf": [
{
"$ref": "#/components/schemas/CreateJobEndpoint_CostWarningModel"
}
],
"description": "Present only when the job's estimated cost exceeds the owner's remaining balance.\n Advisory — the job is created and runs regardless; it may pause for funds mid-run."
}
},
"description": "The result when a job has been created."
Expand Down Expand Up @@ -4926,6 +4956,14 @@
"description": "The failure message.",
"nullable": true
},
"reviewReason": {
"allOf": [
{
"$ref": "#/components/schemas/ReviewReasonModel"
}
],
"description": "Why the job was routed to manual review, when it is (or was) in\n ManualApproval. Null when no customer-facing reason\n applies."
},
"createdAt": {
"type": "string",
"description": "The creation timestamp.",
Expand Down Expand Up @@ -7526,6 +7564,15 @@
"Sequential"
]
},
"ReviewReasonModel": {
"enum": [
"ContentFlagged",
"UnsupportedContentType",
"CheckErrored",
"ClassificationTimedOut",
null
]
},
"StickyConfig": {
"required": [
"dimension"
Expand Down
41 changes: 41 additions & 0 deletions openapi/schemas/rapid.openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1120,6 +1120,47 @@
}
}
},
"/rapid/compare-ab-summary/{correlationId}/recalculate": {
"post": {
"tags": [
"Rapid"
],
"summary": "Recalculates the compare AB summary counters of a correlation from scratch.",
"description": "Admin-only verification/repair tool. The counters are normally maintained by rapid\n completion and rejection events; this overwrites them with freshly aggregated values.",
"parameters": [
{
"name": "correlationId",
"in": "path",
"description": "The correlation (workflow) id to recalculate.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationProblemDetails"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"403": {
"description": "Forbidden"
}
}
}
},
"/rapid/{rapidId}/reject": {
"post": {
"tags": [
Expand Down
Loading
Loading