Skip to content
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

Update OpenAPI Schemas #183

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update OpenAPI Schemas #183

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
246 changes: 246 additions & 0 deletions openapi/output.swagger.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2350,6 +2350,50 @@
}
}
},
"/rapid/validation/{rapidId}": {
"put": {
"tags": [
"Rapid"
],
"summary": "Updates the validation information of a rapid.",
"parameters": [
{
"name": "rapidId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateValidationRapidModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateValidationRapidModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdateValidationRapidModel"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/CompareWorkflow/GetResultOverview": {
"get": {
"tags": [
Expand Down Expand Up @@ -3011,6 +3055,114 @@
}
}
},
"/pipeline/{pipelineId}/preliminary-download": {
"post": {
"tags": [
"Pipeline"
],
"summary": "Initiates a preliminary download of the pipeline.",
"parameters": [
{
"name": "pipelineId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PreliminaryDownloadModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PreliminaryDownloadModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/PreliminaryDownloadModel"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/PreliminaryDownloadResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PreliminaryDownloadResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PreliminaryDownloadResult"
}
}
}
}
}
}
},
"/pipeline/preliminary-download/{preliminaryDownloadId}": {
"get": {
"tags": [
"Pipeline"
],
"summary": "Gets the preliminary download. If it's still processing the request will return 202 Accepted.",
"parameters": [
{
"name": "preliminaryDownloadId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "string",
"format": "binary"
}
},
"application/json": {
"schema": {
"type": "string",
"format": "binary"
}
},
"text/json": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"202": {
"description": "Accepted"
}
}
}
},
"/Campaign/Monitor": {
"get": {
"tags": [
Expand Down Expand Up @@ -5921,13 +6073,17 @@
"isPublic",
"orderDate",
"orderName",
"pipelineId",
"state"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"pipelineId": {
"type": "string"
},
"orderDate": {
"type": "string",
"format": "date-time",
Expand Down Expand Up @@ -8584,13 +8740,17 @@
"required": [
"asset",
"correctValidationCount",
"id",
"invalidValidationCount",
"metadata",
"payload",
"type"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
Expand Down Expand Up @@ -8736,6 +8896,10 @@
"invalidValidationCount": {
"type": "integer",
"format": "int32"
},
"explanation": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
Expand Down Expand Up @@ -9124,6 +9288,66 @@
},
"additionalProperties": false
},
"UpdateValidationRapidModel": {
"required": [
"explanation",
"prompt",
"truth"
],
"type": "object",
"properties": {
"truth": {
"oneOf": [
{
"$ref": "#/components/schemas/TranscriptionTruth"
},
{
"$ref": "#/components/schemas/ScrubTruth"
},
{
"$ref": "#/components/schemas/PolygonTruth"
},
{
"$ref": "#/components/schemas/NamedEntityTruth"
},
{
"$ref": "#/components/schemas/LocateBoxTruth"
},
{
"$ref": "#/components/schemas/LineTruth"
},
{
"$ref": "#/components/schemas/EmptyValidationTruth"
},
{
"$ref": "#/components/schemas/CompareTruth"
},
{
"$ref": "#/components/schemas/AttachCategoryTruth"
},
{
"$ref": "#/components/schemas/BoundingBoxTruth"
}
],
"description": "",
"discriminator": {
"propertyName": "_t"
}
},
"explanation": {
"type": "string",
"description": "",
"nullable": true
},
"prompt": {
"type": "string",
"description": "",
"nullable": true
}
},
"additionalProperties": false,
"description": "The model for updating a validation rapid."
},
"CompareWorkflowModel1": {
"title": "CompareWorkflowModel",
"required": [
Expand Down Expand Up @@ -10874,6 +11098,28 @@
},
"additionalProperties": false
},
"PreliminaryDownloadModel": {
"type": "object",
"properties": {
"sendEmail": {
"type": "boolean",
"default": true
}
},
"additionalProperties": false
},
"PreliminaryDownloadResult": {
"required": [
"downloadId"
],
"type": "object",
"properties": {
"downloadId": {
"type": "string"
}
},
"additionalProperties": false
},
"SimpleWorkflowConfig": {
"title": "SimpleWorkflowConfig",
"required": [
Expand Down
4 changes: 4 additions & 0 deletions src/rapidata/api_client/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,6 +234,8 @@
from rapidata.api_client.models.pre_arranged_pair_maker_config import PreArrangedPairMakerConfig
from rapidata.api_client.models.pre_arranged_pair_maker_config_model import PreArrangedPairMakerConfigModel
from rapidata.api_client.models.pre_arranged_pair_maker_information import PreArrangedPairMakerInformation
from rapidata.api_client.models.preliminary_download_model import PreliminaryDownloadModel
from rapidata.api_client.models.preliminary_download_result import PreliminaryDownloadResult
from rapidata.api_client.models.private_text_metadata_input import PrivateTextMetadataInput
from rapidata.api_client.models.probabilistic_attach_category_referee_config import ProbabilisticAttachCategoryRefereeConfig
from rapidata.api_client.models.problem_details import ProblemDetails
Expand Down Expand Up @@ -303,6 +305,8 @@
from rapidata.api_client.models.update_access_model import UpdateAccessModel
from rapidata.api_client.models.update_campaign_model import UpdateCampaignModel
from rapidata.api_client.models.update_order_model import UpdateOrderModel
from rapidata.api_client.models.update_validation_rapid_model import UpdateValidationRapidModel
from rapidata.api_client.models.update_validation_rapid_model_truth import UpdateValidationRapidModelTruth
from rapidata.api_client.models.upload_coco_result import UploadCocoResult
from rapidata.api_client.models.upload_datapoints_result import UploadDatapointsResult
from rapidata.api_client.models.upload_files_from_s3_bucket_model import UploadFilesFromS3BucketModel
Expand Down
Loading
Loading