diff --git a/openapi/v2/service.swagger.yaml b/openapi/v2/service.swagger.yaml index b3a40dd5..649603c6 100644 --- a/openapi/v2/service.swagger.yaml +++ b/openapi/v2/service.swagger.yaml @@ -1159,6 +1159,108 @@ paths: type: string tags: - Catalog + /v1alpha/namespaces/{namespaceId}/object-upload-url: + get: + summary: Get Object Upload URL + operationId: ArtifactPublicService_GetObjectUploadURL + responses: + "200": + description: A successful response. + schema: + $ref: '#/definitions/v1alphaGetObjectUploadURLResponse' + "401": + description: Returned when the client credentials are not valid. + schema: {} + default: + description: An unexpected error response. + schema: + $ref: '#/definitions/googlerpcStatus' + parameters: + - name: namespaceId + description: id of the namespace + in: path + required: true + type: string + - name: objectName + description: |- + name of the object with length limit to 1024 characters. + this is the unique identifier of the object in the namespace + in: query + required: true + type: string + - name: urlExpireDays + description: |- + Expiration time in days for the URL. + Minimum is 1 day and maximum is 7 days. If not set or set to 0, defaults to 1 day. + in: query + required: false + type: integer + format: int32 + - name: lastModifiedTime + description: |- + last modified time this value is provided by the client when the object url is created + it must be in RFC3339 formatted date-time string + in: query + required: false + type: string + format: date-time + - name: objectExpireDays + description: |- + object live time in days + minimum is 1 day. if set to 0, the object will not be deleted automatically + in: query + required: false + type: integer + format: int32 + tags: + - Object + /v1alpha/namespaces/{namespaceId}/object-download-url: + get: + summary: Get Object Download URL + operationId: ArtifactPublicService_GetObjectDownloadURL + responses: + "200": + description: A successful response. + schema: + $ref: '#/definitions/v1alphaGetObjectDownloadURLResponse' + "401": + description: Returned when the client credentials are not valid. + schema: {} + default: + description: An unexpected error response. + schema: + $ref: '#/definitions/googlerpcStatus' + parameters: + - name: namespaceId + description: id of the namespace + in: path + required: true + type: string + - name: objectUid + description: |- + uid of the object + if provided, object name is not required + uid has priority over name + in: query + required: false + type: string + - name: objectName + description: |- + object name + if provided, object uid is not required + in: query + required: false + type: string + - name: urlExpireDays + description: |- + Expiration time in days for the URL. + Minimum is 1 day and maximum is 7 days. If not set or set to 0, defaults to 1 day. + in: query + required: false + type: integer + format: int32 + tags: + - Object /v1beta/user: get: summary: Get the authenticated user @@ -1991,6 +2093,48 @@ paths: $ref: '#/definitions/v1betaCheckNamespaceRequest' tags: - Utils + /v1beta/metrics/vdp/pipeline/triggers: + get: + summary: List pipeline triggers + description: Returns a paginated list of pipeline executions. + operationId: MgmtPublicService_ListPipelineTriggerRecords + responses: + "200": + description: A successful response. + schema: + $ref: '#/definitions/v1betaListPipelineTriggerRecordsResponse' + "401": + description: Returned when the client credentials are not valid. + schema: {} + default: + description: An unexpected error response. + schema: + $ref: '#/definitions/googlerpcStatus' + parameters: + - name: pageSize + description: |- + The maximum number of triggers to return. If this parameter is unspecified, + at most 100 pipelines will be returned. The cap value for this parameter is + 1000 (i.e. any value above that will be coerced to 100). + in: query + required: false + type: integer + format: int32 + - name: pageToken + description: Page token. + in: query + required: false + type: string + - name: filter + description: |- + Filter can hold an [AIP-160](https://google.aip.dev/160)-compliant filter + expression. + - Example: `create_time>timestamp("2000-06-19T23:31:08.657Z")`. + in: query + required: false + type: string + tags: + - Metric /v1beta/metrics/vdp/pipeline/charts: get: summary: List pipeline trigger time charts @@ -3073,14 +3217,14 @@ paths: get: summary: List Model Runs of a Namespace (user or organization) description: |- - Returns a paginated list of runs for 1 or more models. This is mainly used by credit dashboard. - The requester can view all the runs that consumed their credits across different models. - operationId: ModelPublicService_ListModelRunsByCreditOwner + Returns a paginated list of runs for 1 or more models. This is mainly used by dashboard. + The requester can view all the runs by the requester across different models. + operationId: ModelPublicService_ListModelRunsByRequester responses: "200": description: A successful response. schema: - $ref: '#/definitions/v1alphaListModelRunsByCreditOwnerResponse' + $ref: '#/definitions/v1alphaListModelRunsByRequesterResponse' "401": description: Returned when the client credentials are not valid. schema: {} @@ -3117,9 +3261,10 @@ paths: description: |- Filter can hold an [AIP-160](https://google.aip.dev/160)-compliant filter expression. - - Example: `create_time>timestamp("2000-06-19T23:31:08.657Z")`. + - Example: `status="RUN_STATUS_COMPLETED"`. The filter can be applied to the following fields: - - `create_time` + - `status` + - `source` in: query required: false type: string @@ -3139,6 +3284,11 @@ paths: required: false type: string format: date-time + - name: requesterId + description: Requester ID. + in: query + required: true + type: string - name: Instill-Requester-Uid description: Indicates the authenticated namespace is making the request on behalf of another entity, typically an organization they belong to in: header @@ -4540,14 +4690,14 @@ paths: get: summary: List Pipeline Runs of a Namespace (user or organization) description: |- - Returns a paginated list of runs for 1 or more pipelines. This is mainly used by credit dashboard. - The requester can view all the runs that consumed their credits across different pipelines. - operationId: PipelinePublicService_ListPipelineRunsByCreditOwner + Returns a paginated list of runs for 1 or more pipelines. This is mainly used by dashboard. + The requester can view all the runs by the requester across different pipelines. + operationId: PipelinePublicService_ListPipelineRunsByRequester responses: "200": description: A successful response. schema: - $ref: '#/definitions/v1betaListPipelineRunsByCreditOwnerResponse' + $ref: '#/definitions/v1betaListPipelineRunsByRequesterResponse' "401": description: Returned when the client credentials are not valid. schema: {} @@ -4574,7 +4724,11 @@ paths: description: |- Filter can hold an [AIP-160](https://google.aip.dev/160)-compliant filter expression. - - Example: `create_time>timestamp("2000-06-19T23:31:08.657Z")`. + The following filters are supported: + - `status` + - `source` + + **Example**: `status="RUN_STATUS_COMPLETED"`. in: query required: false type: string @@ -4601,6 +4755,11 @@ paths: required: false type: string format: date-time + - name: requesterId + description: Requester ID. + in: query + required: true + type: string - name: Instill-Requester-Uid description: Indicates the authenticated namespace is making the request on behalf of another entity, typically an organization they belong to in: header @@ -6712,6 +6871,52 @@ definitions: allOf: - $ref: '#/definitions/v1alphaModel' description: GetNamespaceModelResponse contains the requested model. + v1alphaGetObjectDownloadURLResponse: + type: object + properties: + downloadUrl: + type: string + title: download url + urlExpireAt: + type: string + format: date-time + title: expire at in UTC (UTC+0) + object: + title: object + allOf: + - $ref: '#/definitions/v1alphaObject' + title: GetObjectDownloadURLResponse + v1alphaGetObjectResponse: + type: object + properties: + object: + title: object + allOf: + - $ref: '#/definitions/v1alphaObject' + title: GetObjectResponse + v1alphaGetObjectURLResponse: + type: object + properties: + objectUrl: + title: object url + allOf: + - $ref: '#/definitions/v1alphaObjectURL' + title: GetObjectURLResponse + v1alphaGetObjectUploadURLResponse: + type: object + properties: + uploadUrl: + type: string + title: upload url + urlExpireAt: + type: string + format: date-time + title: expire at in UTC (UTC+0) + object: + title: object + allOf: + - $ref: '#/definitions/v1alphaObject' + title: GetObjectUploadURLResponse v1alphaGetPlaygroundConversationResponse: type: object properties: @@ -6907,7 +7112,7 @@ definitions: format: int32 description: Total number of model definitions. description: ListModelDefinitionsResponse contains a list of model definitions. - v1alphaListModelRunsByCreditOwnerResponse: + v1alphaListModelRunsByRequesterResponse: type: object properties: runs: @@ -6932,7 +7137,7 @@ definitions: format: int32 description: The requested page offset. readOnly: true - description: ListModelRunsByCreditOwnerResponse is the request message for ListModelRunsByCreditOwner. + description: ListModelRunsByRequesterResponse is the request message for ListModelRunsByRequester. v1alphaListModelRunsResponse: type: object properties: @@ -7352,6 +7557,12 @@ definitions: type: string description: Model ID. readOnly: true + requesterId: + type: string + description: |- + Requester ID. This field might be empty if the model run belongs to a + deleted namespace. + readOnly: true description: ModelRun contains information about a run of models. v1alphaModelStats: type: object @@ -7407,6 +7618,93 @@ definitions: - VISIBILITY_PRIVATE: Only the owner can see the model. - VISIBILITY_PUBLIC: Other users can see the model. + v1alphaObject: + type: object + properties: + uid: + type: string + title: uid + name: + type: string + title: name of the object + size: + type: string + format: int64 + title: size in bytes + contentType: + type: string + title: |- + content type + this is mime type from content-type header of http request or from file extension + namespaceUid: + type: string + title: namespace uid + creator: + type: string + title: creator + isUploaded: + type: boolean + title: if file is uploaded + path: + type: string + title: object path(optional) + objectExpireDays: + type: integer + format: int32 + title: |- + object live time in days + if set to 0, the object will not be deleted automatically + lastModifiedTime: + type: string + format: date-time + title: last modified time + createdTime: + type: string + format: date-time + title: created time + updatedTime: + type: string + format: date-time + title: updated time + title: Object + v1alphaObjectURL: + type: object + properties: + uid: + type: string + title: The unique identifier of the ObjectURL + namespaceUid: + type: string + title: The namespace UID associated with this ObjectURL + objectUid: + type: string + title: The object UID associated with this ObjectURL + urlExpireAt: + type: string + format: date-time + title: The expiration time of the URL + minioUrlPath: + type: string + title: The MinIO URL path + encodedUrlPath: + type: string + title: The encoded URL path + type: + type: string + title: The type of URL (download or upload) + createTime: + type: string + format: date-time + title: The creation time of the ObjectURL + updateTime: + type: string + format: date-time + title: The last update time of the ObjectURL + deleteTime: + type: string + format: date-time + title: The deletion time of the ObjectURL, if applicable + title: ObjectUploadURL v1alphaProcessCatalogFilesRequest: type: object properties: @@ -9067,7 +9365,7 @@ definitions: requested by an admin user. For the moment, the pipeline recipes will be UID-based (permalink) instead of name-based. This is a temporary solution. - v1betaListPipelineRunsByCreditOwnerResponse: + v1betaListPipelineRunsByRequesterResponse: type: object properties: pipelineRuns: @@ -9092,7 +9390,7 @@ definitions: format: int32 description: The number of items per page. readOnly: true - description: ListPipelineRunsByCreditOwnerResponse is the response message for ListPipelineRunsByCreditOwner. + description: ListPipelineRunsByRequesterResponse is the response message for ListPipelineRunsByRequester. v1betaListPipelineRunsResponse: type: object properties: @@ -9131,6 +9429,23 @@ definitions: description: |- ListPipelineTriggerChartRecordsResponse contains a list of pipeline trigger chart records. + v1betaListPipelineTriggerRecordsResponse: + type: object + properties: + pipelineTriggerRecords: + type: array + items: + type: object + $ref: '#/definitions/v1betaPipelineTriggerRecord' + description: A list of pipeline triggers. + nextPageToken: + type: string + description: Next page token. + totalSize: + type: integer + format: int32 + description: Total number of pipeline triggers. + description: ListPipelineTriggerRecordsResponse contains a list of pipeline triggers. v1betaListPipelinesAdminResponse: type: object properties: @@ -9726,6 +10041,12 @@ definitions: type: string title: The ID of the pipeline readOnly: true + requesterId: + type: string + description: |- + Requester ID. This field might be empty if the pipeline run belongs to a + deleted namespace. + readOnly: true description: PipelineRun represents a single execution of a pipeline. v1betaPipelineStats: type: object @@ -9796,6 +10117,45 @@ definitions: description: |- PipelineTriggerChartRecord contains pipeline trigger metrics, aggregated by pipeline ID and time frame. + v1betaPipelineTriggerRecord: + type: object + properties: + triggerTime: + type: string + format: date-time + description: The moment when the pipeline was triggered. + pipelineTriggerId: + type: string + description: UUID of the trigger. + pipelineId: + type: string + description: Pipeline ID. + pipelineUid: + type: string + description: Pipeline UUID. + triggerMode: + description: Trigger mode. + allOf: + - $ref: '#/definitions/v1betaMode' + computeTimeDuration: + type: number + format: float + description: Total execution duration. + readOnly: true + status: + description: Final status. + readOnly: true + allOf: + - $ref: '#/definitions/mgmtv1betaStatus' + pipelineReleaseId: + type: string + description: If a release of the pipeline was triggered, pipeline version. + readOnly: true + pipelineReleaseUid: + type: string + description: If a release of the pipeline was triggered, release UUID. + readOnly: true + description: PipelineTriggerRecord represents a pipeline execution event. v1betaPipelineView: type: string enum: