chore: auto-gen by protobufs

triggered by commit: c4c7b16
instill-ai · Aug 22, 2024 · e4e7c4a · e4e7c4a
1 parent f3c026c
commit e4e7c4a
Showing 1 changed file with 78 additions and 109 deletions.
diff --git a/openapiv2/core/service.swagger.yaml b/openapiv2/core/service.swagger.yaml
@@ -868,18 +868,18 @@ paths:
             $ref: '#/definitions/v1betaCheckNamespaceRequest'
       tags:
         - Utils
-  /v1beta/metrics/vdp/pipeline/tables:
+  /v1beta/metrics/vdp/pipeline/trigger-count:
     get:
-      summary: List pipeline trigger metrics
+      summary: Get pipeline trigger count
       description: |-
-        Returns a paginated list of pipeline executions aggregated by pipeline ID.
-        NOTE: This method is deprecated and will be retired soon.
-      operationId: MgmtPublicService_ListPipelineTriggerTableRecords
+        Returns the pipeline trigger count of a given requester within a timespan.
+        Results are grouped by trigger status.
+      operationId: MgmtPublicService_GetPipelineTriggerCount
       responses:
         "200":
           description: A successful response.
           schema:
-            $ref: '#/definitions/v1betaListPipelineTriggerTableRecordsResponse'
+            $ref: '#/definitions/v1betaGetPipelineTriggerCountResponse'
         "401":
           description: Returned when the client credentials are not valid.
           schema: {}
@@ -888,37 +888,35 @@ paths:
           schema:
             $ref: '#/definitions/googlerpcStatus'
       parameters:
-        - name: pageSize
-          description: |-
-            The maximum number of results 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 1000).
+        - name: namespaceId
+          description: The ID of the namespace that requested the pipeline triggers.
           in: query
-          required: false
-          type: integer
-          format: int32
-        - name: pageToken
-          description: Page token.
+          required: true
+          type: string
+        - name: start
+          description: |-
+            Beginning of the time range from which the records will be fetched.
+            The default value is the beginning of the current day, in UTC.
           in: query
           required: false
           type: string
-        - name: filter
+          format: date-time
+        - name: stop
           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")`.
+            End of the time range from which the records will be fetched.
+            The default value is the current timestamp.
           in: query
           required: false
           type: string
+          format: date-time
       tags:
         - Metric
   /v1beta/metrics/vdp/pipeline/charts:
     get:
-      summary: List pipeline trigger time charts
-      description: |-
-        Returns a timeline of pipline trigger counts for the pipelines of a given
-        owner.
-        NOTE: This method will soon return the trigger counts of a given requester.
+      summary: |-
+        Returns a timeline of pipline trigger counts for a given requester. The
+        response will contain one set of records (datapoints), representing the
+        amount of triggers in a time bucket.
       operationId: MgmtPublicService_ListPipelineTriggerChartRecords
       responses:
         "200":
@@ -933,20 +931,36 @@ paths:
           schema:
             $ref: '#/definitions/googlerpcStatus'
       parameters:
+        - name: namespaceId
+          description: The ID of the namespace that requested the pipeline triggers.
+          in: query
+          required: true
+          type: string
         - name: aggregationWindow
-          description: Aggregation window in nanoseconds.
+          description: |-
+            Aggregation window. The value is a positive duration string, i.e. a
+            sequence of decimal numbers, each with optional fraction and a unit
+            suffix, such as "300ms", "1.5h" or "2h45m".
+            The minimum (and default) window is 1h.
           in: query
           required: false
-          type: integer
-          format: int32
-        - name: filter
+          type: string
+        - name: start
           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")`.
+            Beginning of the time range from which the records will be fetched.
+            The default value is the beginning of the current day, in UTC.
           in: query
           required: false
           type: string
+          format: date-time
+        - name: stop
+          description: |-
+            End of the time range from which the records will be fetched.
+            The default value is the current timestamp.
+          in: query
+          required: false
+          type: string
+          format: date-time
       tags:
         - Metric
   /v1beta/metrics/credit/charts:
@@ -1412,6 +1426,18 @@ definitions:
         allOf:
           - $ref: '#/definitions/v1betaOrganizationSubscription'
     description: GetOrganizationSubscriptionResponse contains the requested subscription.
+  v1betaGetPipelineTriggerCountResponse:
+    type: object
+    properties:
+      pipelineTriggerCounts:
+        type: array
+        items:
+          type: object
+          $ref: '#/definitions/v1betaPipelineTriggerCount'
+        description: The trigger counts, grouped by status.
+    description: |-
+      GetPipelineTriggerCountResponse contains the trigger count, grouped by
+      trigger status.
   v1betaGetRemainingCreditAdminResponse:
     type: object
     properties:
@@ -1558,27 +1584,14 @@ definitions:
         items:
           type: object
           $ref: '#/definitions/v1betaPipelineTriggerChartRecord'
-        description: A list of pipeline trigger records.
+        description: |-
+          Pipeline trigger counts. Until we allow filtering or grouping by fields
+          like pipeline ID, this list will contain only one element with the
+          timeline of trigger counts for a given requester, regardless the pipeline
+          ID, trigger mode, final status or other fields.
     description: |-
       ListPipelineTriggerChartRecordsResponse contains a list of pipeline trigger
       chart records.
-  v1betaListPipelineTriggerTableRecordsResponse:
-    type: object
-    properties:
-      pipelineTriggerTableRecords:
-        type: array
-        items:
-          type: object
-          $ref: '#/definitions/v1betaPipelineTriggerTableRecord'
-        description: A list of pipeline trigger tables.
-      nextPageToken:
-        type: string
-        description: Next page token.
-      totalSize:
-        type: integer
-        format: int32
-        title: Total number of pipeline trigger records
-    description: ListPipelineTriggerTableRecordsResponse contains the pipeline metrics.
   v1betaListTokensResponse:
     type: object
     properties:
@@ -1671,16 +1684,6 @@ definitions:
        - MEMBERSHIP_STATE_ACTIVE: Active.
        - MEMBERSHIP_STATE_PENDING: Pending, i.e., a request has been sent to the user to join an
       organization.
-  v1betaMode:
-    type: string
-    enum:
-      - MODE_SYNC
-      - MODE_ASYNC
-    description: |-
-      Mode describes the execution mode of the pipeline (sync or async).
-
-       - MODE_SYNC: Synchronous (result is returned in the response).
-       - MODE_ASYNC: Asynchronous (response only contains acknowledgement).
   v1betaOnboardingStatus:
     type: string
     enum:
@@ -1854,19 +1857,8 @@ definitions:
     properties:
       pipelineId:
         type: string
-        description: Pipeline ID.
-      pipelineUid:
-        type: string
-        description: Pipeline UUID.
-      triggerMode:
-        description: Trigger mode.
-        allOf:
-          - $ref: '#/definitions/v1betaMode'
-      status:
-        description: Final status.
+        description: This field will be present present when the information is grouped by pipeline.
         readOnly: true
-        allOf:
-          - $ref: '#/definitions/mgmtv1betaStatus'
       timeBuckets:
         type: array
         items:
@@ -1881,54 +1873,31 @@ definitions:
           format: int32
         description: Aggregated trigger count in each time bucket.
         readOnly: true
-      computeTimeDuration:
-        type: array
-        items:
-          type: number
-          format: float
-        description: Total computation time duration in each time bucket.
-        readOnly: true
-      pipelineReleaseId:
-        type: string
-        description: Version for the triggered pipeline if it is a release pipeline.
-        readOnly: true
-      pipelineReleaseUid:
+      namespaceId:
         type: string
-        description: Release UUID for the triggered pipeline if it is a release pipeline.
+        description: The ID of the namespace that requested the pipeline triggers.
         readOnly: true
     description: |-
-      PipelineTriggerChartRecord contains pipeline trigger metrics, aggregated by
+      PipelineTriggerChartRecord represents a timeline of pipeline triggers. It
+      contains a collection of (timestamp, count) pairs that represent the total
+      pipeline triggers in a given time bucket.
       pipeline ID and time frame.
-  v1betaPipelineTriggerTableRecord:
+  v1betaPipelineTriggerCount:
     type: object
     properties:
-      pipelineId:
-        type: string
-        description: Pipeline ID.
-      pipelineUid:
-        type: string
-        description: Pipeline UUID.
-      triggerCountCompleted:
-        type: integer
-        format: int32
-        description: Number of triggers with `STATUS_COMPLETED`.
-        readOnly: true
-      triggerCountErrored:
+      triggerCount:
         type: integer
         format: int32
-        description: Number of triggers with `STATUS_ERRORED`.
+        description: Number of triggers.
         readOnly: true
-      pipelineReleaseId:
-        type: string
-        description: Version for the triggered pipeline if it is a release pipeline.
-        readOnly: true
-      pipelineReleaseUid:
-        type: string
-        description: Release UUID for the triggered pipeline if it is a release pipeline.
+      status:
+        description: This field will be present when results are grouped by trigger status.
         readOnly: true
+        allOf:
+          - $ref: '#/definitions/mgmtv1betaStatus'
     description: |-
-      PipelineTriggerTableRecord contains pipeline trigger metrics, aggregated by
-      pipeline ID.
+      PipelineTriggerCount represents a pipeline execution count with some
+      aggregation params (e.g. trigger status).
   v1betaStripeSubscriptionDetail:
     type: object
     properties: