Skip to content

Update OpenAPI Schemas #594

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

Open
rapidata-openapi-generator wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update OpenAPI Schemas #594

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
29 changes: 29 additions & 0 deletions openapi/schemas/audience.openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1444,6 +1444,35 @@
}
}
},
"/audience/reconcile-user-counts": {
"post": {
"tags": [
"Audience"
],
"summary": "Enqueues a background job that reconciles audience-row state derived\n from audience_state_counts.",
"responses": {
"202": {
"description": "Accepted"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationProblemDetails"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"403": {
"description": "Forbidden"
}
}
}
},
"/audience/{audienceId}/recreate-external-audiences": {
"post": {
"tags": [
Expand Down
5 changes: 5 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 @@ -3357,6 +3357,11 @@
}
],
"description": "The aggregator type. If not provided, inherits from the previous revision."
},
"validationSetId": {
"type": "string",
"description": "A validation set id to pin on this revision. When set, every job run from this\n revision uses the specified validation set as the source of validation rapids\n instead of audience-derived examples. If not provided, inherits from the previous\n revision. Provide a wrapped null value to clear a previously pinned set.",
"nullable": true
}
},
"description": "The input for the create job revision endpoint."
Expand Down
250 changes: 250 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 @@ -806,6 +806,176 @@
}
}
},
"/global-text": {
"post": {
"tags": [
"GlobalText"
],
"summary": "Creates a new global text entry.",
"requestBody": {
"description": "The payload describing the entry to create.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateGlobalTextEndpoint_Input"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateGlobalTextEndpoint_Output"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationProblemDetails"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"403": {
"description": "Forbidden"
}
}
},
"get": {
"tags": [
"GlobalText"
],
"summary": "Returns every global text entry.",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetAllGlobalTextsEndpoint_Output"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationProblemDetails"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"403": {
"description": "Forbidden"
}
}
}
},
"/global-text/{globalTextId}": {
"delete": {
"tags": [
"GlobalText"
],
"summary": "Deletes a global text entry.",
"parameters": [
{
"name": "globalTextId",
"in": "path",
"description": "The id of the global text entry to delete.",
"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"
}
}
},
"patch": {
"tags": [
"GlobalText"
],
"summary": "Updates a global text entry using patch semantics.",
"parameters": [
{
"name": "globalTextId",
"in": "path",
"description": "The id of the global text entry to update.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The patch payload describing which fields should change.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateGlobalTextEndpoint_Input"
}
}
},
"required": true
},
"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 Expand Up @@ -1526,6 +1696,35 @@
}
}
},
"CreateGlobalTextEndpoint_Input": {
"required": [
"key",
"englishText"
],
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "The human-readable key used to look up the text from translations."
},
"englishText": {
"type": "string",
"description": "The English source text that all translations derive from."
}
}
},
"CreateGlobalTextEndpoint_Output": {
"required": [
"globalTextId"
],
"type": "object",
"properties": {
"globalTextId": {
"type": "string",
"description": "The unique identifier of the created global text entry."
}
}
},
"CreateValidationFeedbackEndpoint_Input": {
"required": [
"feedback"
Expand Down Expand Up @@ -1561,6 +1760,44 @@
"Audio"
]
},
"GetAllGlobalTextsEndpoint_Output": {
"required": [
"globalTexts"
],
"type": "object",
"properties": {
"globalTexts": {
"allOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GetAllGlobalTextsEndpoint_Output_Item"
}
}
],
"description": "The list of global text entries."
}
}
},
"GetAllGlobalTextsEndpoint_Output_Item": {
"required": [
"id",
"key",
"englishText"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"key": {
"type": "string"
},
"englishText": {
"type": "string"
}
}
},
"GetGlobalResponsesEndpoint_Output": {
"required": [
"responses"
Expand Down Expand Up @@ -3905,6 +4142,19 @@
}
}
},
"UpdateGlobalTextEndpoint_Input": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "The new key for the global text entry."
},
"englishText": {
"type": "string",
"description": "The new English source text for the global text entry."
}
}
},
"UpdateValidationRapidEndpoint_Input": {
"type": "object",
"properties": {
Expand Down
Loading
Loading