{ "openapi": "3.0.0", "paths": { "/api/v1/artifacts/": { "post": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Artifact-dump" } } } } }, "summary": "Creates an Artifact resource", "operationId": "post_artifact_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Artifact-load" } } }, "required": true }, "tags": [ "Artifact" ] }, "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArtifactPage" } } } } }, "summary": "Gets a list of all Artifact resources", "operationId": "get_artifact_endpoint", "parameters": [ { "name": "sortBy", "in": "query", "description": "The name of the column to sort.", "schema": { "type": "string" } }, { "name": "descending", "in": "query", "description": "Boolean indicating whether to sort by descending or not.", "schema": { "type": "boolean" } }, { "name": "search", "in": "query", "description": "Search terms for the query (* and ? wildcards).", "schema": { "type": "string" } }, { "name": "groupId", "in": "query", "description": "Filter results by the Group ID.", "schema": { "type": "integer" } }, { "name": "index", "in": "query", "description": "Starting index of the current page.", "schema": { "type": "integer" } }, { "name": "pageLength", "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "outputParams", "in": "query", "description": "Ordered List of Plugin Task Parameter Ids of the output values produced by the ArtifactTask associated with the target Artifacts.", "schema": { "type": "string" } }, { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Artifact" ] } }, "/api/v1/artifacts/{id}": { "parameters": [ { "in": "path", "description": "ID for the Artifact resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Artifact-dump" } } } } }, "summary": "Gets an Artifact resource", "operationId": "get_artifact_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Artifact" ] }, "put": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Artifact-dump" } } } } }, "summary": "Modifies an Artifact resource", "operationId": "put_artifact_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArtifactMutableFields-load" } } }, "required": true }, "tags": [ "Artifact" ] } }, "/api/v1/artifacts/{id}/contents": { "parameters": [ { "in": "path", "description": "ID for the Artifact resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ArtifactFile-dump" } } } } } }, "summary": "Downloads the contents of an Artifact resource", "description": "Args:\n id: the resource id of the artifact\n\nReturns:\n A list of the files associated with artifact.", "operationId": "get_artifact_id_contents_endpoint", "parameters": [ { "name": "path", "in": "query", "description": "Path of a specific artifact. Only valid if artifactis a directory.", "schema": { "type": "string" } }, { "name": "fileType", "in": "query", "description": "Only valid if the artifact is a directory. The type of file todownload: tar_gz or zip.", "schema": { "type": "string" } }, { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Artifact" ] } }, "/api/v1/artifacts/{id}/files": { "parameters": [ { "in": "path", "description": "ID for the Artifact resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ArtifactFile-dump" } } } } } }, "summary": "Gets a list of all files associated with an Artifact resource", "operationId": "get_artifact_id_files_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Artifact" ] } }, "/api/v1/artifacts/{id}/snapshots": { "parameters": [ { "in": "path", "description": "ID for the EntityType.ARTIFACT resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SnapshotsArtifactPage" } } } } }, "summary": "Gets the Snapshots for the resource", "operationId": "get_resource_snapshots_endpoint", "parameters": [ { "name": "search", "in": "query", "description": "Search terms for the query (* and ? wildcards).", "schema": { "type": "string" } }, { "name": "index", "in": "query", "description": "Starting index of the current page.", "schema": { "type": "integer" } }, { "name": "pageLength", "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Artifact" ] } }, "/api/v1/artifacts/{id}/snapshots/{snapshotId}": { "parameters": [ { "in": "path", "description": "Snapshot ID for the EntityType.ARTIFACT resource.", "name": "snapshotId", "required": true, "schema": { "type": "integer" } }, { "in": "path", "description": "ID for the EntityType.ARTIFACT resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SnapshotsIdArtifact-dump" } } } } }, "summary": "Gets a Snapshot for the resource by snapshot id", "operationId": "get_resources_snapshots_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Artifact" ] } }, "/api/v1/artifacts/{id}/snapshots/{snapshotId}/contents": { "parameters": [ { "in": "path", "description": "Snapshot ID for the Artifact resource.", "name": "snapshotId", "required": true, "schema": { "type": "integer" } }, { "in": "path", "description": "Snapshot ID for the Artifact resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ArtifactFile-dump" } } } } } }, "summary": "Downloads the contents of an Artifact snapshot", "description": "Args:\n id: the resource id of the artifact\n snapshotId: the snapshot resource id of the artifact\n\nReturns:\n A list of the files associated with artifact.", "operationId": "get_artifact_snapshot_id_contents_endpoint", "parameters": [ { "name": "path", "in": "query", "description": "Path of a specific artifact. Only valid if artifactis a directory.", "schema": { "type": "string" } }, { "name": "fileType", "in": "query", "description": "Only valid if the artifact is a directory. The type of file todownload: tar_gz or zip.", "schema": { "type": "string" } }, { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Artifact" ] } }, "/api/v1/auth/login": { "post": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Login-dump" } } } } }, "summary": "Login to a registered user account", "operationId": "post_login_resource", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Login-load" } } }, "required": true }, "tags": [ "Authentication" ] } }, "/api/v1/auth/logout": { "post": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Logout-dump" } } } } }, "summary": "Logout the current user", "description": "Must be logged in.", "operationId": "post_logout_resource", "parameters": [ { "name": "everywhere", "in": "query", "description": "Logout on all devices.", "schema": { "type": "boolean" } }, { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Authentication" ] } }, "/api/v1/entrypoints/": { "post": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entrypoint-dump" } } } } }, "summary": "Creates an Entrypoint resource", "operationId": "post_entrypoint_endpoint", "parameters": [ { "name": "validateOnly", "in": "query", "description": "Flag indicating whether to perform a full validation and save the entrypoint, or perform a lighter validation and not save the entrypoint.", "schema": { "type": "boolean" } }, { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entrypoint-load" } } }, "required": true }, "tags": [ "Entrypoints" ] }, "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntrypointPage" } } } } }, "summary": "Gets a list of Entrypoint resources matching the filter parameters", "operationId": "get_entrypoint_endpoint", "parameters": [ { "name": "showDeleted", "in": "query", "description": "Boolean indicating whether to include deleted resources in the results.", "schema": { "type": "boolean" } }, { "name": "sortBy", "in": "query", "description": "The name of the column to sort.", "schema": { "type": "string" } }, { "name": "descending", "in": "query", "description": "Boolean indicating whether to sort by descending or not.", "schema": { "type": "boolean" } }, { "name": "search", "in": "query", "description": "Search terms for the query (* and ? wildcards).", "schema": { "type": "string" } }, { "name": "groupId", "in": "query", "description": "Filter results by the Group ID.", "schema": { "type": "integer" } }, { "name": "index", "in": "query", "description": "Starting index of the current page.", "schema": { "type": "integer" } }, { "name": "pageLength", "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Entrypoints" ] } }, "/api/v1/entrypoints/drafts/": { "post": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Draft-dump" } } } } }, "summary": "Creates a Draft for the resource", "operationId": "post_resource_drafts_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DraftsEntrypointDraft-load" } } }, "required": true }, "tags": [ "Entrypoints" ] }, "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DraftPage" } } } } }, "summary": "Gets the Drafts for the resource", "operationId": "get_resource_drafts_endpoint", "parameters": [ { "name": "draftType", "in": "query", "description": "The type of drafts to return: all, existing, or new.", "schema": { "type": "string" } }, { "name": "groupId", "in": "query", "description": "Filter results by the Group ID.", "schema": { "type": "integer" } }, { "name": "index", "in": "query", "description": "Starting index of the current page.", "schema": { "type": "integer" } }, { "name": "pageLength", "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Entrypoints" ] } }, "/api/v1/entrypoints/drafts/{draftId}": { "parameters": [ { "in": "path", "description": "ID for the Draft of the Entry Point resource.", "name": "draftId", "required": true, "schema": { "type": "integer" } } ], "put": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Draft-dump" } } } } }, "summary": "Modifies a Draft for the resource", "operationId": "put_resources_drafts_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DraftsIdEntrypointDraft-load" } } }, "required": true }, "tags": [ "Entrypoints" ] }, "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Draft-dump" } } } } }, "summary": "Gets a Draft for the resource", "operationId": "get_resources_drafts_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Entrypoints" ] }, "delete": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdStatusResponse" } } } } }, "summary": "Deletes a Draft for the resource", "operationId": "delete_resources_drafts_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Entrypoints" ] } }, "/api/v1/entrypoints/{id}": { "parameters": [ { "in": "path", "description": "ID for the Entrypoint resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "put": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entrypoint-dump" } } } } }, "summary": "Modifies an Entrypoint resource by its unique ID", "operationId": "put_entrypoint_id_endpoint", "parameters": [ { "name": "validateOnly", "in": "query", "description": "Flag indicating whether to perform a full validation and save the entrypoint, or perform a lighter validation and not save the entrypoint.", "schema": { "type": "boolean" } }, { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntrypointMutableFields-load" } } }, "required": true }, "tags": [ "Entrypoints" ] }, "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entrypoint-dump" } } } } }, "summary": "Gets an Entrypoint resource by its unique ID", "operationId": "get_entrypoint_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Entrypoints" ] }, "delete": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdStatusResponse" } } } } }, "summary": "Deletes an Entrypoint resource by its unique ID", "operationId": "delete_entrypoint_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Entrypoints" ] } }, "/api/v1/entrypoints/{id}/artifactPlugins": { "parameters": [ { "in": "path", "description": "ID for the Entrypoint resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "post": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EntrypointPlugin" } } } } } }, "summary": "Appends artifact plugins to an entrypoint resource", "operationId": "post_entrypoint_id_artifact_plugins_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntrypointArtifactPluginMutableFields-load" } } }, "required": true }, "tags": [ "Entrypoints" ] }, "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EntrypointPlugin" } } } } } }, "summary": "Retrieves the artifact plugin snapshots for an entrypoint resource", "operationId": "get_entrypoint_id_artifact_plugins_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Entrypoints" ] } }, "/api/v1/entrypoints/{id}/artifactPlugins/{artifactPluginId}": { "parameters": [ { "in": "path", "description": "ID for the Artifact Plugin resource.", "name": "artifactPluginId", "required": true, "schema": { "type": "integer" } }, { "in": "path", "description": "ID for the Entrypoint resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntrypointPlugin" } } } } }, "summary": "Retrieves a artifact plugin snapshot for an entrypoint resource", "operationId": "get_entrypoint_id_artifact_plugin_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Entrypoints" ] }, "delete": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdStatusResponse" } } } } }, "summary": "Removes a artifact plugin from an entrypoint by ID", "operationId": "delete_entrypoint_id_artifact_plugin_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Entrypoints" ] } }, "/api/v1/entrypoints/{id}/draft": { "parameters": [ { "in": "path", "description": "ID for the resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "put": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Draft-dump" } } } } }, "summary": "Modifies the Draft for this resource", "operationId": "put_resources_id_draft_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModifyDraftEntrypointDraft" } } }, "required": true }, "tags": [ "Entrypoints" ] }, "post": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Draft-dump" } } } } }, "summary": "Creates a Draft for this resource", "operationId": "post_resources_id_draft_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDraftEntrypointDraft-load" } } }, "required": true }, "tags": [ "Entrypoints" ] }, "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Draft-dump" } } } } }, "summary": "Gets the Draft for this resource", "operationId": "get_resources_id_draft_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Entrypoints" ] }, "delete": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdStatusResponse" } } } } }, "summary": "Deletes the Draft for this resource", "operationId": "delete_resources_id_draft_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Entrypoints" ] } }, "/api/v1/entrypoints/{id}/plugins": { "parameters": [ { "in": "path", "description": "ID for the Entrypoint resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "post": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EntrypointPlugin" } } } } } }, "summary": "Appends plugins to an entrypoint resource", "operationId": "post_entrypoint_id_plugins_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntrypointPluginMutableFields-load" } } }, "required": true }, "tags": [ "Entrypoints" ] }, "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EntrypointPlugin" } } } } } }, "summary": "Retrieves the plugin snapshots for an entrypoint resource", "operationId": "get_entrypoint_id_plugins_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Entrypoints" ] } }, "/api/v1/entrypoints/{id}/plugins/{pluginId}": { "parameters": [ { "in": "path", "description": "ID for the Plugin resource.", "name": "pluginId", "required": true, "schema": { "type": "integer" } }, { "in": "path", "description": "ID for the Entrypoint resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntrypointPlugin" } } } } }, "summary": "Retrieves a plugin snapshot for an entrypoint resource", "operationId": "get_entrypoint_id_plugins_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Entrypoints" ] }, "delete": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdStatusResponse" } } } } }, "summary": "Removes a plugin from an entrypoint by ID", "operationId": "delete_entrypoint_id_plugins_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Entrypoints" ] } }, "/api/v1/entrypoints/{id}/queues": { "parameters": [ { "in": "path", "description": "ID for the Entrypoint resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "put": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QueueRef-dump" } } } } } }, "summary": "Replaces one or more Queues to the resource", "operationId": "put_entrypoint_id_queues_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "$ref": "#/components/requestBodies/IdList" }, "tags": [ "Entrypoints" ] }, "post": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QueueRef-dump" } } } } } }, "summary": "Appends one or more Queues to the resource", "operationId": "post_entrypoint_id_queues_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "$ref": "#/components/requestBodies/IdList" }, "tags": [ "Entrypoints" ] }, "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QueueRef-dump" } } } } } }, "summary": "Gets the list of Queues for the resource", "operationId": "get_entrypoint_id_queues_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Entrypoints" ] }, "delete": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdStatusResponse" } } } } }, "summary": "Removes all Queues from the resource", "operationId": "delete_entrypoint_id_queues_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Entrypoints" ] } }, "/api/v1/entrypoints/{id}/queues/{queueId}": { "parameters": [ { "in": "path", "description": "ID for the Queue resource.", "name": "queueId", "required": true, "schema": { "type": "integer" } }, { "in": "path", "description": "ID for the Entrypoint resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "delete": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdStatusResponse" } } } } }, "summary": "Removes a Queue from the Entrypoint resource", "operationId": "delete_entrypoint_id_queues_id", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Entrypoints" ] } }, "/api/v1/entrypoints/{id}/snapshots": { "parameters": [ { "in": "path", "description": "ID for the EntityType.ENTRY_POINT resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SnapshotsEntrypointPage" } } } } }, "summary": "Gets the Snapshots for the resource", "operationId": "get_resource_snapshots_endpoint", "parameters": [ { "name": "search", "in": "query", "description": "Search terms for the query (* and ? wildcards).", "schema": { "type": "string" } }, { "name": "index", "in": "query", "description": "Starting index of the current page.", "schema": { "type": "integer" } }, { "name": "pageLength", "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Entrypoints" ] } }, "/api/v1/entrypoints/{id}/snapshots/{snapshotId}": { "parameters": [ { "in": "path", "description": "Snapshot ID for the EntityType.ENTRY_POINT resource.", "name": "snapshotId", "required": true, "schema": { "type": "integer" } }, { "in": "path", "description": "ID for the EntityType.ENTRY_POINT resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SnapshotsIdEntrypoint-dump" } } } } }, "summary": "Gets a Snapshot for the resource by snapshot id", "operationId": "get_resources_snapshots_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Entrypoints" ] } }, "/api/v1/entrypoints/{id}/snapshots/{snapshotId}/artifactPlugins": { "parameters": [ { "in": "path", "description": "Snapshot ID for the Entrypoint snapshot.", "name": "snapshotId", "required": true, "schema": { "type": "integer" } }, { "in": "path", "description": "ID for the Entrypoint resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EntrypointPlugin" } } } } } }, "summary": "Retrieves the artifact plugin snapshots for an entrypoint resource", "operationId": "get_entrypoint_snapshot_id_artifact_plugins_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Entrypoints" ] } }, "/api/v1/entrypoints/{id}/snapshots/{snapshotId}/artifactPlugins/bundle": { "parameters": [ { "in": "path", "description": "Snapshot ID for the Entrypoint resource.", "name": "snapshotId", "required": true, "schema": { "type": "integer" } }, { "in": "path", "description": "ID for the Entrypoint resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "get": { "responses": { "200": { "description": "Success" } }, "summary": "Returns a file bundle containing all of the ArtifactPlugin PluginFile", "description": "resources for an EntryPoint Snapshot resource.", "operationId": "get_entry_point_snapshot_artifact_bundle_endpoint", "parameters": [ { "name": "fileType", "in": "query", "description": "The type of file to download: tar_gz or zip.", "schema": { "type": "string" } } ], "tags": [ "Entrypoints" ] } }, "/api/v1/entrypoints/{id}/snapshots/{snapshotId}/config": { "parameters": [ { "in": "path", "description": "Snapshot ID for the entrypoint resource.", "name": "snapshotId", "required": true, "schema": { "type": "integer" } }, { "in": "path", "description": "ID for the entrypoint resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntrypointConfigResponse" } } } } }, "operationId": "get_entry_point_snapshot_config_endpoint", "parameters": [ { "name": "swaps", "in": "query", "description": "A list of swap choices to be applied to the entrypoint task graph.", "schema": { "type": "string" } }, { "name": "sections", "in": "query", "description": "A list of sections to include in the response.", "schema": { "type": "string" } }, { "name": "partial", "in": "query", "description": "If true, allow partial rendering of the task graph from this endpoint.", "schema": { "type": "boolean" } }, { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Entrypoints" ] } }, "/api/v1/entrypoints/{id}/snapshots/{snapshotId}/dynamicGlobalParameters": { "parameters": [ { "in": "path", "description": "Snapshot ID for the Entrypoint snapshot.", "name": "snapshotId", "required": true, "schema": { "type": "integer" } }, { "in": "path", "description": "ID for the Entrypoint resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DynamicGlobalParametersResponse" } } } } }, "summary": "Finds the global parameters for the given entrypoint + swap choice dictionary", "operationId": "get_dynamic_global_parameters_entrypoint", "parameters": [ { "name": "swaps", "in": "query", "description": "A list of swap choices to be applied to the entrypoint task graph.", "schema": { "type": "string" } }, { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Entrypoints" ] } }, "/api/v1/entrypoints/{id}/snapshots/{snapshotId}/plugins/bundle": { "parameters": [ { "in": "path", "description": "Snapshot ID for the Entrypoint resource.", "name": "snapshotId", "required": true, "schema": { "type": "integer" } }, { "in": "path", "description": "ID for the Entrypoint resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "get": { "responses": { "200": { "description": "Success" } }, "summary": "Returns a file bundle containing all of the PluginFile resources for an", "description": "EntryPoint Snapshot resource.", "operationId": "get_entry_point_snapshot_plugin_bundle_endpoint", "parameters": [ { "name": "fileType", "in": "query", "description": "The type of file to download: tar_gz or zip.", "schema": { "type": "string" } } ], "tags": [ "Entrypoints" ] } }, "/api/v1/entrypoints/{id}/snapshots/{snapshotId}/swaps": { "parameters": [ { "in": "path", "description": "Snapshot ID for the Entrypoint resource.", "name": "snapshotId", "required": true, "schema": { "type": "integer" } }, { "in": "path", "description": "ID for the Entrypoint resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SwapInfo" } } } } } }, "summary": "Retrieve available swaps for a given entrypoint snapshot", "operationId": "get_swaps_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Entrypoints" ] } }, "/api/v1/entrypoints/{id}/tags": { "parameters": [ { "in": "path", "description": "ID for the entry_point.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "put": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TagRef-dump" } } } } } }, "summary": "Replaces one or more Tags to the resource", "operationId": "put_resources_tags_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "$ref": "#/components/requestBodies/IdList" }, "tags": [ "Entrypoints" ] }, "post": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TagRef-dump" } } } } } }, "summary": "Appends one or more Tags to the resource", "operationId": "post_resources_tags_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "$ref": "#/components/requestBodies/IdList" }, "tags": [ "Entrypoints" ] }, "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TagRef-dump" } } } } } }, "summary": "Gets the list of Tags for the resource", "operationId": "get_resources_tags_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Entrypoints" ] }, "delete": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdStatusResponse" } } } } }, "summary": "Removes all Tags from the resource", "operationId": "delete_resources_tags_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Entrypoints" ] } }, "/api/v1/entrypoints/{id}/tags/{tagId}": { "parameters": [ { "in": "path", "description": "ID for the Tag.", "name": "tagId", "required": true, "schema": { "type": "integer" } }, { "in": "path", "description": "ID for the entry_point.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "delete": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdStatusResponse" } } } } }, "summary": "Removes a Tag from the resource", "operationId": "delete_resources_tags_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Entrypoints" ] } }, "/api/v1/experiments/": { "post": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Experiment-dump" } } } } }, "summary": "Creates an Experiment resource with a provided name", "operationId": "post_experiment_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Experiment-load" } } }, "required": true }, "tags": [ "Experiments" ] }, "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExperimentPage" } } } } }, "summary": "Gets a page of Experiment resources matching the filter parameters", "operationId": "get_experiment_endpoint", "parameters": [ { "name": "showDeleted", "in": "query", "description": "Boolean indicating whether to include deleted resources in the results.", "schema": { "type": "boolean" } }, { "name": "sortBy", "in": "query", "description": "The name of the column to sort.", "schema": { "type": "string" } }, { "name": "descending", "in": "query", "description": "Boolean indicating whether to sort by descending or not.", "schema": { "type": "boolean" } }, { "name": "search", "in": "query", "description": "Search terms for the query (* and ? wildcards).", "schema": { "type": "string" } }, { "name": "groupId", "in": "query", "description": "Filter results by the Group ID.", "schema": { "type": "integer" } }, { "name": "index", "in": "query", "description": "Starting index of the current page.", "schema": { "type": "integer" } }, { "name": "pageLength", "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Experiments" ] } }, "/api/v1/experiments/drafts/": { "post": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Draft-dump" } } } } }, "summary": "Creates a Draft for the resource", "operationId": "post_resource_drafts_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DraftsExperimentDraft-load" } } }, "required": true }, "tags": [ "Experiments" ] }, "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DraftPage" } } } } }, "summary": "Gets the Drafts for the resource", "operationId": "get_resource_drafts_endpoint", "parameters": [ { "name": "draftType", "in": "query", "description": "The type of drafts to return: all, existing, or new.", "schema": { "type": "string" } }, { "name": "groupId", "in": "query", "description": "Filter results by the Group ID.", "schema": { "type": "integer" } }, { "name": "index", "in": "query", "description": "Starting index of the current page.", "schema": { "type": "integer" } }, { "name": "pageLength", "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Experiments" ] } }, "/api/v1/experiments/drafts/{draftId}": { "parameters": [ { "in": "path", "description": "ID for the Draft of the Experiment resource.", "name": "draftId", "required": true, "schema": { "type": "integer" } } ], "put": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Draft-dump" } } } } }, "summary": "Modifies a Draft for the resource", "operationId": "put_resources_drafts_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DraftsIdExperimentDraft-load" } } }, "required": true }, "tags": [ "Experiments" ] }, "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Draft-dump" } } } } }, "summary": "Gets a Draft for the resource", "operationId": "get_resources_drafts_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Experiments" ] }, "delete": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdStatusResponse" } } } } }, "summary": "Deletes a Draft for the resource", "operationId": "delete_resources_drafts_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Experiments" ] } }, "/api/v1/experiments/{id}": { "parameters": [ { "in": "path", "description": "ID for the Experiment resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "put": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Experiment-dump" } } } } }, "summary": "Modifies an experiment by its unique identifier", "operationId": "put_experiment_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExperimentMutableFields-load" } } }, "required": true }, "tags": [ "Experiments" ] }, "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Experiment-dump" } } } } }, "summary": "Gets an experiment by its unique identifier", "operationId": "get_experiment_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Experiments" ] }, "delete": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdStatusResponse" } } } } }, "summary": "Deletes an experiment by its unique identifier", "operationId": "delete_experiment_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Experiments" ] } }, "/api/v1/experiments/{id}/draft": { "parameters": [ { "in": "path", "description": "ID for the resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "put": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Draft-dump" } } } } }, "summary": "Modifies the Draft for this resource", "operationId": "put_resources_id_draft_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModifyDraftExperimentDraft" } } }, "required": true }, "tags": [ "Experiments" ] }, "post": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Draft-dump" } } } } }, "summary": "Creates a Draft for this resource", "operationId": "post_resources_id_draft_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDraftExperimentDraft-load" } } }, "required": true }, "tags": [ "Experiments" ] }, "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Draft-dump" } } } } }, "summary": "Gets the Draft for this resource", "operationId": "get_resources_id_draft_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Experiments" ] }, "delete": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdStatusResponse" } } } } }, "summary": "Deletes the Draft for this resource", "operationId": "delete_resources_id_draft_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Experiments" ] } }, "/api/v1/experiments/{id}/entrypoints": { "parameters": [ { "in": "path", "description": "ID for the Experiment resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "put": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EntrypointRef-dump" } } } } } }, "summary": "Replaces one or more Entrypoints to the resource", "operationId": "put_experiment_id_entrypoints_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "$ref": "#/components/requestBodies/IdList" }, "tags": [ "Experiments" ] }, "post": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EntrypointRef-dump" } } } } } }, "summary": "Appends one or more Entrypoints to the resource", "operationId": "post_experiment_id_entrypoints_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "$ref": "#/components/requestBodies/IdList" }, "tags": [ "Experiments" ] }, "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EntrypointRef-dump" } } } } } }, "summary": "Gets the list of Entrypoints for the resource", "operationId": "get_experiment_id_entrypoints_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Experiments" ] }, "delete": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdStatusResponse" } } } } }, "summary": "Removes all Entrypoints from the resource", "operationId": "delete_experiment_id_entrypoints_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Experiments" ] } }, "/api/v1/experiments/{id}/entrypoints/{entrypointId}": { "parameters": [ { "in": "path", "description": "ID for the Entrypoint resource.", "name": "entrypointId", "required": true, "schema": { "type": "integer" } }, { "in": "path", "description": "ID for the Experiment resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "delete": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdStatusResponse" } } } } }, "summary": "Removes a Entrypoint from the Experiment resource", "operationId": "delete_experiment_id_entrypoints_id", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Experiments" ] } }, "/api/v1/experiments/{id}/jobs": { "parameters": [ { "in": "path", "description": "ID for the Experiment resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "post": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job-dump" } } } } }, "summary": "Creates a Job resource under the specified Experiment", "operationId": "post_experiment_id_job_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobCreateRequest-load" } } }, "required": true }, "tags": [ "Experiments" ] }, "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobPage" } } } } }, "summary": "Returns a list of jobs for a specified Experiment", "operationId": "get_experiment_id_job_endpoint", "parameters": [ { "name": "sortBy", "in": "query", "description": "The name of the column to sort.", "schema": { "type": "string" } }, { "name": "descending", "in": "query", "description": "Boolean indicating whether to sort by descending or not.", "schema": { "type": "boolean" } }, { "name": "search", "in": "query", "description": "Search terms for the query (* and ? wildcards).", "schema": { "type": "string" } }, { "name": "index", "in": "query", "description": "Starting index of the current page.", "schema": { "type": "integer" } }, { "name": "pageLength", "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Experiments" ] } }, "/api/v1/experiments/{id}/jobs/{jobId}": { "parameters": [ { "in": "path", "description": "ID for the Job resource.", "name": "jobId", "required": true, "schema": { "type": "integer" } }, { "in": "path", "description": "ID for the Experiment resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job-dump" } } } } }, "summary": "Gets a Job resource", "operationId": "get_experiment_id_job_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Experiments" ] }, "delete": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdStatusResponse" } } } } }, "summary": "Deletes a Job resource", "operationId": "delete_experiment_id_job_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Experiments" ] } }, "/api/v1/experiments/{id}/jobs/{jobId}/mlflowRun": { "parameters": [ { "in": "path", "description": "ID for the Job resource.", "name": "jobId", "required": true, "schema": { "type": "integer" } }, { "in": "path", "description": "ID for the Experiment resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "post": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobMlflowRun" } } } } }, "summary": "Sets the mlflow run id for a Job", "operationId": "post_experiment_id_job_id_mlflowrun_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "$ref": "#/components/requestBodies/JobMlflowRun" }, "tags": [ "Experiments" ] }, "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobMlflowRun" } } } } }, "summary": "Gets a Job resource's mlflow run id", "operationId": "get_experiment_id_job_id_mlflowrun_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Experiments" ] } }, "/api/v1/experiments/{id}/jobs/{jobId}/status": { "parameters": [ { "in": "path", "description": "ID for the Job resource.", "name": "jobId", "required": true, "schema": { "type": "integer" } }, { "in": "path", "description": "ID for the Experiment resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobStatus-dump" } } } } }, "summary": "Gets a Job resource's status", "operationId": "get_experiment_id_job_id_status_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Experiments" ] }, "put": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobStatus-dump" } } } } }, "summary": "Modifies a Job resource's status", "operationId": "put_experiment_id_job_id_status_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobStatus-load" } } }, "required": true }, "tags": [ "Experiments" ] } }, "/api/v1/experiments/{id}/metrics": { "parameters": [ { "in": "path", "description": "ID for the Experiment resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExperimentJobsMetrics" } } } } }, "summary": "Gets all of the latest metrics for every job in the experiment", "operationId": "get_experiment_id_metrics_endpoint", "parameters": [ { "name": "sortBy", "in": "query", "description": "The name of the column to sort.", "schema": { "type": "string" } }, { "name": "descending", "in": "query", "description": "Boolean indicating whether to sort by descending or not.", "schema": { "type": "boolean" } }, { "name": "search", "in": "query", "description": "Search terms for the query (* and ? wildcards).", "schema": { "type": "string" } }, { "name": "index", "in": "query", "description": "Starting index of the current page.", "schema": { "type": "integer" } }, { "name": "pageLength", "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Experiments" ] } }, "/api/v1/experiments/{id}/snapshots": { "parameters": [ { "in": "path", "description": "ID for the EntityType.EXPERIMENT resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SnapshotsExperimentPage" } } } } }, "summary": "Gets the Snapshots for the resource", "operationId": "get_resource_snapshots_endpoint", "parameters": [ { "name": "search", "in": "query", "description": "Search terms for the query (* and ? wildcards).", "schema": { "type": "string" } }, { "name": "index", "in": "query", "description": "Starting index of the current page.", "schema": { "type": "integer" } }, { "name": "pageLength", "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Experiments" ] } }, "/api/v1/experiments/{id}/snapshots/{snapshotId}": { "parameters": [ { "in": "path", "description": "Snapshot ID for the EntityType.EXPERIMENT resource.", "name": "snapshotId", "required": true, "schema": { "type": "integer" } }, { "in": "path", "description": "ID for the EntityType.EXPERIMENT resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SnapshotsIdExperiment-dump" } } } } }, "summary": "Gets a Snapshot for the resource by snapshot id", "operationId": "get_resources_snapshots_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Experiments" ] } }, "/api/v1/experiments/{id}/tags": { "parameters": [ { "in": "path", "description": "ID for the experiment.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "put": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TagRef-dump" } } } } } }, "summary": "Replaces one or more Tags to the resource", "operationId": "put_resources_tags_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "$ref": "#/components/requestBodies/IdList" }, "tags": [ "Experiments" ] }, "post": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TagRef-dump" } } } } } }, "summary": "Appends one or more Tags to the resource", "operationId": "post_resources_tags_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "$ref": "#/components/requestBodies/IdList" }, "tags": [ "Experiments" ] }, "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TagRef-dump" } } } } } }, "summary": "Gets the list of Tags for the resource", "operationId": "get_resources_tags_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Experiments" ] }, "delete": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdStatusResponse" } } } } }, "summary": "Removes all Tags from the resource", "operationId": "delete_resources_tags_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Experiments" ] } }, "/api/v1/experiments/{id}/tags/{tagId}": { "parameters": [ { "in": "path", "description": "ID for the Tag.", "name": "tagId", "required": true, "schema": { "type": "integer" } }, { "in": "path", "description": "ID for the experiment.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "delete": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdStatusResponse" } } } } }, "summary": "Removes a Tag from the resource", "operationId": "delete_resources_tags_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Experiments" ] } }, "/api/v1/groups/": { "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupPage" } } } } }, "summary": "Gets a list of all Group resources", "operationId": "get_group_endpoint", "parameters": [ { "name": "search", "in": "query", "description": "Search terms for the query (* and ? wildcards).", "schema": { "type": "string" } }, { "name": "index", "in": "query", "description": "Starting index of the current page.", "schema": { "type": "integer" } }, { "name": "pageLength", "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Groups" ] } }, "/api/v1/groups/{id}": { "parameters": [ { "in": "path", "description": "ID for the Group resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group-dump" } } } } }, "summary": "Gets a Group resource", "operationId": "get_group_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Groups" ] } }, "/api/v1/jobs/": { "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobPage" } } } } }, "summary": "Gets a list of all Job resources", "operationId": "get_job_endpoint", "parameters": [ { "name": "sortBy", "in": "query", "description": "The name of the column to sort.", "schema": { "type": "string" } }, { "name": "descending", "in": "query", "description": "Boolean indicating whether to sort by descending or not.", "schema": { "type": "boolean" } }, { "name": "search", "in": "query", "description": "Search terms for the query (* and ? wildcards).", "schema": { "type": "string" } }, { "name": "groupId", "in": "query", "description": "Filter results by the Group ID.", "schema": { "type": "integer" } }, { "name": "index", "in": "query", "description": "Starting index of the current page.", "schema": { "type": "integer" } }, { "name": "pageLength", "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Job" ] } }, "/api/v1/jobs/{id}": { "parameters": [ { "in": "path", "description": "ID for the Job resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job-dump" } } } } }, "summary": "Gets a Job resource", "operationId": "get_job_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Job" ] }, "delete": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdStatusResponse" } } } } }, "summary": "Deletes a Job resource", "operationId": "delete_job_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Job" ] } }, "/api/v1/jobs/{id}/artifactParameters": { "parameters": [ { "in": "path", "description": "ID for the Job resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "get": { "responses": { "200": { "description": "Success" } }, "operationId": "get_job_id_artifact_parameters_endpoint", "tags": [ "Job" ] } }, "/api/v1/jobs/{id}/config": { "parameters": [ { "in": "path", "description": "ID for the Job resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobConfig" } } } } }, "summary": "Return the YAML configuration dictionary for the specified Job", "operationId": "get_job_config_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Job" ] } }, "/api/v1/jobs/{id}/log": { "parameters": [ { "in": "path", "description": "ID for the Job resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "post": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JobLogRecord-dump" } } } } } }, "operationId": "post_job_id_log_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobLogRecords" } } }, "required": true }, "tags": [ "Job" ] }, "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobLogRecordsPage" } } } } }, "operationId": "get_job_id_log_endpoint", "parameters": [ { "name": "search", "in": "query", "description": "Search terms for the query (* and ? wildcards).", "schema": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "The name of the column to sort.", "schema": { "type": "string" } }, { "name": "descending", "in": "query", "description": "Boolean indicating whether to sort by descending or not.", "schema": { "type": "boolean" } }, { "name": "index", "in": "query", "description": "Starting index of the current page.", "schema": { "type": "integer" } }, { "name": "pageLength", "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "severity", "in": "query", "description": "List of severities to filter by", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Job" ] } }, "/api/v1/jobs/{id}/metrics": { "parameters": [ { "in": "path", "description": "ID for the Job resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "post": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Metrics-dump" } } } } }, "summary": "Sets a metric for a Job", "operationId": "post_job_id_metrics_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Metrics-load" } } }, "required": true }, "tags": [ "Job" ] }, "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Metrics-dump" } } } } } }, "summary": "Gets a Job resource's latest metrics", "operationId": "get_job_id_metrics_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Job" ] } }, "/api/v1/jobs/{id}/metrics/{name}/snapshots": { "parameters": [ { "in": "path", "description": "Name of the metric.", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "path", "description": "ID for the Job resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricsSnapshotPage" } } } } }, "summary": "Gets a Job resource's metric history", "operationId": "get_job_id_metrics_snapshots_endpoint", "parameters": [ { "name": "index", "in": "query", "description": "Starting index of the current page.", "schema": { "type": "integer" } }, { "name": "pageLength", "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Job" ] } }, "/api/v1/jobs/{id}/mlflowRun": { "parameters": [ { "in": "path", "description": "ID for the Job resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "post": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobMlflowRun" } } } } }, "summary": "Sets the mlflow run id for a Job", "operationId": "post_job_id_mlflowrun_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "$ref": "#/components/requestBodies/JobMlflowRun" }, "tags": [ "Job" ] }, "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobMlflowRun" } } } } }, "summary": "Gets a Job resource's mlflow run id", "operationId": "get_job_id_mlflowrun_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Job" ] } }, "/api/v1/jobs/{id}/parameters": { "parameters": [ { "in": "path", "description": "ID for the Job resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "get": { "responses": { "200": { "description": "Success" } }, "operationId": "get_job_id_parameters_endpoint", "tags": [ "Job" ] } }, "/api/v1/jobs/{id}/snapshots": { "parameters": [ { "in": "path", "description": "ID for the EntityType.JOB resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SnapshotsJobPage" } } } } }, "summary": "Gets the Snapshots for the resource", "operationId": "get_resource_snapshots_endpoint", "parameters": [ { "name": "search", "in": "query", "description": "Search terms for the query (* and ? wildcards).", "schema": { "type": "string" } }, { "name": "index", "in": "query", "description": "Starting index of the current page.", "schema": { "type": "integer" } }, { "name": "pageLength", "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Job" ] } }, "/api/v1/jobs/{id}/snapshots/{snapshotId}": { "parameters": [ { "in": "path", "description": "Snapshot ID for the EntityType.JOB resource.", "name": "snapshotId", "required": true, "schema": { "type": "integer" } }, { "in": "path", "description": "ID for the EntityType.JOB resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SnapshotsIdJob-dump" } } } } }, "summary": "Gets a Snapshot for the resource by snapshot id", "operationId": "get_resources_snapshots_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Job" ] } }, "/api/v1/jobs/{id}/status": { "parameters": [ { "in": "path", "description": "ID for the Job resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobStatus-dump" } } } } }, "summary": "Gets a Job resource's status", "operationId": "get_job_id_status_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Job" ] } }, "/api/v1/jobs/{id}/tags": { "parameters": [ { "in": "path", "description": "ID for the job.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "put": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TagRef-dump" } } } } } }, "summary": "Replaces one or more Tags to the resource", "operationId": "put_resources_tags_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "$ref": "#/components/requestBodies/IdList" }, "tags": [ "Job" ] }, "post": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TagRef-dump" } } } } } }, "summary": "Appends one or more Tags to the resource", "operationId": "post_resources_tags_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "$ref": "#/components/requestBodies/IdList" }, "tags": [ "Job" ] }, "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TagRef-dump" } } } } } }, "summary": "Gets the list of Tags for the resource", "operationId": "get_resources_tags_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Job" ] }, "delete": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdStatusResponse" } } } } }, "summary": "Removes all Tags from the resource", "operationId": "delete_resources_tags_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Job" ] } }, "/api/v1/jobs/{id}/tags/{tagId}": { "parameters": [ { "in": "path", "description": "ID for the Tag.", "name": "tagId", "required": true, "schema": { "type": "integer" } }, { "in": "path", "description": "ID for the job.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "delete": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdStatusResponse" } } } } }, "summary": "Removes a Tag from the resource", "operationId": "delete_resources_tags_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Job" ] } }, "/api/v1/models/": { "post": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Model-dump" } } } } }, "summary": "Creates a Model resource", "operationId": "post_model_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Model-load" } } }, "required": true }, "tags": [ "Models" ] }, "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelPage" } } } } }, "summary": "Gets a list of all Model resources", "operationId": "get_model_endpoint", "parameters": [ { "name": "sortBy", "in": "query", "description": "The name of the column to sort.", "schema": { "type": "string" } }, { "name": "descending", "in": "query", "description": "Boolean indicating whether to sort by descending or not.", "schema": { "type": "boolean" } }, { "name": "search", "in": "query", "description": "Search terms for the query (* and ? wildcards).", "schema": { "type": "string" } }, { "name": "groupId", "in": "query", "description": "Filter results by the Group ID.", "schema": { "type": "integer" } }, { "name": "index", "in": "query", "description": "Starting index of the current page.", "schema": { "type": "integer" } }, { "name": "pageLength", "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Models" ] } }, "/api/v1/models/drafts/": { "post": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Draft-dump" } } } } }, "summary": "Creates a Draft for the resource", "operationId": "post_resource_drafts_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DraftsModel-load" } } }, "required": true }, "tags": [ "Models" ] }, "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DraftPage" } } } } }, "summary": "Gets the Drafts for the resource", "operationId": "get_resource_drafts_endpoint", "parameters": [ { "name": "draftType", "in": "query", "description": "The type of drafts to return: all, existing, or new.", "schema": { "type": "string" } }, { "name": "groupId", "in": "query", "description": "Filter results by the Group ID.", "schema": { "type": "integer" } }, { "name": "index", "in": "query", "description": "Starting index of the current page.", "schema": { "type": "integer" } }, { "name": "pageLength", "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Models" ] } }, "/api/v1/models/drafts/{draftId}": { "parameters": [ { "in": "path", "description": "ID for the Draft of the ML Model resource.", "name": "draftId", "required": true, "schema": { "type": "integer" } } ], "put": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Draft-dump" } } } } }, "summary": "Modifies a Draft for the resource", "operationId": "put_resources_drafts_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DraftsIdModel-load" } } }, "required": true }, "tags": [ "Models" ] }, "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Draft-dump" } } } } }, "summary": "Gets a Draft for the resource", "operationId": "get_resources_drafts_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Models" ] }, "delete": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdStatusResponse" } } } } }, "summary": "Deletes a Draft for the resource", "operationId": "delete_resources_drafts_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Models" ] } }, "/api/v1/models/{id}": { "parameters": [ { "in": "path", "description": "ID for the Model resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "put": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Model-dump" } } } } }, "summary": "Modifies a Model resource", "operationId": "put_model_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelMutableFields" } } }, "required": true }, "tags": [ "Models" ] }, "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Model-dump" } } } } }, "summary": "Gets a Model resource", "operationId": "get_model_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Models" ] }, "delete": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdStatusResponse" } } } } }, "summary": "Deletes a Model resource", "operationId": "delete_model_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Models" ] } }, "/api/v1/models/{id}/draft": { "parameters": [ { "in": "path", "description": "ID for the resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "put": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Draft-dump" } } } } }, "summary": "Modifies the Draft for this resource", "operationId": "put_resources_id_draft_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModifyDraftModel" } } }, "required": true }, "tags": [ "Models" ] }, "post": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Draft-dump" } } } } }, "summary": "Creates a Draft for this resource", "operationId": "post_resources_id_draft_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDraftModel-load" } } }, "required": true }, "tags": [ "Models" ] }, "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Draft-dump" } } } } }, "summary": "Gets the Draft for this resource", "operationId": "get_resources_id_draft_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Models" ] }, "delete": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdStatusResponse" } } } } }, "summary": "Deletes the Draft for this resource", "operationId": "delete_resources_id_draft_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Models" ] } }, "/api/v1/models/{id}/snapshots": { "parameters": [ { "in": "path", "description": "ID for the EntityType.ML_MODEL resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SnapshotsModelPage" } } } } }, "summary": "Gets the Snapshots for the resource", "operationId": "get_resource_snapshots_endpoint", "parameters": [ { "name": "search", "in": "query", "description": "Search terms for the query (* and ? wildcards).", "schema": { "type": "string" } }, { "name": "index", "in": "query", "description": "Starting index of the current page.", "schema": { "type": "integer" } }, { "name": "pageLength", "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Models" ] } }, "/api/v1/models/{id}/snapshots/{snapshotId}": { "parameters": [ { "in": "path", "description": "Snapshot ID for the EntityType.ML_MODEL resource.", "name": "snapshotId", "required": true, "schema": { "type": "integer" } }, { "in": "path", "description": "ID for the EntityType.ML_MODEL resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SnapshotsIdModel-dump" } } } } }, "summary": "Gets a Snapshot for the resource by snapshot id", "operationId": "get_resources_snapshots_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Models" ] } }, "/api/v1/models/{id}/tags": { "parameters": [ { "in": "path", "description": "ID for the ml_model.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "put": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TagRef-dump" } } } } } }, "summary": "Replaces one or more Tags to the resource", "operationId": "put_resources_tags_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "$ref": "#/components/requestBodies/IdList" }, "tags": [ "Models" ] }, "post": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TagRef-dump" } } } } } }, "summary": "Appends one or more Tags to the resource", "operationId": "post_resources_tags_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "$ref": "#/components/requestBodies/IdList" }, "tags": [ "Models" ] }, "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TagRef-dump" } } } } } }, "summary": "Gets the list of Tags for the resource", "operationId": "get_resources_tags_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Models" ] }, "delete": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdStatusResponse" } } } } }, "summary": "Removes all Tags from the resource", "operationId": "delete_resources_tags_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Models" ] } }, "/api/v1/models/{id}/tags/{tagId}": { "parameters": [ { "in": "path", "description": "ID for the Tag.", "name": "tagId", "required": true, "schema": { "type": "integer" } }, { "in": "path", "description": "ID for the ml_model.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "delete": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdStatusResponse" } } } } }, "summary": "Removes a Tag from the resource", "operationId": "delete_resources_tags_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Models" ] } }, "/api/v1/models/{id}/versions": { "parameters": [ { "in": "path", "description": "ID for the Models resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "post": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelVersion-dump" } } } } }, "summary": "Creates a new version of the model resource", "operationId": "post_model_id_versions_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelVersion-load" } } }, "required": true }, "tags": [ "Models" ] }, "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelVersionPage" } } } } }, "summary": "Gets a list of versions of this Model resource", "operationId": "get_model_id_versions_endpoint", "parameters": [ { "name": "search", "in": "query", "description": "Search terms for the query (* and ? wildcards).", "schema": { "type": "string" } }, { "name": "index", "in": "query", "description": "Starting index of the current page.", "schema": { "type": "integer" } }, { "name": "pageLength", "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Models" ] } }, "/api/v1/models/{id}/versions/{versionNumber}": { "parameters": [ { "in": "path", "description": "Version number for the Model resource.", "name": "versionNumber", "required": true, "schema": { "type": "integer" } }, { "in": "path", "description": "ID for the Model resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelVersion-dump" } } } } }, "summary": "Gets a specific version of a model by version number", "operationId": "get_model_id_versions_number_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Models" ] }, "put": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelVersion-dump" } } } } }, "summary": "Modifies specific version of the model resource", "operationId": "put_model_id_versions_number_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelVersionMutableFields" } } }, "required": true }, "tags": [ "Models" ] } }, "/api/v1/pluginParameterTypes/": { "post": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PluginParameterType-dump" } } } } }, "summary": "Creates a PluginParameterType resource", "operationId": "post_plugin_parameter_type_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PluginParameterType-load" } } }, "required": true }, "tags": [ "PluginParameterTypes" ] }, "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PluginParameterTypePage" } } } } }, "summary": "Gets a list of all PluginParameterType resources", "operationId": "get_plugin_parameter_type_endpoint", "parameters": [ { "name": "showDeleted", "in": "query", "description": "Boolean indicating whether to include deleted resources in the results.", "schema": { "type": "boolean" } }, { "name": "sortBy", "in": "query", "description": "The name of the column to sort.", "schema": { "type": "string" } }, { "name": "descending", "in": "query", "description": "Boolean indicating whether to sort by descending or not.", "schema": { "type": "boolean" } }, { "name": "search", "in": "query", "description": "Search terms for the query (* and ? wildcards).", "schema": { "type": "string" } }, { "name": "groupId", "in": "query", "description": "Filter results by the Group ID.", "schema": { "type": "integer" } }, { "name": "index", "in": "query", "description": "Starting index of the current page.", "schema": { "type": "integer" } }, { "name": "pageLength", "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "PluginParameterTypes" ] } }, "/api/v1/pluginParameterTypes/drafts/": { "post": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Draft-dump" } } } } }, "summary": "Creates a Draft for the resource", "operationId": "post_resource_drafts_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DraftsPluginParameterType-load" } } }, "required": true }, "tags": [ "PluginParameterTypes" ] }, "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DraftPage" } } } } }, "summary": "Gets the Drafts for the resource", "operationId": "get_resource_drafts_endpoint", "parameters": [ { "name": "draftType", "in": "query", "description": "The type of drafts to return: all, existing, or new.", "schema": { "type": "string" } }, { "name": "groupId", "in": "query", "description": "Filter results by the Group ID.", "schema": { "type": "integer" } }, { "name": "index", "in": "query", "description": "Starting index of the current page.", "schema": { "type": "integer" } }, { "name": "pageLength", "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "PluginParameterTypes" ] } }, "/api/v1/pluginParameterTypes/drafts/{draftId}": { "parameters": [ { "in": "path", "description": "ID for the Draft of the Plugin Task Parameter Type resource.", "name": "draftId", "required": true, "schema": { "type": "integer" } } ], "put": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Draft-dump" } } } } }, "summary": "Modifies a Draft for the resource", "operationId": "put_resources_drafts_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DraftsIdPluginParameterTypeMutableFields" } } }, "required": true }, "tags": [ "PluginParameterTypes" ] }, "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Draft-dump" } } } } }, "summary": "Gets a Draft for the resource", "operationId": "get_resources_drafts_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "PluginParameterTypes" ] }, "delete": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdStatusResponse" } } } } }, "summary": "Deletes a Draft for the resource", "operationId": "delete_resources_drafts_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "PluginParameterTypes" ] } }, "/api/v1/pluginParameterTypes/{id}": { "parameters": [ { "in": "path", "description": "ID for the PluginParameterType resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "put": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PluginParameterType-dump" } } } } }, "summary": "Modifies a PluginParameterType resource", "operationId": "put_plugin_parameter_type_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PluginParameterTypeMutableFields" } } }, "required": true }, "tags": [ "PluginParameterTypes" ] }, "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PluginParameterType-dump" } } } } }, "summary": "Gets a PluginParameterType resource", "operationId": "get_plugin_parameter_type_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "PluginParameterTypes" ] }, "delete": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdStatusResponse" } } } } }, "summary": "Deletes a PluginParameterType resource", "operationId": "delete_plugin_parameter_type_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "PluginParameterTypes" ] } }, "/api/v1/pluginParameterTypes/{id}/draft": { "parameters": [ { "in": "path", "description": "ID for the resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "put": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Draft-dump" } } } } }, "summary": "Modifies the Draft for this resource", "operationId": "put_resources_id_draft_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModifyDraftPluginParameterTypeMutableFields" } } }, "required": true }, "tags": [ "PluginParameterTypes" ] }, "post": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Draft-dump" } } } } }, "summary": "Creates a Draft for this resource", "operationId": "post_resources_id_draft_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDraftPluginParameterTypeMutableFields" } } }, "required": true }, "tags": [ "PluginParameterTypes" ] }, "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Draft-dump" } } } } }, "summary": "Gets the Draft for this resource", "operationId": "get_resources_id_draft_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "PluginParameterTypes" ] }, "delete": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdStatusResponse" } } } } }, "summary": "Deletes the Draft for this resource", "operationId": "delete_resources_id_draft_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "PluginParameterTypes" ] } }, "/api/v1/pluginParameterTypes/{id}/snapshots": { "parameters": [ { "in": "path", "description": "ID for the EntityType.PLUGIN_TASK_PARAMETER_TYPE resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SnapshotsPluginParameterTypePage" } } } } }, "summary": "Gets the Snapshots for the resource", "operationId": "get_resource_snapshots_endpoint", "parameters": [ { "name": "search", "in": "query", "description": "Search terms for the query (* and ? wildcards).", "schema": { "type": "string" } }, { "name": "index", "in": "query", "description": "Starting index of the current page.", "schema": { "type": "integer" } }, { "name": "pageLength", "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "PluginParameterTypes" ] } }, "/api/v1/pluginParameterTypes/{id}/snapshots/{snapshotId}": { "parameters": [ { "in": "path", "description": "Snapshot ID for the EntityType.PLUGIN_TASK_PARAMETER_TYPE resource.", "name": "snapshotId", "required": true, "schema": { "type": "integer" } }, { "in": "path", "description": "ID for the EntityType.PLUGIN_TASK_PARAMETER_TYPE resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SnapshotsIdPluginParameterType-dump" } } } } }, "summary": "Gets a Snapshot for the resource by snapshot id", "operationId": "get_resources_snapshots_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "PluginParameterTypes" ] } }, "/api/v1/pluginParameterTypes/{id}/tags": { "parameters": [ { "in": "path", "description": "ID for the plugin_task_parameter_type.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "put": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TagRef-dump" } } } } } }, "summary": "Replaces one or more Tags to the resource", "operationId": "put_resources_tags_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "$ref": "#/components/requestBodies/IdList" }, "tags": [ "PluginParameterTypes" ] }, "post": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TagRef-dump" } } } } } }, "summary": "Appends one or more Tags to the resource", "operationId": "post_resources_tags_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "$ref": "#/components/requestBodies/IdList" }, "tags": [ "PluginParameterTypes" ] }, "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TagRef-dump" } } } } } }, "summary": "Gets the list of Tags for the resource", "operationId": "get_resources_tags_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "PluginParameterTypes" ] }, "delete": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdStatusResponse" } } } } }, "summary": "Removes all Tags from the resource", "operationId": "delete_resources_tags_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "PluginParameterTypes" ] } }, "/api/v1/pluginParameterTypes/{id}/tags/{tagId}": { "parameters": [ { "in": "path", "description": "ID for the Tag.", "name": "tagId", "required": true, "schema": { "type": "integer" } }, { "in": "path", "description": "ID for the plugin_task_parameter_type.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "delete": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdStatusResponse" } } } } }, "summary": "Removes a Tag from the resource", "operationId": "delete_resources_tags_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "PluginParameterTypes" ] } }, "/api/v1/plugins/": { "post": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Plugin-dump" } } } } }, "summary": "Creates a Plugin resource", "operationId": "post_plugin_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Plugin-load" } } }, "required": true }, "tags": [ "Plugins" ] }, "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PluginPage" } } } } }, "summary": "Gets a list of all Plugin resources", "operationId": "get_plugin_endpoint", "parameters": [ { "name": "sortBy", "in": "query", "description": "The name of the column to sort.", "schema": { "type": "string" } }, { "name": "descending", "in": "query", "description": "Boolean indicating whether to sort by descending or not.", "schema": { "type": "boolean" } }, { "name": "search", "in": "query", "description": "Search terms for the query (* and ? wildcards).", "schema": { "type": "string" } }, { "name": "groupId", "in": "query", "description": "Filter results by the Group ID.", "schema": { "type": "integer" } }, { "name": "index", "in": "query", "description": "Starting index of the current page.", "schema": { "type": "integer" } }, { "name": "pageLength", "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Plugins" ] } }, "/api/v1/plugins/drafts/": { "post": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Draft-dump" } } } } }, "summary": "Creates a Draft for the resource", "operationId": "post_resource_drafts_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DraftsPlugin-load" } } }, "required": true }, "tags": [ "Plugins" ] }, "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DraftPage" } } } } }, "summary": "Gets the Drafts for the resource", "operationId": "get_resource_drafts_endpoint", "parameters": [ { "name": "draftType", "in": "query", "description": "The type of drafts to return: all, existing, or new.", "schema": { "type": "string" } }, { "name": "groupId", "in": "query", "description": "Filter results by the Group ID.", "schema": { "type": "integer" } }, { "name": "index", "in": "query", "description": "Starting index of the current page.", "schema": { "type": "integer" } }, { "name": "pageLength", "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Plugins" ] } }, "/api/v1/plugins/drafts/{draftId}": { "parameters": [ { "in": "path", "description": "ID for the Draft of the Plugin resource.", "name": "draftId", "required": true, "schema": { "type": "integer" } } ], "put": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Draft-dump" } } } } }, "summary": "Modifies a Draft for the resource", "operationId": "put_resources_drafts_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DraftsIdPluginMutableFields" } } }, "required": true }, "tags": [ "Plugins" ] }, "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Draft-dump" } } } } }, "summary": "Gets a Draft for the resource", "operationId": "get_resources_drafts_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Plugins" ] }, "delete": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdStatusResponse" } } } } }, "summary": "Deletes a Draft for the resource", "operationId": "delete_resources_drafts_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Plugins" ] } }, "/api/v1/plugins/{id}": { "parameters": [ { "in": "path", "description": "ID for the Plugin resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "put": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Plugin-dump" } } } } }, "summary": "Modifies a Plugin resource", "operationId": "put_plugin_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PluginMutableFields" } } }, "required": true }, "tags": [ "Plugins" ] }, "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Plugin-dump" } } } } }, "summary": "Gets a Plugin resource", "operationId": "get_plugin_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Plugins" ] }, "delete": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdStatusResponse" } } } } }, "summary": "Deletes a Plugin resource", "operationId": "delete_plugin_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Plugins" ] } }, "/api/v1/plugins/{id}/draft": { "parameters": [ { "in": "path", "description": "ID for the resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "put": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Draft-dump" } } } } }, "summary": "Modifies the Draft for this resource", "operationId": "put_resources_id_draft_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModifyDraftPluginMutableFields" } } }, "required": true }, "tags": [ "Plugins" ] }, "post": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Draft-dump" } } } } }, "summary": "Creates a Draft for this resource", "operationId": "post_resources_id_draft_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDraftPluginMutableFields" } } }, "required": true }, "tags": [ "Plugins" ] }, "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Draft-dump" } } } } }, "summary": "Gets the Draft for this resource", "operationId": "get_resources_id_draft_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Plugins" ] }, "delete": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdStatusResponse" } } } } }, "summary": "Deletes the Draft for this resource", "operationId": "delete_resources_id_draft_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Plugins" ] } }, "/api/v1/plugins/{id}/files": { "parameters": [ { "in": "path", "description": "ID for the Plugin resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "post": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PluginFile-dump" } } } } }, "summary": "Creates a PluginFile resource associated with a Plugin resource", "description": "If type is plugin then blah\nIf type is artifact then blah", "operationId": "post_plugin_id_files_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PluginFile-load" } } }, "required": true }, "tags": [ "Plugins" ] }, "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PluginFilePage" } } } } }, "summary": "Gets a list of all PluginFile resources for a Plugin resource", "operationId": "get_plugin_id_files_endpoint", "parameters": [ { "name": "sortBy", "in": "query", "description": "The name of the column to sort.", "schema": { "type": "string" } }, { "name": "descending", "in": "query", "description": "Boolean indicating whether to sort by descending or not.", "schema": { "type": "boolean" } }, { "name": "search", "in": "query", "description": "Search terms for the query (* and ? wildcards).", "schema": { "type": "string" } }, { "name": "index", "in": "query", "description": "Starting index of the current page.", "schema": { "type": "integer" } }, { "name": "pageLength", "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Plugins" ] }, "delete": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdStatusResponse" } } } } }, "summary": "Deletes all PluginFile resources associated with a Plugin resource", "operationId": "delete_plugin_id_files_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Plugins" ] } }, "/api/v1/plugins/{id}/files/drafts/": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "post": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Draft-dump" } } } } }, "summary": "Creates a Draft for the resource", "operationId": "post_resource_drafts_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NestedDraftsPluginFile-load" } } }, "required": true }, "tags": [ "Plugins" ] }, "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DraftPage" } } } } }, "summary": "Gets the Drafts for the resource", "operationId": "get_resource_drafts_endpoint", "parameters": [ { "name": "draftType", "in": "query", "description": "The type of drafts to return: all, existing, or new.", "schema": { "type": "string" } }, { "name": "groupId", "in": "query", "description": "Filter results by the Group ID.", "schema": { "type": "integer" } }, { "name": "index", "in": "query", "description": "Starting index of the current page.", "schema": { "type": "integer" } }, { "name": "pageLength", "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Plugins" ] } }, "/api/v1/plugins/{id}/files/drafts/{draftId}": { "parameters": [ { "in": "path", "description": "ID for the Draft of the EntityType.PLUGIN_FILE resource.", "name": "draftId", "required": true, "schema": { "type": "integer" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "put": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Draft-dump" } } } } }, "summary": "Modifies a Draft for the resource", "operationId": "put_resources_drafts_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NestedDraftsIdPluginFile-load" } } }, "required": true }, "tags": [ "Plugins" ] }, "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Draft-dump" } } } } }, "summary": "Gets a Draft for the resource", "operationId": "get_resources_drafts_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Plugins" ] }, "delete": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdStatusResponse" } } } } }, "summary": "Deletes a Draft for the resource", "operationId": "delete_resources_drafts_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Plugins" ] } }, "/api/v1/plugins/{id}/files/{fileId}": { "parameters": [ { "in": "path", "description": "ID for the PluginFile resource.", "name": "fileId", "required": true, "schema": { "type": "integer" } }, { "in": "path", "description": "ID for the Plugin resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "put": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PluginFile-dump" } } } } }, "summary": "Modifies a PluginFile resource", "operationId": "put_plugin_id_file_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PluginFileMutableFields" } } }, "required": true }, "tags": [ "Plugins" ] }, "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PluginFile-dump" } } } } }, "summary": "Gets a PluginFile resource", "operationId": "get_plugin_id_file_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Plugins" ] }, "delete": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdStatusResponse" } } } } }, "summary": "Deletes a PluginFile resource", "operationId": "delete_plugin_id_file_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Plugins" ] } }, "/api/v1/plugins/{id}/files/{fileId}/draft": { "parameters": [ { "in": "path", "description": "ID for the resource.", "name": "id", "required": true, "schema": { "type": "integer" } }, { "name": "fileId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "put": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Draft-dump" } } } } }, "summary": "Modifies the Draft for this resource", "operationId": "put_resources_id_draft_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModifyNestedDraftPluginFile" } } }, "required": true }, "tags": [ "Plugins" ] }, "post": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Draft-dump" } } } } }, "summary": "Creates a Draft for this resource", "operationId": "post_resources_id_draft_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateNestedDraftPluginFile-load" } } }, "required": true }, "tags": [ "Plugins" ] }, "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Draft-dump" } } } } }, "summary": "Gets the Draft for this resource", "operationId": "get_resources_id_draft_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Plugins" ] }, "delete": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdStatusResponse" } } } } }, "summary": "Deletes the Draft for this resource", "operationId": "delete_resources_id_draft_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Plugins" ] } }, "/api/v1/plugins/{id}/files/{fileId}/snapshots": { "parameters": [ { "in": "path", "description": "ID for the EntityType.PLUGIN_FILE.", "name": "fileId", "required": true, "schema": { "type": "integer" } }, { "in": "path", "description": "ID for the EntityType.PLUGIN_FILE.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NestedSnapshotsPluginFilePage" } } } } }, "summary": "Gets the Snapshots for the resource", "operationId": "get_resource_snapshots_endpoint", "parameters": [ { "name": "search", "in": "query", "description": "Search terms for the query (* and ? wildcards).", "schema": { "type": "string" } }, { "name": "index", "in": "query", "description": "Starting index of the current page.", "schema": { "type": "integer" } }, { "name": "pageLength", "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Plugins" ] } }, "/api/v1/plugins/{id}/files/{fileId}/snapshots/{snapshotId}": { "parameters": [ { "in": "path", "description": "ID for the Snapshot.", "name": "snapshotId", "required": true, "schema": { "type": "integer" } }, { "in": "path", "description": "ID for the Plugin File.", "name": "fileId", "required": true, "schema": { "type": "integer" } }, { "in": "path", "description": "ID for the Plugin File.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NestedSnapshotsIdPluginFile-dump" } } } } }, "summary": "Gets a Snapshot for the resource by snapshot id", "operationId": "get_resources_snapshots_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Plugins" ] } }, "/api/v1/plugins/{id}/files/{fileId}/tags/": { "parameters": [ { "in": "path", "description": "ID for the plugin_file.", "name": "fileId", "required": true, "schema": { "type": "integer" } }, { "in": "path", "description": "ID for the plugin.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "put": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TagRef-dump" } } } } } }, "summary": "Replaces one or more Tags to the resource", "operationId": "put_resources_tags_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "$ref": "#/components/requestBodies/IdList" }, "tags": [ "Plugins" ] }, "post": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TagRef-dump" } } } } } }, "summary": "Appends one or more Tags to the resource", "operationId": "post_resources_tags_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "$ref": "#/components/requestBodies/IdList" }, "tags": [ "Plugins" ] }, "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TagRef-dump" } } } } } }, "summary": "Gets the list of Tags for the resource", "operationId": "get_resources_tags_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Plugins" ] }, "delete": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdStatusResponse" } } } } }, "summary": "Removes all Tags from the resource", "operationId": "delete_resources_tags_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Plugins" ] } }, "/api/v1/plugins/{id}/files/{fileId}/tags/{tagId}": { "parameters": [ { "in": "path", "description": "ID for the Tag.", "name": "tagId", "required": true, "schema": { "type": "integer" } }, { "in": "path", "description": "ID for the plugin_file.", "name": "fileId", "required": true, "schema": { "type": "integer" } }, { "in": "path", "description": "ID for the plugin.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "delete": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdStatusResponse" } } } } }, "summary": "Removes a Tag from the resource", "operationId": "delete_resources_tags_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Plugins" ] } }, "/api/v1/plugins/{id}/snapshots": { "parameters": [ { "in": "path", "description": "ID for the EntityType.PLUGIN resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SnapshotsPluginPage" } } } } }, "summary": "Gets the Snapshots for the resource", "operationId": "get_resource_snapshots_endpoint", "parameters": [ { "name": "search", "in": "query", "description": "Search terms for the query (* and ? wildcards).", "schema": { "type": "string" } }, { "name": "index", "in": "query", "description": "Starting index of the current page.", "schema": { "type": "integer" } }, { "name": "pageLength", "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Plugins" ] } }, "/api/v1/plugins/{id}/snapshots/{snapshotId}": { "parameters": [ { "in": "path", "description": "Snapshot ID for the EntityType.PLUGIN resource.", "name": "snapshotId", "required": true, "schema": { "type": "integer" } }, { "in": "path", "description": "ID for the EntityType.PLUGIN resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SnapshotsIdPlugin-dump" } } } } }, "summary": "Gets a Snapshot for the resource by snapshot id", "operationId": "get_resources_snapshots_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Plugins" ] } }, "/api/v1/plugins/{id}/snapshots/{snapshotId}/files/bundle": { "parameters": [ { "in": "path", "description": "Snapshot ID for the Entrypoint resource.", "name": "snapshotId", "required": true, "schema": { "type": "integer" } }, { "in": "path", "description": "ID for the Entrypoint resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "get": { "responses": { "200": { "description": "Success" } }, "summary": "Returns a file bundle containing all of the PluginFile resources for an", "description": "EntryPoint Snapshot resource.", "operationId": "get_plugin_snapshot_id_file_bundle_endpoint", "parameters": [ { "name": "fileType", "in": "query", "description": "The type of file to download: tar_gz or zip.", "schema": { "type": "string" } } ], "tags": [ "Plugins" ] } }, "/api/v1/plugins/{id}/tags": { "parameters": [ { "in": "path", "description": "ID for the plugin.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "put": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TagRef-dump" } } } } } }, "summary": "Replaces one or more Tags to the resource", "operationId": "put_resources_tags_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "$ref": "#/components/requestBodies/IdList" }, "tags": [ "Plugins" ] }, "post": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TagRef-dump" } } } } } }, "summary": "Appends one or more Tags to the resource", "operationId": "post_resources_tags_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "$ref": "#/components/requestBodies/IdList" }, "tags": [ "Plugins" ] }, "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TagRef-dump" } } } } } }, "summary": "Gets the list of Tags for the resource", "operationId": "get_resources_tags_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Plugins" ] }, "delete": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdStatusResponse" } } } } }, "summary": "Removes all Tags from the resource", "operationId": "delete_resources_tags_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Plugins" ] } }, "/api/v1/plugins/{id}/tags/{tagId}": { "parameters": [ { "in": "path", "description": "ID for the Tag.", "name": "tagId", "required": true, "schema": { "type": "integer" } }, { "in": "path", "description": "ID for the plugin.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "delete": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdStatusResponse" } } } } }, "summary": "Removes a Tag from the resource", "operationId": "delete_resources_tags_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Plugins" ] } }, "/api/v1/queues/": { "post": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Queue-dump" } } } } }, "summary": "Creates a Queue resource", "operationId": "post_queue_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Queue-load" } } }, "required": true }, "tags": [ "Queues" ] }, "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QueuePage" } } } } }, "summary": "Gets a list of all Queue resources", "operationId": "get_queue_endpoint", "parameters": [ { "name": "showDeleted", "in": "query", "description": "Boolean indicating whether to include deleted resources in the results.", "schema": { "type": "boolean" } }, { "name": "sortBy", "in": "query", "description": "The name of the column to sort.", "schema": { "type": "string" } }, { "name": "descending", "in": "query", "description": "Boolean indicating whether to sort by descending or not.", "schema": { "type": "boolean" } }, { "name": "search", "in": "query", "description": "Search terms for the query (* and ? wildcards).", "schema": { "type": "string" } }, { "name": "groupId", "in": "query", "description": "Filter results by the Group ID.", "schema": { "type": "integer" } }, { "name": "index", "in": "query", "description": "Starting index of the current page.", "schema": { "type": "integer" } }, { "name": "pageLength", "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Queues" ] } }, "/api/v1/queues/drafts/": { "post": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Draft-dump" } } } } }, "summary": "Creates a Draft for the resource", "operationId": "post_resource_drafts_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DraftsQueue-load" } } }, "required": true }, "tags": [ "Queues" ] }, "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DraftPage" } } } } }, "summary": "Gets the Drafts for the resource", "operationId": "get_resource_drafts_endpoint", "parameters": [ { "name": "draftType", "in": "query", "description": "The type of drafts to return: all, existing, or new.", "schema": { "type": "string" } }, { "name": "groupId", "in": "query", "description": "Filter results by the Group ID.", "schema": { "type": "integer" } }, { "name": "index", "in": "query", "description": "Starting index of the current page.", "schema": { "type": "integer" } }, { "name": "pageLength", "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Queues" ] } }, "/api/v1/queues/drafts/{draftId}": { "parameters": [ { "in": "path", "description": "ID for the Draft of the Queue resource.", "name": "draftId", "required": true, "schema": { "type": "integer" } } ], "put": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Draft-dump" } } } } }, "summary": "Modifies a Draft for the resource", "operationId": "put_resources_drafts_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DraftsIdQueueMutableFields" } } }, "required": true }, "tags": [ "Queues" ] }, "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Draft-dump" } } } } }, "summary": "Gets a Draft for the resource", "operationId": "get_resources_drafts_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Queues" ] }, "delete": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdStatusResponse" } } } } }, "summary": "Deletes a Draft for the resource", "operationId": "delete_resources_drafts_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Queues" ] } }, "/api/v1/queues/{id}": { "parameters": [ { "in": "path", "description": "ID for the Queue resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "put": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Queue-dump" } } } } }, "summary": "Modifies a Queue resource", "operationId": "put_queue_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QueueMutableFields" } } }, "required": true }, "tags": [ "Queues" ] }, "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Queue-dump" } } } } }, "summary": "Gets a Queue resource", "operationId": "get_queue_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Queues" ] }, "delete": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdStatusResponse" } } } } }, "summary": "Deletes a Queue resource", "operationId": "delete_queue_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Queues" ] } }, "/api/v1/queues/{id}/draft": { "parameters": [ { "in": "path", "description": "ID for the resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "put": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Draft-dump" } } } } }, "summary": "Modifies the Draft for this resource", "operationId": "put_resources_id_draft_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModifyDraftQueueMutableFields" } } }, "required": true }, "tags": [ "Queues" ] }, "post": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Draft-dump" } } } } }, "summary": "Creates a Draft for this resource", "operationId": "post_resources_id_draft_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDraftQueueMutableFields" } } }, "required": true }, "tags": [ "Queues" ] }, "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Draft-dump" } } } } }, "summary": "Gets the Draft for this resource", "operationId": "get_resources_id_draft_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Queues" ] }, "delete": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdStatusResponse" } } } } }, "summary": "Deletes the Draft for this resource", "operationId": "delete_resources_id_draft_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Queues" ] } }, "/api/v1/queues/{id}/snapshots": { "parameters": [ { "in": "path", "description": "ID for the EntityType.QUEUE resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SnapshotsQueuePage" } } } } }, "summary": "Gets the Snapshots for the resource", "operationId": "get_resource_snapshots_endpoint", "parameters": [ { "name": "search", "in": "query", "description": "Search terms for the query (* and ? wildcards).", "schema": { "type": "string" } }, { "name": "index", "in": "query", "description": "Starting index of the current page.", "schema": { "type": "integer" } }, { "name": "pageLength", "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Queues" ] } }, "/api/v1/queues/{id}/snapshots/{snapshotId}": { "parameters": [ { "in": "path", "description": "Snapshot ID for the EntityType.QUEUE resource.", "name": "snapshotId", "required": true, "schema": { "type": "integer" } }, { "in": "path", "description": "ID for the EntityType.QUEUE resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SnapshotsIdQueue-dump" } } } } }, "summary": "Gets a Snapshot for the resource by snapshot id", "operationId": "get_resources_snapshots_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Queues" ] } }, "/api/v1/queues/{id}/tags": { "parameters": [ { "in": "path", "description": "ID for the queue.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "put": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TagRef-dump" } } } } } }, "summary": "Replaces one or more Tags to the resource", "operationId": "put_resources_tags_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "$ref": "#/components/requestBodies/IdList" }, "tags": [ "Queues" ] }, "post": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TagRef-dump" } } } } } }, "summary": "Appends one or more Tags to the resource", "operationId": "post_resources_tags_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "$ref": "#/components/requestBodies/IdList" }, "tags": [ "Queues" ] }, "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TagRef-dump" } } } } } }, "summary": "Gets the list of Tags for the resource", "operationId": "get_resources_tags_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Queues" ] }, "delete": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdStatusResponse" } } } } }, "summary": "Removes all Tags from the resource", "operationId": "delete_resources_tags_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Queues" ] } }, "/api/v1/queues/{id}/tags/{tagId}": { "parameters": [ { "in": "path", "description": "ID for the Tag.", "name": "tagId", "required": true, "schema": { "type": "integer" } }, { "in": "path", "description": "ID for the queue.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "delete": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdStatusResponse" } } } } }, "summary": "Removes a Tag from the resource", "operationId": "delete_resources_tags_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Queues" ] } }, "/api/v1/tags/": { "post": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tag-dump" } } } } }, "summary": "Creates a Tag", "operationId": "post_tag_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tag-load" } } }, "required": true }, "tags": [ "Tags" ] }, "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagPage" } } } } }, "summary": "Gets a list of all Tags", "operationId": "get_tag_endpoint", "parameters": [ { "name": "sortBy", "in": "query", "description": "The name of the column to sort.", "schema": { "type": "string" } }, { "name": "descending", "in": "query", "description": "Boolean indicating whether to sort by descending or not.", "schema": { "type": "boolean" } }, { "name": "search", "in": "query", "description": "Search terms for the query (* and ? wildcards).", "schema": { "type": "string" } }, { "name": "groupId", "in": "query", "description": "Filter results by the Group ID.", "schema": { "type": "integer" } }, { "name": "index", "in": "query", "description": "Starting index of the current page.", "schema": { "type": "integer" } }, { "name": "pageLength", "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Tags" ] } }, "/api/v1/tags/{id}": { "parameters": [ { "in": "path", "description": "ID for the Tag.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "put": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tag-dump" } } } } }, "summary": "Modifies a Tag", "operationId": "put_tag_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagMutableFields" } } }, "required": true }, "tags": [ "Tags" ] }, "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tag-dump" } } } } }, "summary": "Gets a Tag", "operationId": "get_tag_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Tags" ] }, "delete": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdStatusResponse" } } } } }, "summary": "Deletes a Tag", "operationId": "delete_tag_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Tags" ] } }, "/api/v1/tags/{id}/resources/": { "parameters": [ { "in": "path", "description": "ID for the Tag.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceUrlsPage" } } } } }, "summary": "Gets all Resources labeled with this Tag", "operationId": "get_tag_id_resource_endpoint", "parameters": [ { "name": "resourceType", "in": "query", "description": "Filter results by the type of resource.", "schema": { "type": "string" } }, { "name": "index", "in": "query", "description": "Starting index of the current page.", "schema": { "type": "integer" } }, { "name": "pageLength", "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Tags" ] } }, "/api/v1/users/": { "post": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserCurrent-dump" } } } } }, "summary": "Creates a User", "operationId": "post_user_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User-load" } } }, "required": true }, "tags": [ "Users" ] }, "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserPage" } } } } }, "summary": "Gets a list of all Users", "operationId": "get_user_endpoint", "parameters": [ { "name": "search", "in": "query", "description": "Search terms for the query (* and ? wildcards).", "schema": { "type": "string" } }, { "name": "index", "in": "query", "description": "Starting index of the current page.", "schema": { "type": "integer" } }, { "name": "pageLength", "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Users" ] } }, "/api/v1/users/current": { "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserCurrent-dump" } } } } }, "summary": "Gets the Current User", "operationId": "get_user_current_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Users" ] }, "delete": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdStatusResponse" } } } } }, "summary": "Deletes a Current User", "operationId": "delete_user_current_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDelete" } } }, "required": true }, "tags": [ "Users" ] } }, "/api/v1/users/current/password": { "post": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdStatusResponse" } } } } }, "summary": "Updates the Current User's password", "operationId": "post_user_current_password_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "$ref": "#/components/requestBodies/UserPassword-load" }, "tags": [ "Users" ] } }, "/api/v1/users/{id}": { "parameters": [ { "in": "path", "description": "ID for the User resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "get": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User-dump" } } } } }, "summary": "Gets the User with the provided ID", "operationId": "get_user_id_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Users" ] } }, "/api/v1/users/{id}/password": { "parameters": [ { "in": "path", "description": "ID for the User resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "post": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdStatusResponse" } } } } }, "summary": "Updates the User's password with a given ID", "operationId": "post_user_id_password_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "$ref": "#/components/requestBodies/UserPassword-load" }, "tags": [ "Users" ] } }, "/api/v1/workflows/draftCommit/{id}": { "parameters": [ { "in": "path", "description": "ID for the Draft resource.", "name": "id", "required": true, "schema": { "type": "integer" } } ], "post": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdStatusResponse" } } } } }, "summary": "Commit a draft as a new resource", "operationId": "post_draft_commit_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "tags": [ "Workflows" ] } }, "/api/v1/workflows/pluginTaskSignatureAnalysis": { "post": { "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignatureAnalysisOutput" } } } } }, "summary": "Download a compressed file archive containing the files needed to execute a submitted job", "operationId": "post_signature_analysis_endpoint", "parameters": [ { "name": "X-Fields", "in": "header", "description": "An optional fields mask", "schema": { "type": "string", "format": "mask" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignatureAnalysis" } } }, "required": true }, "tags": [ "Workflows" ] } }, "/api/v1/workflows/resourceImport": { "post": { "responses": { "200": { "description": "Success" } }, "summary": "Import resources from an external source", "operationId": "post_resource_import", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "group": { "description": "ID of the Group that will own the imported resources.", "type": "integer" }, "sourceType": { "description": "The source of the resources to import('upload_archive', 'upload_files', or 'git'.", "type": "string" }, "gitUrl": { "description": "The URL of the git repository containing resources to import. A git branch can optionally be specified by appending #BRANCH_NAME. Used when sourceType is 'git'.", "type": "string" }, "archiveFile": { "description": "The archive file containing resources to import (.tar.gz). Used when sourceType is 'upload_archive'.", "type": "string", "format": "binary" }, "files": { "description": "The files containing the resources to import.Used when sourceType is 'upload_files'.", "type": "array", "items": { "type": "file" } }, "configPath": { "description": "The path to the toml configuration file.", "type": "string", "default": "dioptra.toml" }, "resolveNameConflictsStrategy": { "description": "Strategy for resolving resource name conflicts. Available options are 'fail', 'update', or 'overwrite'", "type": "string", "default": "fail" } }, "required": [ "group", "sourceType" ] } } }, "required": true }, "tags": [ "Workflows" ] } } }, "info": { "title": "Dioptra REST API", "version": "1.2.0dev0" }, "tags": [ { "name": "Authentication", "description": "Authentication endpoint" }, { "name": "Artifact", "description": "Artifacts endpoint" }, { "name": "Entrypoints", "description": "Entrypoints endpoint" }, { "name": "Experiments", "description": "Experiments endpoint" }, { "name": "Groups", "description": "Groups endpoint" }, { "name": "Job", "description": "Job endpoint" }, { "name": "Models", "description": "Models endpoint" }, { "name": "PluginParameterTypes", "description": "Plugin Parameter Types endpoint" }, { "name": "Plugins", "description": "Plugins endpoint" }, { "name": "Queues", "description": "Queues endpoint" }, { "name": "Tags", "description": "Tags endpoint" }, { "name": "Users", "description": "Users endpoint" }, { "name": "Workflows", "description": "Workflows endpoint" } ], "servers": [ { "url": "/" } ], "components": { "responses": { "ParseError": { "description": "When a mask can't be parsed" }, "MaskError": { "description": "When any error occurs on mask" }, "EntityDoesNotExistError": { "description": "" }, "EntityRelationshipDoesNotExistError": { "description": "" }, "EntityDeletedError": { "description": "" }, "EntityExistsError": { "description": "" }, "BackendDatabaseError": { "description": "" }, "SearchNotImplementedError": { "description": "" }, "SearchParseError": { "description": "" }, "DraftDoesNotExistError": { "description": "" }, "DraftBaseResourceDoesNotExistError": { "description": "" }, "DraftAlreadyExistsError": { "description": "" }, "DraftResourceModificationsCommitError": { "description": "" }, "InvalidDraftBaseResourceSnapshotError": { "description": "" }, "LockError": { "description": "" }, "InconsistentBuiltinPluginParameterTypesError": { "description": "" }, "PluginTaskDoesNotExistError": { "description": "" }, "UserDoesNotExistError": { "description": "" }, "NoCurrentUserError": { "description": "" }, "UserPasswordChangeError": { "description": "" }, "UserPasswordError": { "description": "" }, "MlflowRunNotFoundError": { "description": "" }, "JobStoreError": { "description": "" }, "GitError": { "description": "" }, "ImportFailedError": { "description": "" }, "EntrypointSwapsRenderError": { "description": "" }, "EntrypointValidationError": { "description": "" }, "DioptraError": { "description": "" } }, "requestBodies": { "IdList": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdList" } } }, "required": true }, "JobMlflowRun": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobMlflowRun" } } }, "required": true }, "UserPassword-load": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserPassword-load" } } }, "required": true } }, "schemas": { "Login-load": { "required": [ "password", "username" ], "properties": { "username": { "type": "string", "description": "The account username." }, "password": { "type": "string", "description": "The account password." } }, "type": "object" }, "Login-dump": { "required": [ "username" ], "properties": { "username": { "type": "string", "description": "The account username." }, "status": { "type": "string", "description": "The status of the login request." } }, "type": "object" }, "Logout-dump": { "required": [ "username" ], "properties": { "username": { "type": "string", "description": "The account username." }, "everywhere": { "type": "boolean", "description": "Logout on all devices.", "default": false }, "status": { "type": "string", "description": "The status of the logout request." } }, "type": "object" }, "Artifact-load": { "required": [ "group", "job" ], "properties": { "group": { "type": "integer", "description": "ID of the Group that will own the Artifact resource." }, "description": { "type": "string", "description": "Description of the Artifact resource." }, "pluginSnapshotId": { "type": "integer", "description": "The Snapshot ID of the plugin containing the plugin file that performs serializing/deserializing of this Artifact." }, "taskId": { "type": "integer", "description": "The id of the plugin artifact task that performs theserializing/deserializing of this Artifact." }, "artifactUri": { "type": "string", "description": "URL pointing to the location of the Artifact resource." }, "job": { "type": "integer", "description": "id of the job that produced this Artifact" } }, "type": "object" }, "Artifact-dump": { "required": [ "job" ], "properties": { "id": { "type": "integer", "description": "ID for the Artifact resource." }, "snapshot": { "type": "integer", "description": "ID for the underlying Artifact snapshot." }, "group": { "description": "Group that owns the Artifact resource.", "allOf": [ { "$ref": "#/components/schemas/GroupRef" } ] }, "user": { "description": "User that created the Artifact resource.", "allOf": [ { "$ref": "#/components/schemas/UserRef-dump" } ] }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the Artifact resource was created." }, "snapshotCreatedOn": { "type": "string", "format": "date-time", "description": "Timestamp when the Artifact resource snapshot was created." }, "lastModifiedOn": { "type": "string", "format": "date-time", "description": "Timestamp when the Artifact resource was last modified." }, "latestSnapshot": { "type": "boolean", "description": "Whether or not the Artifact resource is the latest version." }, "hasDraft": { "type": "boolean", "description": "Whether a draft exists for the Artifact resource." }, "tags": { "type": "array", "items": { "description": "Tags associated with the Artifact resource.", "allOf": [ { "$ref": "#/components/schemas/TagRef-dump" } ] } }, "deleted": { "type": "boolean", "description": "Whether the Artifact resource has been deleted.", "default": false }, "description": { "type": "string", "description": "Description of the Artifact resource." }, "isDir": { "type": "boolean", "description": "Whether the file denotes a directory or not." }, "fileSize": { "type": "integer", "description": "The size in bytes of the file." }, "fileUrl": { "type": "string", "description": "URL for accessing the contents of the Artifact." }, "artifactUri": { "type": "string", "description": "URL pointing to the location of the Artifact resource." }, "job": { "type": "integer", "description": "id of the job that produced this Artifact" }, "task": { "description": "The artifact task.", "allOf": [ { "$ref": "#/components/schemas/ArtifactArtifactTask-dump" } ] } }, "type": "object" }, "GroupRef": { "properties": { "id": { "type": "integer", "description": "ID for the Group resource." }, "name": { "type": "string", "description": "Name of the Group resource." }, "url": { "type": "string", "description": "URL for accessing the full Group resource." } }, "type": "object" }, "UserRef-dump": { "properties": { "id": { "type": "integer", "description": "ID for the User resource." }, "username": { "type": "string", "description": "Username of the User resource." }, "url": { "type": "string", "description": "URL for accessing the full User resource." } }, "type": "object" }, "TagRef-dump": { "properties": { "id": { "type": "integer", "description": "ID for the Tag." }, "name": { "type": "string", "description": "Name of the Tag." }, "group": { "description": "Owner of the Tag.", "allOf": [ { "$ref": "#/components/schemas/GroupRef" } ] }, "url": { "type": "string", "description": "URL for accessing the full Tag." } }, "type": "object" }, "ArtifactArtifactTask-dump": { "required": [ "name" ], "properties": { "id": { "type": "integer", "description": "Id of the PluginTask." }, "name": { "type": "string", "description": "Name of the PluginTask." }, "outputParams": { "type": "array", "items": { "description": "List of output PluginTaskParameters produced by this ArtifactTask.", "allOf": [ { "$ref": "#/components/schemas/PluginTaskOutputParameter-dump" } ] } }, "pluginResourceId": { "type": "integer", "description": "resource id of the plugin containing the Artifact Task" }, "pluginResourceSnapshotId": { "type": "integer", "description": "snapshot resource id of the plugin containing the Artifact Task" }, "pluginFileResourceId": { "type": "integer", "description": "resource id of the plugin file containing the Artifact Task" }, "pluginFileResourceSnapshotId": { "type": "integer", "description": "snapshot resource id of the plugin file containing the Artifact Task" } }, "type": "object" }, "PluginTaskOutputParameter-dump": { "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Name of the PluginTaskParameter." }, "parameterType": { "description": "The assigned PluginParameterType resource.", "allOf": [ { "$ref": "#/components/schemas/PluginParameterTypeRef-dump" } ] } }, "type": "object" }, "PluginParameterTypeRef-dump": { "properties": { "id": { "type": "integer", "description": "ID for the PluginParameterType resource." }, "group": { "description": "Group that owns the PluginParameterType resource.", "allOf": [ { "$ref": "#/components/schemas/GroupRef" } ] }, "url": { "type": "string", "description": "URL for accessing the full PluginParameterType resource." }, "deleted": { "type": "boolean", "description": "Whether the PluginParameterType resource has been deleted.", "default": false }, "name": { "type": "string", "description": "Name of the PluginParameterType resource." } }, "type": "object" }, "ArtifactPage": { "properties": { "index": { "type": "integer", "description": "Starting index of the current page." }, "isComplete": { "type": "boolean", "description": "Boolean indicating if more data is available." }, "totalNumResults": { "type": "integer", "description": "Total number of results." }, "first": { "type": "string", "description": "URL to first page in results set." }, "next": { "type": "string", "description": "URL to next page in results set." }, "prev": { "type": "string", "description": "URL to last page in results set." }, "data": { "type": "array", "items": { "description": "List of Artifact resources in the current page.", "allOf": [ { "$ref": "#/components/schemas/Artifact-dump" } ] } } }, "type": "object" }, "ArtifactMutableFields-load": { "properties": { "description": { "type": "string", "description": "Description of the Artifact resource." }, "pluginSnapshotId": { "type": "integer", "description": "The Snapshot ID of the plugin containing the plugin file that performs serializing/deserializing of this Artifact." }, "taskId": { "type": "integer", "description": "The id of the plugin artifact task that performs theserializing/deserializing of this Artifact." } }, "type": "object" }, "ArtifactFile-dump": { "properties": { "isDir": { "type": "boolean", "description": "Whether the file denotes a directory or not." }, "fileSize": { "type": "integer", "description": "The size in bytes of the file." }, "fileUrl": { "type": "string", "description": "URL for accessing the contents of the Artifact." }, "relativePath": { "type": "string", "description": "Relative path to the Artifact URI." } }, "type": "object" }, "SnapshotsArtifactPage": { "properties": { "index": { "type": "integer", "description": "Starting index of the current page." }, "isComplete": { "type": "boolean", "description": "Boolean indicating if more data is available." }, "totalNumResults": { "type": "integer", "description": "Total number of results." }, "first": { "type": "string", "description": "URL to first page in results set." }, "next": { "type": "string", "description": "URL to next page in results set." }, "prev": { "type": "string", "description": "URL to last page in results set." }, "data": { "type": "array", "items": { "description": "List of Artifact resources in the current page.", "allOf": [ { "$ref": "#/components/schemas/Artifact-dump" } ] } } }, "type": "object" }, "SnapshotsIdArtifact-dump": { "required": [ "job" ], "properties": { "id": { "type": "integer", "description": "ID for the Artifact resource." }, "snapshot": { "type": "integer", "description": "ID for the underlying Artifact snapshot." }, "group": { "description": "Group that owns the Artifact resource.", "allOf": [ { "$ref": "#/components/schemas/GroupRef" } ] }, "user": { "description": "User that created the Artifact resource.", "allOf": [ { "$ref": "#/components/schemas/UserRef-dump" } ] }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the Artifact resource was created." }, "snapshotCreatedOn": { "type": "string", "format": "date-time", "description": "Timestamp when the Artifact resource snapshot was created." }, "lastModifiedOn": { "type": "string", "format": "date-time", "description": "Timestamp when the Artifact resource was last modified." }, "latestSnapshot": { "type": "boolean", "description": "Whether or not the Artifact resource is the latest version." }, "hasDraft": { "type": "boolean", "description": "Whether a draft exists for the Artifact resource." }, "tags": { "type": "array", "items": { "description": "Tags associated with the Artifact resource.", "allOf": [ { "$ref": "#/components/schemas/TagRef-dump" } ] } }, "deleted": { "type": "boolean", "description": "Whether the Artifact resource has been deleted.", "default": false }, "description": { "type": "string", "description": "Description of the Artifact resource." }, "isDir": { "type": "boolean", "description": "Whether the file denotes a directory or not." }, "fileSize": { "type": "integer", "description": "The size in bytes of the file." }, "fileUrl": { "type": "string", "description": "URL for accessing the contents of the Artifact." }, "artifactUri": { "type": "string", "description": "URL pointing to the location of the Artifact resource." }, "job": { "type": "integer", "description": "id of the job that produced this Artifact" }, "task": { "description": "The artifact task.", "allOf": [ { "$ref": "#/components/schemas/ArtifactArtifactTask-dump" } ] } }, "type": "object" }, "Entrypoint-load": { "required": [ "group", "name", "taskGraph" ], "properties": { "group": { "type": "integer", "description": "ID of the Group that will own the Entrypoint resource." }, "name": { "type": "string", "description": "Name of the Entrypoint resource." }, "description": { "type": "string", "description": "Description of the Entrypoint resource." }, "taskGraph": { "type": "string", "description": "Task graph of the Entrypoint resource." }, "artifactGraph": { "type": "string", "description": "Artifact graph of the Entrypoint resource." }, "parameters": { "type": "array", "items": { "description": "List of parameters for the entrypoint.", "default": [], "allOf": [ { "$ref": "#/components/schemas/EntrypointParameter" } ] } }, "artifactParameters": { "type": "array", "items": { "description": "List of artifacts for the entrypoint.", "default": [], "allOf": [ { "$ref": "#/components/schemas/EntrypointArtifact" } ] } }, "queues": { "type": "array", "description": "The queue for the entrypoint.", "default": [], "items": { "type": "integer" } }, "plugins": { "type": "array", "description": "List of plugin files for the entrypoint.", "default": [], "items": { "type": "integer" } }, "artifactPlugins": { "type": "array", "description": "List of artifact_plugin files for the entrypoint.", "items": { "type": "integer" } } }, "type": "object" }, "EntrypointParameter": { "required": [ "name", "parameterType" ], "properties": { "name": { "type": "string", "description": "Name of the Entrypoint parameter resource." }, "defaultValue": { "type": "string", "description": "Default value of the Entrypoint parameter." }, "parameterType": { "type": "string", "description": "Data type of the Entrypoint parameter." } }, "type": "object" }, "EntrypointArtifact": { "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Name of the Entrypoint artifact resource." }, "outputParams": { "type": "array", "items": { "description": "List of output ArtifactOutputParameters that the artifact isexpected to produce.", "allOf": [ { "$ref": "#/components/schemas/ArtifactOutputParameter-dump" } ] } } }, "type": "object" }, "ArtifactOutputParameter-dump": { "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Name of the PluginTaskParameter." }, "parameterType": { "description": "The assigned PluginParameterType resource.", "allOf": [ { "$ref": "#/components/schemas/PluginParameterTypeRef-dump" } ] } }, "type": "object" }, "Entrypoint-dump": { "required": [ "name", "taskGraph" ], "properties": { "id": { "type": "integer", "description": "ID for the Entrypoint resource." }, "snapshot": { "type": "integer", "description": "ID for the underlying Entrypoint snapshot." }, "group": { "description": "Group that owns the Entrypoint resource.", "allOf": [ { "$ref": "#/components/schemas/GroupRef" } ] }, "user": { "description": "User that created the Entrypoint resource.", "allOf": [ { "$ref": "#/components/schemas/UserRef-dump" } ] }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the Entrypoint resource was created." }, "snapshotCreatedOn": { "type": "string", "format": "date-time", "description": "Timestamp when the Entrypoint resource snapshot was created." }, "lastModifiedOn": { "type": "string", "format": "date-time", "description": "Timestamp when the Entrypoint resource was last modified." }, "latestSnapshot": { "type": "boolean", "description": "Whether or not the Entrypoint resource is the latest version." }, "hasDraft": { "type": "boolean", "description": "Whether a draft exists for the Entrypoint resource." }, "tags": { "type": "array", "items": { "description": "Tags associated with the Entrypoint resource.", "allOf": [ { "$ref": "#/components/schemas/TagRef-dump" } ] } }, "deleted": { "type": "boolean", "description": "Whether the Entrypoint resource has been deleted.", "default": false }, "name": { "type": "string", "description": "Name of the Entrypoint resource." }, "description": { "type": "string", "description": "Description of the Entrypoint resource." }, "taskGraph": { "type": "string", "description": "Task graph of the Entrypoint resource." }, "artifactGraph": { "type": "string", "description": "Artifact graph of the Entrypoint resource." }, "parameters": { "type": "array", "items": { "description": "List of parameters for the entrypoint.", "default": [], "allOf": [ { "$ref": "#/components/schemas/EntrypointParameter" } ] } }, "artifactParameters": { "type": "array", "items": { "description": "List of artifacts for the entrypoint.", "default": [], "allOf": [ { "$ref": "#/components/schemas/EntrypointArtifact" } ] } }, "plugins": { "type": "array", "items": { "description": "List of plugins for the entrypoint.", "allOf": [ { "$ref": "#/components/schemas/EntrypointPlugin" } ] } }, "artifactPlugins": { "type": "array", "items": { "description": "List of artifact plugins for the entrypoint.", "allOf": [ { "$ref": "#/components/schemas/EntrypointPlugin" } ] } }, "queues": { "type": "array", "items": { "description": "The queue for the entrypoint.", "allOf": [ { "$ref": "#/components/schemas/QueueRef-dump" } ] } } }, "type": "object" }, "EntrypointPlugin": { "properties": { "id": { "type": "integer", "description": "ID for the Plugin resource." }, "name": { "type": "string", "description": "Name of the Plugin resource." }, "snapshotId": { "type": "integer", "description": "Snapshot ID for the Plugin resource." }, "latestSnapshot": { "type": "boolean", "description": "Whether or not the Plugin is the latest version." }, "url": { "type": "string", "description": "URL for accessing the full Plugin snapshot." }, "files": { "type": "array", "items": { "description": "List of parameters for the entrypoint.", "allOf": [ { "$ref": "#/components/schemas/EntrypointPluginFile" } ] } } }, "type": "object" }, "EntrypointPluginFile": { "properties": { "id": { "type": "integer", "description": "ID for the PluginFile resource." }, "filename": { "type": "string", "description": "Filename of the PluginFile resource." }, "snapshotId": { "type": "integer", "description": "Snapshot ID for the PluginFile resource." }, "url": { "type": "string", "description": "URL for accessing the full PluginFile snapshot." }, "tasks": { "description": "Tasks associated with the PluginFile resource.", "allOf": [ { "$ref": "#/components/schemas/PluginTaskContainer" } ] } }, "type": "object" }, "PluginTaskContainer": { "properties": { "functions": { "type": "array", "items": { "description": "List of function tasks.", "allOf": [ { "$ref": "#/components/schemas/FunctionTask-dump" } ] } }, "artifacts": { "type": "array", "items": { "description": "List of artifact tasks.", "allOf": [ { "$ref": "#/components/schemas/ArtifactTask-dump" } ] } } }, "type": "object" }, "FunctionTask-dump": { "required": [ "name" ], "properties": { "id": { "type": "integer", "description": "Id of the PluginTask." }, "name": { "type": "string", "description": "Name of the PluginTask." }, "inputParams": { "type": "array", "items": { "description": "List of input PluginTaskParameters in this FunctionTask.", "allOf": [ { "$ref": "#/components/schemas/PluginTaskInputParameter-dump" } ] } }, "outputParams": { "type": "array", "items": { "description": "List of output PluginTaskParameters in this FunctionTask.", "allOf": [ { "$ref": "#/components/schemas/PluginTaskOutputParameter-dump" } ] } } }, "type": "object" }, "PluginTaskInputParameter-dump": { "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Name of the PluginTaskParameter." }, "parameterType": { "description": "The assigned PluginParameterType resource.", "allOf": [ { "$ref": "#/components/schemas/PluginParameterTypeRef-dump" } ] }, "required": { "type": "boolean", "description": "Sets whether the input parameter is required (True) or optional (False). If True, then this parameter must be assigned a value in order to execute the PluginTask.", "default": true } }, "type": "object" }, "ArtifactTask-dump": { "required": [ "name" ], "properties": { "id": { "type": "integer", "description": "Id of the PluginTask." }, "name": { "type": "string", "description": "Name of the PluginTask." }, "outputParams": { "type": "array", "items": { "description": "List of output PluginTaskParameters produced by this ArtifactTask.", "allOf": [ { "$ref": "#/components/schemas/PluginTaskOutputParameter-dump" } ] } } }, "type": "object" }, "QueueRef-dump": { "properties": { "id": { "type": "integer", "description": "ID for the Queue resource." }, "group": { "description": "Group that owns the Queue resource.", "allOf": [ { "$ref": "#/components/schemas/GroupRef" } ] }, "url": { "type": "string", "description": "URL for accessing the full Queue resource." }, "deleted": { "type": "boolean", "description": "Whether the Queue resource has been deleted.", "default": false }, "name": { "type": "string", "description": "Name of the Queue resource." } }, "type": "object" }, "EntrypointPage": { "properties": { "index": { "type": "integer", "description": "Starting index of the current page." }, "isComplete": { "type": "boolean", "description": "Boolean indicating if more data is available." }, "totalNumResults": { "type": "integer", "description": "Total number of results." }, "first": { "type": "string", "description": "URL to first page in results set." }, "next": { "type": "string", "description": "URL to next page in results set." }, "prev": { "type": "string", "description": "URL to last page in results set." }, "data": { "type": "array", "items": { "description": "List of Entrypoint resources in the current page.", "allOf": [ { "$ref": "#/components/schemas/Entrypoint-dump" } ] } } }, "type": "object" }, "EntrypointMutableFields-load": { "required": [ "name", "taskGraph" ], "properties": { "name": { "type": "string", "description": "Name of the Entrypoint resource." }, "description": { "type": "string", "description": "Description of the Entrypoint resource." }, "taskGraph": { "type": "string", "description": "Task graph of the Entrypoint resource." }, "artifactGraph": { "type": "string", "description": "Artifact graph of the Entrypoint resource." }, "parameters": { "type": "array", "items": { "description": "List of parameters for the entrypoint.", "default": [], "allOf": [ { "$ref": "#/components/schemas/EntrypointParameter" } ] } }, "artifactParameters": { "type": "array", "items": { "description": "List of artifacts for the entrypoint.", "default": [], "allOf": [ { "$ref": "#/components/schemas/EntrypointArtifact" } ] } }, "queues": { "type": "array", "description": "The queue for the entrypoint.", "default": [], "items": { "type": "integer" } } }, "type": "object" }, "IdStatusResponse": { "properties": { "id": { "type": "array", "description": "A list of integers identifying the affected resource(s).", "items": { "type": "integer" } }, "status": { "type": "string", "description": "The status of the request." } }, "type": "object" }, "EntrypointPluginMutableFields-load": { "properties": { "plugins": { "type": "array", "description": "List of plugin files for the entrypoint.", "default": [], "items": { "type": "integer" } } }, "type": "object" }, "EntrypointConfigResponse": { "properties": { "types": { "type": "object", "description": "A dictionary of types defined for this experiment.", "default": {} }, "parameters": { "type": "object", "description": "A dictionary of parameters defined for this experiment.", "default": {} }, "tasks": { "type": "object", "description": "A dictionary of tasks defined for this experiment.", "default": {} }, "graph": { "type": "object", "description": "A dictionary representing the task graph for this experiment.", "default": {} }, "artifact_outputs": { "type": "object", "description": "A dictionary representing the artifact outputs for this experiment.", "default": {} }, "artifact_inputs": { "type": "object", "description": "A dictionary representing the artifact inputs for this experiment.", "default": {} } }, "type": "object" }, "EntrypointArtifactPluginMutableFields-load": { "properties": { "artifactPlugins": { "type": "array", "description": "List of artifact_plugin files for the entrypoint.", "items": { "type": "integer" } } }, "type": "object" }, "IdList": { "properties": { "ids": { "type": "array", "description": "List of identifiers for one or more objects.", "items": { "type": "integer" } } }, "type": "object" }, "DynamicGlobalParametersResponse": { "properties": { "entrypointParams": { "type": "array", "description": "A list of global parameters used in the entrypoint task graph.", "items": { "type": "string" } }, "topologicalSort": { "type": "array", "description": "A list of task names topologically sorted by dependency.", "items": { "type": "string" } }, "activePlugins": { "type": "array", "items": { "description": "A list of plugin objects used in the entrypoint.", "allOf": [ { "$ref": "#/components/schemas/PluginSnapshotRef-dump" } ] } } }, "type": "object" }, "PluginSnapshotRef-dump": { "properties": { "id": { "type": "integer", "description": "ID for the Plugin resource." }, "snapshotId": { "type": "integer", "description": "Snapshot ID for the Plugin resource." }, "group": { "description": "Group that owns the Plugin resource.", "allOf": [ { "$ref": "#/components/schemas/GroupRef" } ] }, "url": { "type": "string", "description": "URL for accessing the full Plugin resource." }, "deleted": { "type": "boolean", "description": "Whether the Plugin resource has been deleted.", "default": false }, "name": { "type": "string", "description": "Name of the Plugin resource." } }, "type": "object" }, "SwapInfo": { "required": [ "entrypointKeywordArgs", "pluginFileResourceSnapshotId", "swapName", "taskAlias", "taskName" ], "properties": { "swapName": { "type": "string", "description": "The name of the swap this definition belongs to." }, "taskAlias": { "type": "string", "description": "Alias for the task definition." }, "taskName": { "type": "string", "description": "Name of the task that can be swapped in." }, "entrypointKeywordArgs": { "type": "array", "description": "A list of the keyword arguments that need to be specified for this task.", "items": { "type": "string" } }, "pluginFileResourceSnapshotId": { "type": "integer", "description": "Resource snapshot ID of the plugin file containing the task." } }, "type": "object" }, "DraftsEntrypointDraft-load": { "required": [ "group", "name", "taskGraph" ], "properties": { "group": { "type": "integer", "description": "ID of the Group that will own the Entrypoint resource." }, "name": { "type": "string", "description": "Name of the Entrypoint resource." }, "description": { "type": "string", "description": "Description of the Entrypoint resource." }, "taskGraph": { "type": "string", "description": "Task graph of the Entrypoint resource." }, "artifactGraph": { "type": "string", "description": "Artifact graph of the Entrypoint resource." }, "parameters": { "type": "array", "items": { "description": "List of parameters for the entrypoint.", "default": [], "allOf": [ { "$ref": "#/components/schemas/EntrypointParameter" } ] } }, "artifactParameters": { "type": "array", "items": { "description": "List of artifacts for the entrypoint.", "default": [], "allOf": [ { "$ref": "#/components/schemas/EntrypointArtifact" } ] } }, "queues": { "type": "array", "description": "The queue for the entrypoint.", "items": { "type": "integer" } }, "plugins": { "type": "array", "description": "List of plugin files for the entrypoint.", "items": { "type": "integer" } }, "artifactPlugins": { "type": "array", "description": "List of artifact plugin files for the entrypoint.", "items": { "type": "integer" } } }, "type": "object" }, "Draft-dump": { "properties": { "id": { "type": "integer", "description": "ID of the Draft." }, "group": { "description": "Group that owns the draft resource.", "allOf": [ { "$ref": "#/components/schemas/GroupRef" } ] }, "user": { "description": "User that created the draft resource.", "allOf": [ { "$ref": "#/components/schemas/UserRef-dump" } ] }, "payload": { "type": "object", "description": "The contents of the draft resource." }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the draft resource was created." }, "lastModifiedOn": { "type": "string", "format": "date-time", "description": "Timestamp when the draft resource was last modified." }, "resourceType": { "type": "string", "description": "The type of resource of this draft." }, "resource": { "type": "integer", "description": "ID of the resource this draft modifies." }, "resourceSnapshot": { "type": "integer", "description": "ID of the resource snapshot this draft modifies." }, "metadata": { "type": "object", "description": "Additional metadata about the draft" } }, "type": "object" }, "DraftPage": { "properties": { "index": { "type": "integer", "description": "Starting index of the current page." }, "isComplete": { "type": "boolean", "description": "Boolean indicating if more data is available." }, "totalNumResults": { "type": "integer", "description": "Total number of results." }, "first": { "type": "string", "description": "URL to first page in results set." }, "next": { "type": "string", "description": "URL to next page in results set." }, "prev": { "type": "string", "description": "URL to last page in results set." }, "data": { "type": "array", "items": { "description": "List of Drafts in the current page.", "allOf": [ { "$ref": "#/components/schemas/Draft-dump" } ] } } }, "type": "object" }, "DraftsIdEntrypointDraft-load": { "required": [ "name", "taskGraph" ], "properties": { "name": { "type": "string", "description": "Name of the Entrypoint resource." }, "description": { "type": "string", "description": "Description of the Entrypoint resource." }, "taskGraph": { "type": "string", "description": "Task graph of the Entrypoint resource." }, "artifactGraph": { "type": "string", "description": "Artifact graph of the Entrypoint resource." }, "parameters": { "type": "array", "items": { "description": "List of parameters for the entrypoint.", "default": [], "allOf": [ { "$ref": "#/components/schemas/EntrypointParameter" } ] } }, "artifactParameters": { "type": "array", "items": { "description": "List of artifacts for the entrypoint.", "default": [], "allOf": [ { "$ref": "#/components/schemas/EntrypointArtifact" } ] } }, "queues": { "type": "array", "description": "The queue for the entrypoint.", "items": { "type": "integer" } }, "plugins": { "type": "array", "description": "List of plugin files for the entrypoint.", "items": { "type": "integer" } }, "artifactPlugins": { "type": "array", "description": "List of artifact plugin files for the entrypoint.", "items": { "type": "integer" } } }, "type": "object" }, "ModifyDraftEntrypointDraft": { "properties": { "resourceSnapshot": { "type": "integer", "description": "ID of the resource snapshot this draft modifies." }, "resourceData": { "description": "Draft resource data.", "allOf": [ { "$ref": "#/components/schemas/EntrypointDraft-load" } ] } }, "type": "object" }, "EntrypointDraft-load": { "required": [ "name", "taskGraph" ], "properties": { "name": { "type": "string", "description": "Name of the Entrypoint resource." }, "description": { "type": "string", "description": "Description of the Entrypoint resource." }, "taskGraph": { "type": "string", "description": "Task graph of the Entrypoint resource." }, "artifactGraph": { "type": "string", "description": "Artifact graph of the Entrypoint resource." }, "parameters": { "type": "array", "items": { "description": "List of parameters for the entrypoint.", "default": [], "allOf": [ { "$ref": "#/components/schemas/EntrypointParameter" } ] } }, "artifactParameters": { "type": "array", "items": { "description": "List of artifacts for the entrypoint.", "default": [], "allOf": [ { "$ref": "#/components/schemas/EntrypointArtifact" } ] } }, "queues": { "type": "array", "description": "The queue for the entrypoint.", "items": { "type": "integer" } }, "artifactPlugins": { "type": "array", "description": "List of artifact plugin files for the entrypoint.", "items": { "type": "integer" } } }, "type": "object" }, "CreateDraftEntrypointDraft-load": { "required": [ "name", "taskGraph" ], "properties": { "name": { "type": "string", "description": "Name of the Entrypoint resource." }, "description": { "type": "string", "description": "Description of the Entrypoint resource." }, "taskGraph": { "type": "string", "description": "Task graph of the Entrypoint resource." }, "artifactGraph": { "type": "string", "description": "Artifact graph of the Entrypoint resource." }, "parameters": { "type": "array", "items": { "description": "List of parameters for the entrypoint.", "default": [], "allOf": [ { "$ref": "#/components/schemas/EntrypointParameter" } ] } }, "artifactParameters": { "type": "array", "items": { "description": "List of artifacts for the entrypoint.", "default": [], "allOf": [ { "$ref": "#/components/schemas/EntrypointArtifact" } ] } }, "queues": { "type": "array", "description": "The queue for the entrypoint.", "items": { "type": "integer" } }, "artifactPlugins": { "type": "array", "description": "List of artifact plugin files for the entrypoint.", "items": { "type": "integer" } } }, "type": "object" }, "SnapshotsEntrypointPage": { "properties": { "index": { "type": "integer", "description": "Starting index of the current page." }, "isComplete": { "type": "boolean", "description": "Boolean indicating if more data is available." }, "totalNumResults": { "type": "integer", "description": "Total number of results." }, "first": { "type": "string", "description": "URL to first page in results set." }, "next": { "type": "string", "description": "URL to next page in results set." }, "prev": { "type": "string", "description": "URL to last page in results set." }, "data": { "type": "array", "items": { "description": "List of Entrypoint resources in the current page.", "allOf": [ { "$ref": "#/components/schemas/Entrypoint-dump" } ] } } }, "type": "object" }, "SnapshotsIdEntrypoint-dump": { "required": [ "name", "taskGraph" ], "properties": { "id": { "type": "integer", "description": "ID for the Entrypoint resource." }, "snapshot": { "type": "integer", "description": "ID for the underlying Entrypoint snapshot." }, "group": { "description": "Group that owns the Entrypoint resource.", "allOf": [ { "$ref": "#/components/schemas/GroupRef" } ] }, "user": { "description": "User that created the Entrypoint resource.", "allOf": [ { "$ref": "#/components/schemas/UserRef-dump" } ] }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the Entrypoint resource was created." }, "snapshotCreatedOn": { "type": "string", "format": "date-time", "description": "Timestamp when the Entrypoint resource snapshot was created." }, "lastModifiedOn": { "type": "string", "format": "date-time", "description": "Timestamp when the Entrypoint resource was last modified." }, "latestSnapshot": { "type": "boolean", "description": "Whether or not the Entrypoint resource is the latest version." }, "hasDraft": { "type": "boolean", "description": "Whether a draft exists for the Entrypoint resource." }, "tags": { "type": "array", "items": { "description": "Tags associated with the Entrypoint resource.", "allOf": [ { "$ref": "#/components/schemas/TagRef-dump" } ] } }, "deleted": { "type": "boolean", "description": "Whether the Entrypoint resource has been deleted.", "default": false }, "name": { "type": "string", "description": "Name of the Entrypoint resource." }, "description": { "type": "string", "description": "Description of the Entrypoint resource." }, "taskGraph": { "type": "string", "description": "Task graph of the Entrypoint resource." }, "artifactGraph": { "type": "string", "description": "Artifact graph of the Entrypoint resource." }, "parameters": { "type": "array", "items": { "description": "List of parameters for the entrypoint.", "default": [], "allOf": [ { "$ref": "#/components/schemas/EntrypointParameter" } ] } }, "artifactParameters": { "type": "array", "items": { "description": "List of artifacts for the entrypoint.", "default": [], "allOf": [ { "$ref": "#/components/schemas/EntrypointArtifact" } ] } }, "plugins": { "type": "array", "items": { "description": "List of plugins for the entrypoint.", "allOf": [ { "$ref": "#/components/schemas/EntrypointPlugin" } ] } }, "artifactPlugins": { "type": "array", "items": { "description": "List of artifact plugins for the entrypoint.", "allOf": [ { "$ref": "#/components/schemas/EntrypointPlugin" } ] } }, "queues": { "type": "array", "items": { "description": "The queue for the entrypoint.", "allOf": [ { "$ref": "#/components/schemas/QueueRef-dump" } ] } } }, "type": "object" }, "Experiment-load": { "required": [ "group", "name" ], "properties": { "group": { "type": "integer", "description": "ID of the Group that will own the Experiment resource." }, "name": { "type": "string", "description": "Name of the Experiment resource." }, "description": { "type": "string", "description": "Description of the Experiment resource." }, "entrypoints": { "type": "array", "description": "A list of Entrypoint IDs.", "default": [], "items": { "type": "integer" } } }, "type": "object" }, "Experiment-dump": { "required": [ "name" ], "properties": { "id": { "type": "integer", "description": "ID for the Experiment resource." }, "snapshot": { "type": "integer", "description": "ID for the underlying Experiment snapshot." }, "group": { "description": "Group that owns the Experiment resource.", "allOf": [ { "$ref": "#/components/schemas/GroupRef" } ] }, "user": { "description": "User that created the Experiment resource.", "allOf": [ { "$ref": "#/components/schemas/UserRef-dump" } ] }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the Experiment resource was created." }, "snapshotCreatedOn": { "type": "string", "format": "date-time", "description": "Timestamp when the Experiment resource snapshot was created." }, "lastModifiedOn": { "type": "string", "format": "date-time", "description": "Timestamp when the Experiment resource was last modified." }, "latestSnapshot": { "type": "boolean", "description": "Whether or not the Experiment resource is the latest version." }, "hasDraft": { "type": "boolean", "description": "Whether a draft exists for the Experiment resource." }, "tags": { "type": "array", "items": { "description": "Tags associated with the Experiment resource.", "allOf": [ { "$ref": "#/components/schemas/TagRef-dump" } ] } }, "deleted": { "type": "boolean", "description": "Whether the Experiment resource has been deleted.", "default": false }, "name": { "type": "string", "description": "Name of the Experiment resource." }, "description": { "type": "string", "description": "Description of the Experiment resource." }, "entrypoints": { "type": "array", "items": { "description": "List of associated Entrypoint resources.", "allOf": [ { "$ref": "#/components/schemas/EntrypointRef-dump" } ] } } }, "type": "object" }, "EntrypointRef-dump": { "properties": { "id": { "type": "integer", "description": "ID for the Entrypoint resource." }, "group": { "description": "Group that owns the Entrypoint resource.", "allOf": [ { "$ref": "#/components/schemas/GroupRef" } ] }, "url": { "type": "string", "description": "URL for accessing the full Entrypoint resource." }, "deleted": { "type": "boolean", "description": "Whether the Entrypoint resource has been deleted.", "default": false }, "name": { "type": "string", "description": "Name of the Entrypoint resource." } }, "type": "object" }, "ExperimentPage": { "properties": { "index": { "type": "integer", "description": "Starting index of the current page." }, "isComplete": { "type": "boolean", "description": "Boolean indicating if more data is available." }, "totalNumResults": { "type": "integer", "description": "Total number of results." }, "first": { "type": "string", "description": "URL to first page in results set." }, "next": { "type": "string", "description": "URL to next page in results set." }, "prev": { "type": "string", "description": "URL to last page in results set." }, "data": { "type": "array", "items": { "description": "List of Experiment resources in the current page.", "allOf": [ { "$ref": "#/components/schemas/Experiment-dump" } ] } } }, "type": "object" }, "ExperimentMutableFields-load": { "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Name of the Experiment resource." }, "description": { "type": "string", "description": "Description of the Experiment resource." }, "entrypoints": { "type": "array", "description": "A list of Entrypoint IDs.", "default": [], "items": { "type": "integer" } } }, "type": "object" }, "JobCreateRequest-load": { "required": [ "entrypoint", "queue" ], "properties": { "description": { "type": "string", "description": "Description of the Job resource." }, "queue": { "type": "integer", "description": "An integer identifying a registered queue." }, "entrypoint": { "type": "integer", "description": "An integer identifying a registered entry point." }, "values": { "type": "object", "description": "A dictionary of keyword arguments to pass to the Job's Entrypoint.", "default": {} }, "artifactValues": { "type": "object", "description": "A dictionary of artifacts to pass to the Job's Entrypoint." }, "timeout": { "type": "string", "description": "The maximum alloted time for a job before it times out and is stopped. If omitted, the job timeout will default to 24 hours.", "default": "24h" }, "swaps": { "type": "array", "description": "List of swap definitions for the job.", "default": [], "items": { "$ref": "#/components/schemas/SwapChoice" } }, "entrypointSnapshot": { "type": "integer", "description": "An integer identifying a snapshot ID associated with the entrypoint. If specified, the snapshotted version of the entrypoint will be used to run the job. If not specified, the job will default to using the latest version of the entrypoint." } }, "type": "object" }, "SwapChoice": { "required": [ "swap_name", "task_alias" ], "properties": { "swap_name": { "type": "string", "description": "Name of the swap." }, "task_alias": { "type": "string", "description": "Alias of the chosen task." } }, "type": "object" }, "Job-dump": { "properties": { "id": { "type": "integer", "description": "ID for the Job resource." }, "snapshot": { "type": "integer", "description": "ID for the underlying Job snapshot." }, "group": { "description": "Group that owns the Job resource.", "allOf": [ { "$ref": "#/components/schemas/GroupRef" } ] }, "user": { "description": "User that created the Job resource.", "allOf": [ { "$ref": "#/components/schemas/UserRef-dump" } ] }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the Job resource was created." }, "snapshotCreatedOn": { "type": "string", "format": "date-time", "description": "Timestamp when the Job resource snapshot was created." }, "lastModifiedOn": { "type": "string", "format": "date-time", "description": "Timestamp when the Job resource was last modified." }, "latestSnapshot": { "type": "boolean", "description": "Whether or not the Job resource is the latest version." }, "hasDraft": { "type": "boolean", "description": "Whether a draft exists for the Job resource." }, "tags": { "type": "array", "items": { "description": "Tags associated with the Job resource.", "allOf": [ { "$ref": "#/components/schemas/TagRef-dump" } ] } }, "deleted": { "type": "boolean", "description": "Whether the Job resource has been deleted.", "default": false }, "description": { "type": "string", "description": "Description of the Job resource." }, "queue": { "description": "The active queue used to run the Job.", "allOf": [ { "$ref": "#/components/schemas/QueueSnapshotRef-dump" } ] }, "experiment": { "description": "The registered experiment associated with the Job.", "allOf": [ { "$ref": "#/components/schemas/ExperimentSnapshotRef-dump" } ] }, "entrypoint": { "description": "The entry point associated with the Job.", "allOf": [ { "$ref": "#/components/schemas/EntrypointSnapshotRef-dump" } ] }, "values": { "type": "object", "description": "A dictionary of keyword arguments to pass to the Job's Entrypoint.", "default": {} }, "artifactValues": { "type": "object", "description": "A dictionary of artifacts to pass to the Job's Entrypoint." }, "timeout": { "type": "string", "description": "The maximum alloted time for a job before it times out and is stopped. If omitted, the job timeout will default to 24 hours.", "default": "24h" }, "status": { "type": "string", "description": "The current status of the job. The allowed values are: queued, started, deferred, finished, failed." }, "artifacts": { "type": "array", "items": { "description": "Artifacts created by the Job resource.", "allOf": [ { "$ref": "#/components/schemas/ArtifactRef-dump" } ] } }, "swaps": { "type": "array", "description": "Swap choices selected for the Job resource.", "items": { "$ref": "#/components/schemas/JobSwap-dump" } } }, "type": "object" }, "QueueSnapshotRef-dump": { "properties": { "id": { "type": "integer", "description": "ID for the Queue resource." }, "snapshotId": { "type": "integer", "description": "Snapshot ID for the Queue resource." }, "group": { "description": "Group that owns the Queue resource.", "allOf": [ { "$ref": "#/components/schemas/GroupRef" } ] }, "url": { "type": "string", "description": "URL for accessing the full Queue resource." }, "deleted": { "type": "boolean", "description": "Whether the Queue resource has been deleted.", "default": false }, "name": { "type": "string", "description": "Name of the Queue resource." } }, "type": "object" }, "ExperimentSnapshotRef-dump": { "properties": { "id": { "type": "integer", "description": "ID for the Experiment resource." }, "snapshotId": { "type": "integer", "description": "Snapshot ID for the Experiment resource." }, "group": { "description": "Group that owns the Experiment resource.", "allOf": [ { "$ref": "#/components/schemas/GroupRef" } ] }, "url": { "type": "string", "description": "URL for accessing the full Experiment resource." }, "deleted": { "type": "boolean", "description": "Whether the Experiment resource has been deleted.", "default": false }, "name": { "type": "string", "description": "Name of the Experiment resource." } }, "type": "object" }, "EntrypointSnapshotRef-dump": { "properties": { "id": { "type": "integer", "description": "ID for the Entrypoint resource." }, "snapshotId": { "type": "integer", "description": "Snapshot ID for the Entrypoint resource." }, "group": { "description": "Group that owns the Entrypoint resource.", "allOf": [ { "$ref": "#/components/schemas/GroupRef" } ] }, "url": { "type": "string", "description": "URL for accessing the full Entrypoint resource." }, "deleted": { "type": "boolean", "description": "Whether the Entrypoint resource has been deleted.", "default": false }, "name": { "type": "string", "description": "Name of the Entrypoint resource." } }, "type": "object" }, "ArtifactRef-dump": { "properties": { "id": { "type": "integer", "description": "ID for the Artifact resource." }, "group": { "description": "Group that owns the Artifact resource.", "allOf": [ { "$ref": "#/components/schemas/GroupRef" } ] }, "url": { "type": "string", "description": "URL for accessing the full Artifact Resource." }, "deleted": { "type": "boolean", "description": "Whether the Artifact resource has been deleted.", "default": false } }, "type": "object" }, "JobSwap-dump": { "properties": { "swapName": { "type": "string", "description": "Name of the swap." }, "taskAlias": { "type": "string", "description": "Alias of the chosen task." }, "pluginFileResourceSnapshotId": { "type": "integer", "description": "Resource snapshot ID of the plugin file containing the chosen task." } }, "type": "object" }, "JobPage": { "properties": { "index": { "type": "integer", "description": "Starting index of the current page." }, "isComplete": { "type": "boolean", "description": "Boolean indicating if more data is available." }, "totalNumResults": { "type": "integer", "description": "Total number of results." }, "first": { "type": "string", "description": "URL to first page in results set." }, "next": { "type": "string", "description": "URL to next page in results set." }, "prev": { "type": "string", "description": "URL to last page in results set." }, "data": { "type": "array", "items": { "description": "List of Job resources in the current page.", "allOf": [ { "$ref": "#/components/schemas/Job-dump" } ] } } }, "type": "object" }, "JobStatus-load": { "properties": { "status": { "type": "string", "description": "The current status of the job. The allowed values are: queued, started, deferred, finished, failed, reset." } }, "type": "object" }, "JobStatus-dump": { "properties": { "id": { "type": "integer", "description": "ID for the Job resource." }, "status": { "type": "string", "description": "The current status of the job. The allowed values are: queued, started, deferred, finished, failed, reset." } }, "type": "object" }, "JobMlflowRun": { "properties": { "mlflowRunId": { "type": "string", "description": "UUID for the associated Mlflow Run." } }, "type": "object" }, "ExperimentJobsMetrics": { "properties": { "index": { "type": "integer", "description": "Starting index of the current page." }, "isComplete": { "type": "boolean", "description": "Boolean indicating if more data is available." }, "totalNumResults": { "type": "integer", "description": "Total number of results." }, "first": { "type": "string", "description": "URL to first page in results set." }, "next": { "type": "string", "description": "URL to next page in results set." }, "prev": { "type": "string", "description": "URL to last page in results set." }, "data": { "type": "array", "items": { "description": "List of metrics for each job in the experiment", "allOf": [ { "$ref": "#/components/schemas/JobIdMetrics-dump" } ] } } }, "type": "object" }, "JobIdMetrics-dump": { "properties": { "id": { "type": "integer", "description": "ID for the Job resource." }, "metrics": { "type": "array", "items": { "description": "A list of the latest metrics associated with the job.", "allOf": [ { "$ref": "#/components/schemas/Metrics-dump" } ] } } }, "type": "object" }, "Metrics-dump": { "required": [ "name", "value" ], "properties": { "name": { "type": "string", "description": "The name of the metric." }, "value": { "type": "number", "description": "The value of the metric. Can be a float, NaN, Infinity, or -Infinity. NaN values are represented with the string \"nan\" and infinite values are represented with the strings \"inf\" and \"-inf\"." } }, "type": "object" }, "DraftsExperimentDraft-load": { "required": [ "group", "name" ], "properties": { "group": { "type": "integer", "description": "ID of the Group that will own the Experiment resource." }, "name": { "type": "string", "description": "Name of the Experiment resource." }, "description": { "type": "string", "description": "Description of the Experiment resource." }, "entrypoints": { "type": "array", "description": "A list of Entrypoint IDs.", "default": [], "items": { "type": "integer" } } }, "type": "object" }, "DraftsIdExperimentDraft-load": { "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Name of the Experiment resource." }, "description": { "type": "string", "description": "Description of the Experiment resource." }, "entrypoints": { "type": "array", "description": "A list of Entrypoint IDs.", "default": [], "items": { "type": "integer" } } }, "type": "object" }, "ModifyDraftExperimentDraft": { "properties": { "resourceSnapshot": { "type": "integer", "description": "ID of the resource snapshot this draft modifies." }, "resourceData": { "description": "Draft resource data.", "allOf": [ { "$ref": "#/components/schemas/ExperimentDraft-load" } ] } }, "type": "object" }, "ExperimentDraft-load": { "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Name of the Experiment resource." }, "description": { "type": "string", "description": "Description of the Experiment resource." }, "entrypoints": { "type": "array", "description": "A list of Entrypoint IDs.", "default": [], "items": { "type": "integer" } } }, "type": "object" }, "CreateDraftExperimentDraft-load": { "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Name of the Experiment resource." }, "description": { "type": "string", "description": "Description of the Experiment resource." }, "entrypoints": { "type": "array", "description": "A list of Entrypoint IDs.", "default": [], "items": { "type": "integer" } } }, "type": "object" }, "SnapshotsExperimentPage": { "properties": { "index": { "type": "integer", "description": "Starting index of the current page." }, "isComplete": { "type": "boolean", "description": "Boolean indicating if more data is available." }, "totalNumResults": { "type": "integer", "description": "Total number of results." }, "first": { "type": "string", "description": "URL to first page in results set." }, "next": { "type": "string", "description": "URL to next page in results set." }, "prev": { "type": "string", "description": "URL to last page in results set." }, "data": { "type": "array", "items": { "description": "List of Experiment resources in the current page.", "allOf": [ { "$ref": "#/components/schemas/Experiment-dump" } ] } } }, "type": "object" }, "SnapshotsIdExperiment-dump": { "required": [ "name" ], "properties": { "id": { "type": "integer", "description": "ID for the Experiment resource." }, "snapshot": { "type": "integer", "description": "ID for the underlying Experiment snapshot." }, "group": { "description": "Group that owns the Experiment resource.", "allOf": [ { "$ref": "#/components/schemas/GroupRef" } ] }, "user": { "description": "User that created the Experiment resource.", "allOf": [ { "$ref": "#/components/schemas/UserRef-dump" } ] }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the Experiment resource was created." }, "snapshotCreatedOn": { "type": "string", "format": "date-time", "description": "Timestamp when the Experiment resource snapshot was created." }, "lastModifiedOn": { "type": "string", "format": "date-time", "description": "Timestamp when the Experiment resource was last modified." }, "latestSnapshot": { "type": "boolean", "description": "Whether or not the Experiment resource is the latest version." }, "hasDraft": { "type": "boolean", "description": "Whether a draft exists for the Experiment resource." }, "tags": { "type": "array", "items": { "description": "Tags associated with the Experiment resource.", "allOf": [ { "$ref": "#/components/schemas/TagRef-dump" } ] } }, "deleted": { "type": "boolean", "description": "Whether the Experiment resource has been deleted.", "default": false }, "name": { "type": "string", "description": "Name of the Experiment resource." }, "description": { "type": "string", "description": "Description of the Experiment resource." }, "entrypoints": { "type": "array", "items": { "description": "List of associated Entrypoint resources.", "allOf": [ { "$ref": "#/components/schemas/EntrypointRef-dump" } ] } } }, "type": "object" }, "GroupPage": { "properties": { "index": { "type": "integer", "description": "Starting index of the current page." }, "isComplete": { "type": "boolean", "description": "Boolean indicating if more data is available." }, "totalNumResults": { "type": "integer", "description": "Total number of results." }, "first": { "type": "string", "description": "URL to first page in results set." }, "next": { "type": "string", "description": "URL to next page in results set." }, "prev": { "type": "string", "description": "URL to last page in results set." }, "data": { "type": "array", "items": { "description": "List of Group resources in the current page.", "allOf": [ { "$ref": "#/components/schemas/Group-dump" } ] } } }, "type": "object" }, "Group-dump": { "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Name of the Group." }, "id": { "type": "integer", "description": "ID for the Group resource." }, "user": { "description": "User that created the Group resource.", "allOf": [ { "$ref": "#/components/schemas/UserRef-dump" } ] }, "members": { "type": "array", "items": { "description": "A list of GroupMembers in a Group.", "allOf": [ { "$ref": "#/components/schemas/GroupMember-dump" } ] } }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the Group resource was created." }, "lastModifiedOn": { "type": "string", "format": "date-time", "description": "Timestamp when the Group resource was last modified." } }, "type": "object" }, "GroupMember-dump": { "properties": { "user": { "description": "User that is a member of the Group.", "allOf": [ { "$ref": "#/components/schemas/UserRef-dump" } ] }, "group": { "description": "The Group of which the User is a member.", "allOf": [ { "$ref": "#/components/schemas/GroupRef" } ] }, "permissions": { "description": "The Group Permissions for this User.", "allOf": [ { "$ref": "#/components/schemas/Generated-dump" } ] } }, "type": "object" }, "Generated-dump": { "properties": { "read": { "type": "boolean", "description": "Permission for member to read Group." }, "write": { "type": "boolean", "description": "Permission for member to modify Group." }, "shareRead": { "type": "boolean", "description": "Permission for member to share read-only Group." }, "shareWrite": { "type": "boolean", "description": "Permission for member to share read+write Group." }, "owner": { "type": "boolean", "description": "Flag for if the member is a Group owner." }, "admin": { "type": "boolean", "description": "Flag for if the member is a Group admin." } }, "type": "object" }, "JobConfig": { "properties": { "types": { "type": "object", "description": "A dictionary of types defined for this experiment.", "default": {} }, "parameters": { "type": "object", "description": "A dictionary of parameters defined for this experiment.", "default": {} }, "tasks": { "type": "object", "description": "A dictionary of tasks defined for this experiment.", "default": {} }, "graph": { "type": "object", "description": "A dictionary representing the task graph for this experiment.", "default": {} }, "artifact_outputs": { "type": "object", "description": "A dictionary representing the artifact outputs for this experiment.", "default": {} }, "artifact_inputs": { "type": "object", "description": "A dictionary representing the artifact inputs for this experiment.", "default": {} } }, "type": "object" }, "Metrics-load": { "required": [ "name", "value" ], "properties": { "name": { "type": "string", "description": "The name of the metric." }, "value": { "type": "number", "description": "The value of the metric. Can be a float, NaN, Infinity, or -Infinity. NaN values are represented with the string \"nan\" and infinite values are represented with the strings \"inf\" and \"-inf\"." }, "step": { "type": "integer", "description": "The step value for the metric, optional. Sequentially increasing step values are used to track how a metric changes over time. Indexed from 0. If not provided, defaults to 0.", "default": 0 }, "timestamp": { "type": "string", "format": "date-time", "description": "A timestamp value to associate with the metric. If not provided, defaults to the server time when the metric is received." } }, "type": "object" }, "MetricsSnapshotPage": { "properties": { "index": { "type": "integer", "description": "Starting index of the current page." }, "isComplete": { "type": "boolean", "description": "Boolean indicating if more data is available." }, "totalNumResults": { "type": "integer", "description": "Total number of results." }, "first": { "type": "string", "description": "URL to first page in results set." }, "next": { "type": "string", "description": "URL to next page in results set." }, "prev": { "type": "string", "description": "URL to last page in results set." }, "data": { "type": "array", "items": { "description": "List of Metric Snapshots in the current page.", "allOf": [ { "$ref": "#/components/schemas/MetricsSnapshot" } ] } } }, "type": "object" }, "MetricsSnapshot": { "properties": { "name": { "type": "string", "description": "The name of the metric." }, "value": { "type": "number", "description": "The value of the metric. Can be a float, NaN, Infinity, or -Infinity. NaN values are represented with the string \"nan\" and infinite values are represented with the strings \"inf\" and \"-inf\"." }, "step": { "type": "integer", "description": "The step value for the metric, indexed from 0. Sequentially increasing step values track a metric changing over time." }, "timestamp": { "type": "string", "format": "date-time", "description": "The timestamp for the metric." } }, "type": "object" }, "JobLogRecords": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/JobLogRecord-load" } } }, "type": "object" }, "JobLogRecord-load": { "required": [ "loggerName", "message" ], "properties": { "loggerName": { "type": "string", "description": "The name of the logger that emitted the log message." }, "message": { "type": "string", "description": "The logged message." } }, "type": "object" }, "JobLogRecord-dump": { "required": [ "loggerName", "message" ], "properties": { "loggerName": { "type": "string", "description": "The name of the logger that emitted the log message." }, "message": { "type": "string", "description": "The logged message." }, "createdOn": { "type": "string", "format": "date-time", "description": "Server timestamp for when the job log was received." } }, "type": "object" }, "JobLogRecordsPage": { "properties": { "index": { "type": "integer", "description": "Starting index of the current page." }, "isComplete": { "type": "boolean", "description": "Boolean indicating if more data is available." }, "totalNumResults": { "type": "integer", "description": "Total number of results." }, "first": { "type": "string", "description": "URL to first page in results set." }, "next": { "type": "string", "description": "URL to next page in results set." }, "prev": { "type": "string", "description": "URL to last page in results set." }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/JobLogRecord-dump" } } }, "type": "object" }, "SnapshotsJobPage": { "properties": { "index": { "type": "integer", "description": "Starting index of the current page." }, "isComplete": { "type": "boolean", "description": "Boolean indicating if more data is available." }, "totalNumResults": { "type": "integer", "description": "Total number of results." }, "first": { "type": "string", "description": "URL to first page in results set." }, "next": { "type": "string", "description": "URL to next page in results set." }, "prev": { "type": "string", "description": "URL to last page in results set." }, "data": { "type": "array", "items": { "description": "List of Job resources in the current page.", "allOf": [ { "$ref": "#/components/schemas/Job-dump" } ] } } }, "type": "object" }, "SnapshotsIdJob-dump": { "properties": { "id": { "type": "integer", "description": "ID for the Job resource." }, "snapshot": { "type": "integer", "description": "ID for the underlying Job snapshot." }, "group": { "description": "Group that owns the Job resource.", "allOf": [ { "$ref": "#/components/schemas/GroupRef" } ] }, "user": { "description": "User that created the Job resource.", "allOf": [ { "$ref": "#/components/schemas/UserRef-dump" } ] }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the Job resource was created." }, "snapshotCreatedOn": { "type": "string", "format": "date-time", "description": "Timestamp when the Job resource snapshot was created." }, "lastModifiedOn": { "type": "string", "format": "date-time", "description": "Timestamp when the Job resource was last modified." }, "latestSnapshot": { "type": "boolean", "description": "Whether or not the Job resource is the latest version." }, "hasDraft": { "type": "boolean", "description": "Whether a draft exists for the Job resource." }, "tags": { "type": "array", "items": { "description": "Tags associated with the Job resource.", "allOf": [ { "$ref": "#/components/schemas/TagRef-dump" } ] } }, "deleted": { "type": "boolean", "description": "Whether the Job resource has been deleted.", "default": false }, "description": { "type": "string", "description": "Description of the Job resource." }, "queue": { "description": "The active queue used to run the Job.", "allOf": [ { "$ref": "#/components/schemas/QueueSnapshotRef-dump" } ] }, "experiment": { "description": "The registered experiment associated with the Job.", "allOf": [ { "$ref": "#/components/schemas/ExperimentSnapshotRef-dump" } ] }, "entrypoint": { "description": "The entry point associated with the Job.", "allOf": [ { "$ref": "#/components/schemas/EntrypointSnapshotRef-dump" } ] }, "values": { "type": "object", "description": "A dictionary of keyword arguments to pass to the Job's Entrypoint.", "default": {} }, "artifactValues": { "type": "object", "description": "A dictionary of artifacts to pass to the Job's Entrypoint." }, "timeout": { "type": "string", "description": "The maximum alloted time for a job before it times out and is stopped. If omitted, the job timeout will default to 24 hours.", "default": "24h" }, "status": { "type": "string", "description": "The current status of the job. The allowed values are: queued, started, deferred, finished, failed." }, "artifacts": { "type": "array", "items": { "description": "Artifacts created by the Job resource.", "allOf": [ { "$ref": "#/components/schemas/ArtifactRef-dump" } ] } }, "swaps": { "type": "array", "description": "Swap choices selected for the Job resource.", "items": { "$ref": "#/components/schemas/JobSwap-dump" } } }, "type": "object" }, "Model-load": { "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Name of the Model resource." }, "description": { "type": "string", "description": "Description of the Model resource." } }, "type": "object" }, "Model-dump": { "required": [ "name" ], "properties": { "id": { "type": "integer", "description": "ID for the Model resource." }, "snapshot": { "type": "integer", "description": "ID for the underlying Model snapshot." }, "group": { "description": "Group that owns the Model resource.", "allOf": [ { "$ref": "#/components/schemas/GroupRef" } ] }, "user": { "description": "User that created the Model resource.", "allOf": [ { "$ref": "#/components/schemas/UserRef-dump" } ] }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the Model resource was created." }, "snapshotCreatedOn": { "type": "string", "format": "date-time", "description": "Timestamp when the Model resource snapshot was created." }, "lastModifiedOn": { "type": "string", "format": "date-time", "description": "Timestamp when the Model resource was last modified." }, "latestSnapshot": { "type": "boolean", "description": "Whether or not the Model resource is the latest version." }, "hasDraft": { "type": "boolean", "description": "Whether a draft exists for the Model resource." }, "tags": { "type": "array", "items": { "description": "Tags associated with the Model resource.", "allOf": [ { "$ref": "#/components/schemas/TagRef-dump" } ] } }, "deleted": { "type": "boolean", "description": "Whether the Model resource has been deleted.", "default": false }, "name": { "type": "string", "description": "Name of the Model resource." }, "description": { "type": "string", "description": "Description of the Model resource." }, "versions": { "type": "array", "items": { "description": "The details of this model version.", "allOf": [ { "$ref": "#/components/schemas/ModelVersionRef-dump" } ] } }, "latestVersion": { "description": "The details of latest version of this model.", "allOf": [ { "$ref": "#/components/schemas/ModelVersion-dump" } ] } }, "type": "object" }, "ModelVersionRef-dump": { "properties": { "versionNumber": { "type": "integer", "description": "The version number of the Model." }, "url": { "type": "string", "description": "URL for accessing the full Model Version." } }, "type": "object" }, "ModelVersion-dump": { "properties": { "description": { "type": "string", "description": "Description of the Model Version." }, "model": { "description": "The Model resource.", "allOf": [ { "$ref": "#/components/schemas/ModelRef-dump" } ] }, "artifact": { "description": "The artifact representing the Model Version.", "allOf": [ { "$ref": "#/components/schemas/ArtifactRef-dump" } ] }, "versionNumber": { "type": "integer", "description": "The version number of the Model." }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the Model Version was created." } }, "type": "object" }, "ModelRef-dump": { "required": [ "name" ], "properties": { "id": { "type": "integer", "description": "ID for the Model resource." }, "group": { "description": "Group that owns the Model resource.", "allOf": [ { "$ref": "#/components/schemas/GroupRef" } ] }, "url": { "type": "string", "description": "URL for accessing the full Model resource." }, "deleted": { "type": "boolean", "description": "Whether the Model resource has been deleted.", "default": false }, "name": { "type": "string", "description": "Name of the Model resource." } }, "type": "object" }, "ModelPage": { "properties": { "index": { "type": "integer", "description": "Starting index of the current page." }, "isComplete": { "type": "boolean", "description": "Boolean indicating if more data is available." }, "totalNumResults": { "type": "integer", "description": "Total number of results." }, "first": { "type": "string", "description": "URL to first page in results set." }, "next": { "type": "string", "description": "URL to next page in results set." }, "prev": { "type": "string", "description": "URL to last page in results set." }, "data": { "type": "array", "items": { "description": "List of Model resources in the current page.", "allOf": [ { "$ref": "#/components/schemas/Model-dump" } ] } } }, "type": "object" }, "ModelMutableFields": { "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Name of the Model resource." }, "description": { "type": "string", "description": "Description of the Model resource." } }, "type": "object" }, "ModelVersion-load": { "required": [ "artifact" ], "properties": { "description": { "type": "string", "description": "Description of the Model Version." }, "artifact": { "type": "integer", "description": "The artifact representing the Model Version." } }, "type": "object" }, "ModelVersionPage": { "properties": { "index": { "type": "integer", "description": "Starting index of the current page." }, "isComplete": { "type": "boolean", "description": "Boolean indicating if more data is available." }, "totalNumResults": { "type": "integer", "description": "Total number of results." }, "first": { "type": "string", "description": "URL to first page in results set." }, "next": { "type": "string", "description": "URL to next page in results set." }, "prev": { "type": "string", "description": "URL to last page in results set." }, "data": { "type": "array", "items": { "description": "List of Model resources in the current page.", "allOf": [ { "$ref": "#/components/schemas/ModelVersion-dump" } ] } } }, "type": "object" }, "ModelVersionMutableFields": { "properties": { "description": { "type": "string", "description": "Description of the Model Version." } }, "type": "object" }, "DraftsModel-load": { "required": [ "group", "name" ], "properties": { "group": { "type": "integer", "description": "ID of the Group that will own the Model resource." }, "name": { "type": "string", "description": "Name of the Model resource." }, "description": { "type": "string", "description": "Description of the Model resource." } }, "type": "object" }, "DraftsIdModel-load": { "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Name of the Model resource." }, "description": { "type": "string", "description": "Description of the Model resource." } }, "type": "object" }, "ModifyDraftModel": { "properties": { "resourceSnapshot": { "type": "integer", "description": "ID of the resource snapshot this draft modifies." }, "resourceData": { "description": "Draft resource data.", "allOf": [ { "$ref": "#/components/schemas/Model-load" } ] } }, "type": "object" }, "CreateDraftModel-load": { "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Name of the Model resource." }, "description": { "type": "string", "description": "Description of the Model resource." } }, "type": "object" }, "SnapshotsModelPage": { "properties": { "index": { "type": "integer", "description": "Starting index of the current page." }, "isComplete": { "type": "boolean", "description": "Boolean indicating if more data is available." }, "totalNumResults": { "type": "integer", "description": "Total number of results." }, "first": { "type": "string", "description": "URL to first page in results set." }, "next": { "type": "string", "description": "URL to next page in results set." }, "prev": { "type": "string", "description": "URL to last page in results set." }, "data": { "type": "array", "items": { "description": "List of Model resources in the current page.", "allOf": [ { "$ref": "#/components/schemas/Model-dump" } ] } } }, "type": "object" }, "SnapshotsIdModel-dump": { "required": [ "name" ], "properties": { "id": { "type": "integer", "description": "ID for the Model resource." }, "snapshot": { "type": "integer", "description": "ID for the underlying Model snapshot." }, "group": { "description": "Group that owns the Model resource.", "allOf": [ { "$ref": "#/components/schemas/GroupRef" } ] }, "user": { "description": "User that created the Model resource.", "allOf": [ { "$ref": "#/components/schemas/UserRef-dump" } ] }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the Model resource was created." }, "snapshotCreatedOn": { "type": "string", "format": "date-time", "description": "Timestamp when the Model resource snapshot was created." }, "lastModifiedOn": { "type": "string", "format": "date-time", "description": "Timestamp when the Model resource was last modified." }, "latestSnapshot": { "type": "boolean", "description": "Whether or not the Model resource is the latest version." }, "hasDraft": { "type": "boolean", "description": "Whether a draft exists for the Model resource." }, "tags": { "type": "array", "items": { "description": "Tags associated with the Model resource.", "allOf": [ { "$ref": "#/components/schemas/TagRef-dump" } ] } }, "deleted": { "type": "boolean", "description": "Whether the Model resource has been deleted.", "default": false }, "name": { "type": "string", "description": "Name of the Model resource." }, "description": { "type": "string", "description": "Description of the Model resource." }, "versions": { "type": "array", "items": { "description": "The details of this model version.", "allOf": [ { "$ref": "#/components/schemas/ModelVersionRef-dump" } ] } }, "latestVersion": { "description": "The details of latest version of this model.", "allOf": [ { "$ref": "#/components/schemas/ModelVersion-dump" } ] } }, "type": "object" }, "PluginParameterType-load": { "required": [ "group", "name" ], "properties": { "group": { "type": "integer", "description": "ID of the Group that will own the PluginParameterType resource." }, "name": { "type": "string", "description": "Name of the PluginParameterType resource." }, "description": { "type": "string", "description": "Description of the PluginParameterType resource." }, "structure": { "type": "object", "description": "Structure of the PluginParameterType resource." } }, "type": "object" }, "PluginParameterType-dump": { "required": [ "name" ], "properties": { "id": { "type": "integer", "description": "ID for the PluginParameterType resource." }, "snapshot": { "type": "integer", "description": "ID for the underlying PluginParameterType snapshot." }, "group": { "description": "Group that owns the PluginParameterType resource.", "allOf": [ { "$ref": "#/components/schemas/GroupRef" } ] }, "user": { "description": "User that created the PluginParameterType resource.", "allOf": [ { "$ref": "#/components/schemas/UserRef-dump" } ] }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the PluginParameterType resource was created." }, "snapshotCreatedOn": { "type": "string", "format": "date-time", "description": "Timestamp when the PluginParameterType resource snapshot was created." }, "lastModifiedOn": { "type": "string", "format": "date-time", "description": "Timestamp when the PluginParameterType resource was last modified." }, "latestSnapshot": { "type": "boolean", "description": "Whether or not the PluginParameterType resource is the latest version." }, "hasDraft": { "type": "boolean", "description": "Whether a draft exists for the PluginParameterType resource." }, "tags": { "type": "array", "items": { "description": "Tags associated with the PluginParameterType resource.", "allOf": [ { "$ref": "#/components/schemas/TagRef-dump" } ] } }, "deleted": { "type": "boolean", "description": "Whether the PluginParameterType resource has been deleted.", "default": false }, "name": { "type": "string", "description": "Name of the PluginParameterType resource." }, "description": { "type": "string", "description": "Description of the PluginParameterType resource." }, "structure": { "type": "object", "description": "Structure of the PluginParameterType resource." } }, "type": "object" }, "PluginParameterTypePage": { "properties": { "index": { "type": "integer", "description": "Starting index of the current page." }, "isComplete": { "type": "boolean", "description": "Boolean indicating if more data is available." }, "totalNumResults": { "type": "integer", "description": "Total number of results." }, "first": { "type": "string", "description": "URL to first page in results set." }, "next": { "type": "string", "description": "URL to next page in results set." }, "prev": { "type": "string", "description": "URL to last page in results set." }, "data": { "type": "array", "items": { "description": "List of PluginParameterType resources in the current page.", "allOf": [ { "$ref": "#/components/schemas/PluginParameterType-dump" } ] } } }, "type": "object" }, "PluginParameterTypeMutableFields": { "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Name of the PluginParameterType resource." }, "description": { "type": "string", "description": "Description of the PluginParameterType resource." }, "structure": { "type": "object", "description": "Structure of the PluginParameterType resource." } }, "type": "object" }, "DraftsPluginParameterType-load": { "required": [ "group", "name" ], "properties": { "group": { "type": "integer", "description": "ID of the Group that will own the PluginParameterType resource." }, "name": { "type": "string", "description": "Name of the PluginParameterType resource." }, "description": { "type": "string", "description": "Description of the PluginParameterType resource." }, "structure": { "type": "object", "description": "Structure of the PluginParameterType resource." } }, "type": "object" }, "DraftsIdPluginParameterTypeMutableFields": { "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Name of the PluginParameterType resource." }, "description": { "type": "string", "description": "Description of the PluginParameterType resource." }, "structure": { "type": "object", "description": "Structure of the PluginParameterType resource." } }, "type": "object" }, "ModifyDraftPluginParameterTypeMutableFields": { "properties": { "resourceSnapshot": { "type": "integer", "description": "ID of the resource snapshot this draft modifies." }, "resourceData": { "description": "Draft resource data.", "allOf": [ { "$ref": "#/components/schemas/PluginParameterTypeMutableFields" } ] } }, "type": "object" }, "CreateDraftPluginParameterTypeMutableFields": { "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Name of the PluginParameterType resource." }, "description": { "type": "string", "description": "Description of the PluginParameterType resource." }, "structure": { "type": "object", "description": "Structure of the PluginParameterType resource." } }, "type": "object" }, "SnapshotsPluginParameterTypePage": { "properties": { "index": { "type": "integer", "description": "Starting index of the current page." }, "isComplete": { "type": "boolean", "description": "Boolean indicating if more data is available." }, "totalNumResults": { "type": "integer", "description": "Total number of results." }, "first": { "type": "string", "description": "URL to first page in results set." }, "next": { "type": "string", "description": "URL to next page in results set." }, "prev": { "type": "string", "description": "URL to last page in results set." }, "data": { "type": "array", "items": { "description": "List of PluginParameterType resources in the current page.", "allOf": [ { "$ref": "#/components/schemas/PluginParameterType-dump" } ] } } }, "type": "object" }, "SnapshotsIdPluginParameterType-dump": { "required": [ "name" ], "properties": { "id": { "type": "integer", "description": "ID for the PluginParameterType resource." }, "snapshot": { "type": "integer", "description": "ID for the underlying PluginParameterType snapshot." }, "group": { "description": "Group that owns the PluginParameterType resource.", "allOf": [ { "$ref": "#/components/schemas/GroupRef" } ] }, "user": { "description": "User that created the PluginParameterType resource.", "allOf": [ { "$ref": "#/components/schemas/UserRef-dump" } ] }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the PluginParameterType resource was created." }, "snapshotCreatedOn": { "type": "string", "format": "date-time", "description": "Timestamp when the PluginParameterType resource snapshot was created." }, "lastModifiedOn": { "type": "string", "format": "date-time", "description": "Timestamp when the PluginParameterType resource was last modified." }, "latestSnapshot": { "type": "boolean", "description": "Whether or not the PluginParameterType resource is the latest version." }, "hasDraft": { "type": "boolean", "description": "Whether a draft exists for the PluginParameterType resource." }, "tags": { "type": "array", "items": { "description": "Tags associated with the PluginParameterType resource.", "allOf": [ { "$ref": "#/components/schemas/TagRef-dump" } ] } }, "deleted": { "type": "boolean", "description": "Whether the PluginParameterType resource has been deleted.", "default": false }, "name": { "type": "string", "description": "Name of the PluginParameterType resource." }, "description": { "type": "string", "description": "Description of the PluginParameterType resource." }, "structure": { "type": "object", "description": "Structure of the PluginParameterType resource." } }, "type": "object" }, "NestedSnapshotsPluginFilePage": { "properties": { "index": { "type": "integer", "description": "Starting index of the current page." }, "isComplete": { "type": "boolean", "description": "Boolean indicating if more data is available." }, "totalNumResults": { "type": "integer", "description": "Total number of results." }, "first": { "type": "string", "description": "URL to first page in results set." }, "next": { "type": "string", "description": "URL to next page in results set." }, "prev": { "type": "string", "description": "URL to last page in results set." }, "data": { "type": "array", "items": { "description": "List of PluginFile resources in the current page.", "allOf": [ { "$ref": "#/components/schemas/PluginFile-dump" } ] } } }, "type": "object" }, "PluginFile-dump": { "required": [ "contents", "filename" ], "properties": { "id": { "type": "integer", "description": "ID for the PluginFile resource." }, "snapshot": { "type": "integer", "description": "ID for the underlying PluginFile snapshot." }, "group": { "description": "Group that owns the PluginFile resource.", "allOf": [ { "$ref": "#/components/schemas/GroupRef" } ] }, "user": { "description": "User that created the PluginFile resource.", "allOf": [ { "$ref": "#/components/schemas/UserRef-dump" } ] }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the PluginFile resource was created." }, "snapshotCreatedOn": { "type": "string", "format": "date-time", "description": "Timestamp when the PluginFile resource snapshot was created." }, "lastModifiedOn": { "type": "string", "format": "date-time", "description": "Timestamp when the PluginFile resource was last modified." }, "latestSnapshot": { "type": "boolean", "description": "Whether or not the PluginFile resource is the latest version." }, "hasDraft": { "type": "boolean", "description": "Whether a draft exists for the PluginFile resource." }, "tags": { "type": "array", "items": { "description": "Tags associated with the PluginFile resource.", "allOf": [ { "$ref": "#/components/schemas/TagRef-dump" } ] } }, "deleted": { "type": "boolean", "description": "Whether the PluginFile resource has been deleted.", "default": false }, "filename": { "type": "string", "description": "Name of the PluginFile resource." }, "contents": { "type": "string", "description": "Contents of the file." }, "tasks": { "description": "Tasks associated with the PluginFile resource.", "allOf": [ { "$ref": "#/components/schemas/PluginTaskContainer" } ] }, "description": { "type": "string", "description": "Description of the PluginFile resource." }, "plugin": { "description": "The Plugin resource this file belongs to.", "allOf": [ { "$ref": "#/components/schemas/PluginRef-dump" } ] } }, "type": "object" }, "PluginRef-dump": { "properties": { "id": { "type": "integer", "description": "ID for the Plugin resource." }, "group": { "description": "Group that owns the Plugin resource.", "allOf": [ { "$ref": "#/components/schemas/GroupRef" } ] }, "url": { "type": "string", "description": "URL for accessing the full Plugin resource." }, "deleted": { "type": "boolean", "description": "Whether the Plugin resource has been deleted.", "default": false }, "name": { "type": "string", "description": "Name of the Plugin resource." } }, "type": "object" }, "NestedSnapshotsIdPluginFile-dump": { "required": [ "contents", "filename" ], "properties": { "id": { "type": "integer", "description": "ID for the PluginFile resource." }, "snapshot": { "type": "integer", "description": "ID for the underlying PluginFile snapshot." }, "group": { "description": "Group that owns the PluginFile resource.", "allOf": [ { "$ref": "#/components/schemas/GroupRef" } ] }, "user": { "description": "User that created the PluginFile resource.", "allOf": [ { "$ref": "#/components/schemas/UserRef-dump" } ] }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the PluginFile resource was created." }, "snapshotCreatedOn": { "type": "string", "format": "date-time", "description": "Timestamp when the PluginFile resource snapshot was created." }, "lastModifiedOn": { "type": "string", "format": "date-time", "description": "Timestamp when the PluginFile resource was last modified." }, "latestSnapshot": { "type": "boolean", "description": "Whether or not the PluginFile resource is the latest version." }, "hasDraft": { "type": "boolean", "description": "Whether a draft exists for the PluginFile resource." }, "tags": { "type": "array", "items": { "description": "Tags associated with the PluginFile resource.", "allOf": [ { "$ref": "#/components/schemas/TagRef-dump" } ] } }, "deleted": { "type": "boolean", "description": "Whether the PluginFile resource has been deleted.", "default": false }, "filename": { "type": "string", "description": "Name of the PluginFile resource." }, "contents": { "type": "string", "description": "Contents of the file." }, "tasks": { "description": "Tasks associated with the PluginFile resource.", "allOf": [ { "$ref": "#/components/schemas/PluginTaskContainer" } ] }, "description": { "type": "string", "description": "Description of the PluginFile resource." }, "plugin": { "description": "The Plugin resource this file belongs to.", "allOf": [ { "$ref": "#/components/schemas/PluginRef-dump" } ] } }, "type": "object" }, "Plugin-load": { "required": [ "group", "name" ], "properties": { "group": { "type": "integer", "description": "ID of the Group that will own the Plugin resource." }, "name": { "type": "string", "description": "Name of the Plugin resource." }, "description": { "type": "string", "description": "Description of the Plugin resource." } }, "type": "object" }, "Plugin-dump": { "required": [ "name" ], "properties": { "id": { "type": "integer", "description": "ID for the Plugin resource." }, "snapshot": { "type": "integer", "description": "ID for the underlying Plugin snapshot." }, "group": { "description": "Group that owns the Plugin resource.", "allOf": [ { "$ref": "#/components/schemas/GroupRef" } ] }, "user": { "description": "User that created the Plugin resource.", "allOf": [ { "$ref": "#/components/schemas/UserRef-dump" } ] }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the Plugin resource was created." }, "snapshotCreatedOn": { "type": "string", "format": "date-time", "description": "Timestamp when the Plugin resource snapshot was created." }, "lastModifiedOn": { "type": "string", "format": "date-time", "description": "Timestamp when the Plugin resource was last modified." }, "latestSnapshot": { "type": "boolean", "description": "Whether or not the Plugin resource is the latest version." }, "hasDraft": { "type": "boolean", "description": "Whether a draft exists for the Plugin resource." }, "tags": { "type": "array", "items": { "description": "Tags associated with the Plugin resource.", "allOf": [ { "$ref": "#/components/schemas/TagRef-dump" } ] } }, "deleted": { "type": "boolean", "description": "Whether the Plugin resource has been deleted.", "default": false }, "name": { "type": "string", "description": "Name of the Plugin resource." }, "description": { "type": "string", "description": "Description of the Plugin resource." }, "files": { "type": "array", "items": { "description": "Files associated with the Plugin resource.", "allOf": [ { "$ref": "#/components/schemas/PluginFileRef-dump" } ] } } }, "type": "object" }, "PluginFileRef-dump": { "properties": { "id": { "type": "integer", "description": "ID for the PluginFile resource." }, "group": { "description": "Group that owns the PluginFile resource.", "allOf": [ { "$ref": "#/components/schemas/GroupRef" } ] }, "url": { "type": "string", "description": "URL for accessing the full PluginFile resource." }, "deleted": { "type": "boolean", "description": "Whether the PluginFile resource has been deleted.", "default": false }, "plugin": { "type": "integer", "description": "ID for the Plugin resource this file belongs to." }, "filename": { "type": "string", "description": "Filename of the PluginFile resource." }, "tasks": { "description": "Tasks associated with the PluginFile resource.", "allOf": [ { "$ref": "#/components/schemas/PluginTaskContainer" } ] } }, "type": "object" }, "PluginPage": { "properties": { "index": { "type": "integer", "description": "Starting index of the current page." }, "isComplete": { "type": "boolean", "description": "Boolean indicating if more data is available." }, "totalNumResults": { "type": "integer", "description": "Total number of results." }, "first": { "type": "string", "description": "URL to first page in results set." }, "next": { "type": "string", "description": "URL to next page in results set." }, "prev": { "type": "string", "description": "URL to last page in results set." }, "data": { "type": "array", "items": { "description": "List of Plugin resources in the current page.", "allOf": [ { "$ref": "#/components/schemas/Plugin-dump" } ] } } }, "type": "object" }, "PluginMutableFields": { "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Name of the Plugin resource." }, "description": { "type": "string", "description": "Description of the Plugin resource." } }, "type": "object" }, "PluginFile-load": { "required": [ "contents", "filename" ], "properties": { "filename": { "type": "string", "description": "Name of the PluginFile resource." }, "contents": { "type": "string", "description": "Contents of the file." }, "tasks": { "description": "Tasks associated with the PluginFile resource.", "allOf": [ { "$ref": "#/components/schemas/PluginTaskContainer" } ] }, "description": { "type": "string", "description": "Description of the PluginFile resource." } }, "type": "object" }, "PluginFilePage": { "properties": { "index": { "type": "integer", "description": "Starting index of the current page." }, "isComplete": { "type": "boolean", "description": "Boolean indicating if more data is available." }, "totalNumResults": { "type": "integer", "description": "Total number of results." }, "first": { "type": "string", "description": "URL to first page in results set." }, "next": { "type": "string", "description": "URL to next page in results set." }, "prev": { "type": "string", "description": "URL to last page in results set." }, "data": { "type": "array", "items": { "description": "List of PluginFile resources in the current page.", "allOf": [ { "$ref": "#/components/schemas/PluginFile-dump" } ] } } }, "type": "object" }, "PluginFileMutableFields": { "required": [ "contents", "filename" ], "properties": { "filename": { "type": "string", "description": "Name of the PluginFile resource." }, "contents": { "type": "string", "description": "Contents of the file." }, "tasks": { "description": "Tasks associated with the PluginFile resource.", "allOf": [ { "$ref": "#/components/schemas/PluginTaskContainer" } ] }, "description": { "type": "string", "description": "Description of the PluginFile resource." } }, "type": "object" }, "DraftsPlugin-load": { "required": [ "group", "name" ], "properties": { "group": { "type": "integer", "description": "ID of the Group that will own the Plugin resource." }, "name": { "type": "string", "description": "Name of the Plugin resource." }, "description": { "type": "string", "description": "Description of the Plugin resource." } }, "type": "object" }, "DraftsIdPluginMutableFields": { "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Name of the Plugin resource." }, "description": { "type": "string", "description": "Description of the Plugin resource." } }, "type": "object" }, "ModifyDraftPluginMutableFields": { "properties": { "resourceSnapshot": { "type": "integer", "description": "ID of the resource snapshot this draft modifies." }, "resourceData": { "description": "Draft resource data.", "allOf": [ { "$ref": "#/components/schemas/PluginMutableFields" } ] } }, "type": "object" }, "CreateDraftPluginMutableFields": { "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Name of the Plugin resource." }, "description": { "type": "string", "description": "Description of the Plugin resource." } }, "type": "object" }, "NestedDraftsPluginFile-load": { "required": [ "contents", "filename" ], "properties": { "filename": { "type": "string", "description": "Name of the PluginFile resource." }, "contents": { "type": "string", "description": "Contents of the file." }, "tasks": { "description": "Tasks associated with the PluginFile resource.", "allOf": [ { "$ref": "#/components/schemas/PluginTaskContainer" } ] }, "description": { "type": "string", "description": "Description of the PluginFile resource." } }, "type": "object" }, "NestedDraftsIdPluginFile-load": { "required": [ "contents", "filename" ], "properties": { "filename": { "type": "string", "description": "Name of the PluginFile resource." }, "contents": { "type": "string", "description": "Contents of the file." }, "tasks": { "description": "Tasks associated with the PluginFile resource.", "allOf": [ { "$ref": "#/components/schemas/PluginTaskContainer" } ] }, "description": { "type": "string", "description": "Description of the PluginFile resource." } }, "type": "object" }, "ModifyNestedDraftPluginFile": { "properties": { "resourceSnapshot": { "type": "integer", "description": "ID of the resource snapshot this draft modifies." }, "resourceData": { "description": "Draft resource data.", "allOf": [ { "$ref": "#/components/schemas/PluginFile-load" } ] } }, "type": "object" }, "CreateNestedDraftPluginFile-load": { "required": [ "contents", "filename" ], "properties": { "filename": { "type": "string", "description": "Name of the PluginFile resource." }, "contents": { "type": "string", "description": "Contents of the file." }, "tasks": { "description": "Tasks associated with the PluginFile resource.", "allOf": [ { "$ref": "#/components/schemas/PluginTaskContainer" } ] }, "description": { "type": "string", "description": "Description of the PluginFile resource." } }, "type": "object" }, "SnapshotsPluginPage": { "properties": { "index": { "type": "integer", "description": "Starting index of the current page." }, "isComplete": { "type": "boolean", "description": "Boolean indicating if more data is available." }, "totalNumResults": { "type": "integer", "description": "Total number of results." }, "first": { "type": "string", "description": "URL to first page in results set." }, "next": { "type": "string", "description": "URL to next page in results set." }, "prev": { "type": "string", "description": "URL to last page in results set." }, "data": { "type": "array", "items": { "description": "List of Plugin resources in the current page.", "allOf": [ { "$ref": "#/components/schemas/Plugin-dump" } ] } } }, "type": "object" }, "SnapshotsIdPlugin-dump": { "required": [ "name" ], "properties": { "id": { "type": "integer", "description": "ID for the Plugin resource." }, "snapshot": { "type": "integer", "description": "ID for the underlying Plugin snapshot." }, "group": { "description": "Group that owns the Plugin resource.", "allOf": [ { "$ref": "#/components/schemas/GroupRef" } ] }, "user": { "description": "User that created the Plugin resource.", "allOf": [ { "$ref": "#/components/schemas/UserRef-dump" } ] }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the Plugin resource was created." }, "snapshotCreatedOn": { "type": "string", "format": "date-time", "description": "Timestamp when the Plugin resource snapshot was created." }, "lastModifiedOn": { "type": "string", "format": "date-time", "description": "Timestamp when the Plugin resource was last modified." }, "latestSnapshot": { "type": "boolean", "description": "Whether or not the Plugin resource is the latest version." }, "hasDraft": { "type": "boolean", "description": "Whether a draft exists for the Plugin resource." }, "tags": { "type": "array", "items": { "description": "Tags associated with the Plugin resource.", "allOf": [ { "$ref": "#/components/schemas/TagRef-dump" } ] } }, "deleted": { "type": "boolean", "description": "Whether the Plugin resource has been deleted.", "default": false }, "name": { "type": "string", "description": "Name of the Plugin resource." }, "description": { "type": "string", "description": "Description of the Plugin resource." }, "files": { "type": "array", "items": { "description": "Files associated with the Plugin resource.", "allOf": [ { "$ref": "#/components/schemas/PluginFileRef-dump" } ] } } }, "type": "object" }, "Queue-load": { "required": [ "group", "name" ], "properties": { "group": { "type": "integer", "description": "ID of the Group that will own the Queue resource." }, "name": { "type": "string", "description": "Name of the Queue resource." }, "description": { "type": "string", "description": "Description of the Queue resource." } }, "type": "object" }, "Queue-dump": { "required": [ "name" ], "properties": { "id": { "type": "integer", "description": "ID for the Queue resource." }, "snapshot": { "type": "integer", "description": "ID for the underlying Queue snapshot." }, "group": { "description": "Group that owns the Queue resource.", "allOf": [ { "$ref": "#/components/schemas/GroupRef" } ] }, "user": { "description": "User that created the Queue resource.", "allOf": [ { "$ref": "#/components/schemas/UserRef-dump" } ] }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the Queue resource was created." }, "snapshotCreatedOn": { "type": "string", "format": "date-time", "description": "Timestamp when the Queue resource snapshot was created." }, "lastModifiedOn": { "type": "string", "format": "date-time", "description": "Timestamp when the Queue resource was last modified." }, "latestSnapshot": { "type": "boolean", "description": "Whether or not the Queue resource is the latest version." }, "hasDraft": { "type": "boolean", "description": "Whether a draft exists for the Queue resource." }, "tags": { "type": "array", "items": { "description": "Tags associated with the Queue resource.", "allOf": [ { "$ref": "#/components/schemas/TagRef-dump" } ] } }, "deleted": { "type": "boolean", "description": "Whether the Queue resource has been deleted.", "default": false }, "name": { "type": "string", "description": "Name of the Queue resource." }, "description": { "type": "string", "description": "Description of the Queue resource." } }, "type": "object" }, "QueuePage": { "properties": { "index": { "type": "integer", "description": "Starting index of the current page." }, "isComplete": { "type": "boolean", "description": "Boolean indicating if more data is available." }, "totalNumResults": { "type": "integer", "description": "Total number of results." }, "first": { "type": "string", "description": "URL to first page in results set." }, "next": { "type": "string", "description": "URL to next page in results set." }, "prev": { "type": "string", "description": "URL to last page in results set." }, "data": { "type": "array", "items": { "description": "List of Queue resources in the current page.", "allOf": [ { "$ref": "#/components/schemas/Queue-dump" } ] } } }, "type": "object" }, "QueueMutableFields": { "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Name of the Queue resource." }, "description": { "type": "string", "description": "Description of the Queue resource." } }, "type": "object" }, "DraftsQueue-load": { "required": [ "group", "name" ], "properties": { "group": { "type": "integer", "description": "ID of the Group that will own the Queue resource." }, "name": { "type": "string", "description": "Name of the Queue resource." }, "description": { "type": "string", "description": "Description of the Queue resource." } }, "type": "object" }, "DraftsIdQueueMutableFields": { "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Name of the Queue resource." }, "description": { "type": "string", "description": "Description of the Queue resource." } }, "type": "object" }, "ModifyDraftQueueMutableFields": { "properties": { "resourceSnapshot": { "type": "integer", "description": "ID of the resource snapshot this draft modifies." }, "resourceData": { "description": "Draft resource data.", "allOf": [ { "$ref": "#/components/schemas/QueueMutableFields" } ] } }, "type": "object" }, "CreateDraftQueueMutableFields": { "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Name of the Queue resource." }, "description": { "type": "string", "description": "Description of the Queue resource." } }, "type": "object" }, "SnapshotsQueuePage": { "properties": { "index": { "type": "integer", "description": "Starting index of the current page." }, "isComplete": { "type": "boolean", "description": "Boolean indicating if more data is available." }, "totalNumResults": { "type": "integer", "description": "Total number of results." }, "first": { "type": "string", "description": "URL to first page in results set." }, "next": { "type": "string", "description": "URL to next page in results set." }, "prev": { "type": "string", "description": "URL to last page in results set." }, "data": { "type": "array", "items": { "description": "List of Queue resources in the current page.", "allOf": [ { "$ref": "#/components/schemas/Queue-dump" } ] } } }, "type": "object" }, "SnapshotsIdQueue-dump": { "required": [ "name" ], "properties": { "id": { "type": "integer", "description": "ID for the Queue resource." }, "snapshot": { "type": "integer", "description": "ID for the underlying Queue snapshot." }, "group": { "description": "Group that owns the Queue resource.", "allOf": [ { "$ref": "#/components/schemas/GroupRef" } ] }, "user": { "description": "User that created the Queue resource.", "allOf": [ { "$ref": "#/components/schemas/UserRef-dump" } ] }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the Queue resource was created." }, "snapshotCreatedOn": { "type": "string", "format": "date-time", "description": "Timestamp when the Queue resource snapshot was created." }, "lastModifiedOn": { "type": "string", "format": "date-time", "description": "Timestamp when the Queue resource was last modified." }, "latestSnapshot": { "type": "boolean", "description": "Whether or not the Queue resource is the latest version." }, "hasDraft": { "type": "boolean", "description": "Whether a draft exists for the Queue resource." }, "tags": { "type": "array", "items": { "description": "Tags associated with the Queue resource.", "allOf": [ { "$ref": "#/components/schemas/TagRef-dump" } ] } }, "deleted": { "type": "boolean", "description": "Whether the Queue resource has been deleted.", "default": false }, "name": { "type": "string", "description": "Name of the Queue resource." }, "description": { "type": "string", "description": "Description of the Queue resource." } }, "type": "object" }, "Tag-load": { "properties": { "group": { "type": "integer", "description": "Group that owns the Tag." }, "name": { "type": "string", "description": "Name of the Tag resource." } }, "type": "object" }, "Tag-dump": { "properties": { "id": { "type": "integer", "description": "ID for the Tag." }, "group": { "description": "Group that owns the Tag.", "allOf": [ { "$ref": "#/components/schemas/GroupRef" } ] }, "user": { "description": "User that created the Tag.", "allOf": [ { "$ref": "#/components/schemas/UserRef-dump" } ] }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the Tag resource was created." }, "lastModifiedOn": { "type": "string", "format": "date-time", "description": "Timestamp when the Tag resource was last modified." }, "name": { "type": "string", "description": "Name of the Tag resource." } }, "type": "object" }, "TagPage": { "properties": { "index": { "type": "integer", "description": "Starting index of the current page." }, "isComplete": { "type": "boolean", "description": "Boolean indicating if more data is available." }, "totalNumResults": { "type": "integer", "description": "Total number of results." }, "first": { "type": "string", "description": "URL to first page in results set." }, "next": { "type": "string", "description": "URL to next page in results set." }, "prev": { "type": "string", "description": "URL to last page in results set." }, "data": { "type": "array", "items": { "description": "List of Tags in the current page.", "allOf": [ { "$ref": "#/components/schemas/Tag-dump" } ] } } }, "type": "object" }, "TagMutableFields": { "properties": { "name": { "type": "string", "description": "Name of the Tag resource." } }, "type": "object" }, "ResourceUrlsPage": { "properties": { "index": { "type": "integer", "description": "Starting index of the current page." }, "isComplete": { "type": "boolean", "description": "Boolean indicating if more data is available." }, "totalNumResults": { "type": "integer", "description": "Total number of results." }, "first": { "type": "string", "description": "URL to first page in results set." }, "next": { "type": "string", "description": "URL to next page in results set." }, "prev": { "type": "string", "description": "URL to last page in results set." }, "data": { "type": "array", "description": "List of Resource URLs in the current page.", "items": { "type": "string" } } }, "type": "object" }, "User-load": { "required": [ "username" ], "properties": { "username": { "type": "string", "description": "Username of the User. Fixed after registration." }, "password": { "type": "string", "description": "Password for the User resource." }, "confirmPassword": { "type": "string", "description": "The password confirmation when creating a new user account." } }, "type": "object" }, "UserCurrent-dump": { "required": [ "username" ], "properties": { "username": { "type": "string", "description": "Username of the User. Fixed after registration." }, "id": { "type": "integer", "description": "ID for the User resource." }, "groups": { "type": "array", "items": { "description": "A list of Groups the User is a part of.", "allOf": [ { "$ref": "#/components/schemas/GroupRef" } ] } }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the User resource was created." }, "lastModifiedOn": { "type": "string", "format": "date-time", "description": "Timestamp when the User resource was last modified." }, "lastLoginOn": { "type": "string", "format": "date-time", "description": "Timestamp when the User resource was last logged in." }, "passwordExpiresOn": { "type": "string", "format": "date-time", "description": "Timestamp when the User resource password expires on." } }, "type": "object" }, "UserPage": { "properties": { "index": { "type": "integer", "description": "Starting index of the current page." }, "isComplete": { "type": "boolean", "description": "Boolean indicating if more data is available." }, "totalNumResults": { "type": "integer", "description": "Total number of results." }, "first": { "type": "string", "description": "URL to first page in results set." }, "next": { "type": "string", "description": "URL to next page in results set." }, "prev": { "type": "string", "description": "URL to last page in results set." }, "data": { "type": "array", "items": { "description": "List of User resources in the current page.", "allOf": [ { "$ref": "#/components/schemas/User-dump" } ] } } }, "type": "object" }, "User-dump": { "required": [ "username" ], "properties": { "username": { "type": "string", "description": "Username of the User. Fixed after registration." }, "id": { "type": "integer", "description": "ID for the User resource." } }, "type": "object" }, "UserPassword-load": { "properties": { "oldPassword": { "type": "string", "description": "Old password for the User resource." }, "newPassword": { "type": "string", "description": "New password for the User resource." }, "confirmNewPassword": { "type": "string", "description": "The new password confirmation when changing a password." } }, "type": "object" }, "UserDelete": { "properties": { "password": { "type": "string", "description": "The users current password." } }, "type": "object" }, "SignatureAnalysis": { "properties": { "pythonCode": { "type": "string", "description": "The contents of the python file" } }, "type": "object" }, "SignatureAnalysisOutput": { "properties": { "tasks": { "type": "array", "items": { "description": "A list of signature analyses for the plugin tasks provided in the input file", "allOf": [ { "$ref": "#/components/schemas/SignatureAnalysisSignature" } ] } } }, "type": "object" }, "SignatureAnalysisSignature": { "properties": { "name": { "type": "string", "description": "The name of the function" }, "inputs": { "type": "array", "items": { "description": "A list of objects describing the input parameters.", "allOf": [ { "$ref": "#/components/schemas/SignatureAnalysisSignatureInput" } ] } }, "outputs": { "type": "array", "items": { "description": "A list of objects describing the output parameters.", "allOf": [ { "$ref": "#/components/schemas/SignatureAnalysisSignatureOutput" } ] } }, "missing_types": { "type": "array", "items": { "description": "A list of missing types for non-primitives defined by the file", "allOf": [ { "$ref": "#/components/schemas/SignatureAnalysisSuggestedTypes" } ] } } }, "type": "object" }, "SignatureAnalysisSignatureInput": { "properties": { "name": { "type": "string", "description": "The name of the parameter" }, "type": { "type": "string", "description": "The type of the parameter" }, "required": { "type": "boolean", "description": "Whether this is a required parameter" } }, "type": "object" }, "SignatureAnalysisSignatureOutput": { "properties": { "name": { "type": "string", "description": "The name of the parameter" }, "type": { "type": "string", "description": "The type of the parameter" } }, "type": "object" }, "SignatureAnalysisSuggestedTypes": { "properties": { "name": { "type": "string", "description": "A suggestion for the name of the type" }, "description": { "type": "string", "description": "The annotation the suggestion is attempting to represent" } }, "type": "object" } } } }