Skip to content

Update OpenAPI Schemas #417

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 #417

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
254 changes: 205 additions & 49 deletions openapi/schemas/audience.openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,12 @@
}
],
"paths": {
"/audience/{audienceId}/recruit": {
"post": {
"/audience/{audienceId}": {
"delete": {
"tags": [
"Audience"
],
"summary": "Starts recruiting users for the specified audience.",
"summary": "Deletes the specified audience.",
"parameters": [
{
"name": "audienceId",
Expand Down Expand Up @@ -48,52 +48,7 @@
"description": "Forbidden"
}
}
}
},
"/audiences": {
"get": {
"tags": [
"Audience"
],
"summary": "Queries all available audiences.",
"parameters": [
{
"name": "request",
"in": "query",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QueryModel"
}
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/PagedResultOfQueryAudiencesResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedResultOfQueryAudiencesResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PagedResultOfQueryAudiencesResult"
}
}
}
}
}
}
},
"/audience/{audienceId}": {
},
"get": {
"tags": [
"Audience"
Expand Down Expand Up @@ -175,6 +130,134 @@
}
}
},
"/audience/{audienceId}/jobs": {
"get": {
"tags": [
"Audience"
],
"summary": "Queries all jobs for the specified audience.",
"parameters": [
{
"name": "audienceId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedResultOfQueryJobsResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationProblemDetails"
}
}
}
},
"401": {
"description": "Unauthenticated"
},
"403": {
"description": "Forbidden"
}
}
}
},
"/audience/{audienceId}/recruit": {
"post": {
"tags": [
"Audience"
],
"summary": "Starts recruiting users for the specified audience.",
"parameters": [
{
"name": "audienceId",
"in": "path",
"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"
}
}
}
},
"/audiences": {
"get": {
"tags": [
"Audience"
],
"summary": "Queries all available audiences.",
"parameters": [
{
"name": "request",
"in": "query",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QueryModel"
}
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/PagedResultOfQueryAudiencesResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedResultOfQueryAudiencesResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PagedResultOfQueryAudiencesResult"
}
}
}
}
}
}
},
"/audience": {
"post": {
"tags": [
Expand Down Expand Up @@ -1834,6 +1917,12 @@
"$ref": "#/components/schemas/QueryAudiencesResult"
}
},
"ListOfQueryJobsResult": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QueryJobsResult"
}
},
"ListOfQueryRapidsForAudienceResult": {
"type": "array",
"items": {
Expand Down Expand Up @@ -1966,6 +2055,36 @@
}
}
},
"PagedResultOfQueryJobsResult": {
"required": [
"total",
"page",
"pageSize",
"items"
],
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"page": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"items": {
"$ref": "#/components/schemas/ListOfQueryJobsResult"
},
"totalPages": {
"type": "integer",
"format": "int32"
}
}
},
"PagedResultOfQueryRapidsForAudienceResult": {
"required": [
"total",
Expand Down Expand Up @@ -2050,6 +2169,43 @@
}
}
},
"QueryJobsResult": {
"required": [
"jobId",
"name",
"definitionId",
"audienceId",
"revisionNumber",
"status",
"createdAt"
],
"type": "object",
"properties": {
"jobId": {
"type": "string"
},
"name": {
"type": "string"
},
"definitionId": {
"type": "string"
},
"audienceId": {
"type": "string"
},
"revisionNumber": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
}
}
},
"QueryModel": {
"type": "object",
"properties": {
Expand Down
5 changes: 5 additions & 0 deletions openapi/schemas/leaderboard.openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2498,6 +2498,7 @@
"name",
"isPublic",
"createdAt",
"ownerId",
"ownerMail"
],
"type": "object",
Expand All @@ -2515,6 +2516,10 @@
"type": "string",
"format": "date-time"
},
"ownerId": {
"type": "string",
"format": "uuid"
},
"ownerMail": {
"type": "string"
}
Expand Down
Loading