diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index fbe5f9cc..865b438b 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1 +1 @@ -* @pinglin @phelan164 @xiaofei-du +* @donch1989 @heiruwu @pinglin @xiaofei-du diff --git a/.github/labeler.yml b/.github/labeler.yml index d544cf6e..dd9f8a91 100644 --- a/.github/labeler.yml +++ b/.github/labeler.yml @@ -1,2 +1,2 @@ -instill base: +instill protocol: - "**" diff --git a/LICENSE b/LICENSE index e4f91723..afd60339 100644 --- a/LICENSE +++ b/LICENSE @@ -1,202 +1,44 @@ +Elastic License 2.0 (ELv2) - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright 2021 Instill AI Ltd. - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. +**Acceptance** +By using the software, you agree to all of the terms and conditions below. + +**Copyright License** +The licensor grants you a non-exclusive, royalty-free, worldwide, non-sublicensable, non-transferable license to use, copy, distribute, make available, and prepare derivative works of the software, in each case subject to the limitations and conditions below + +**Limitations** +You may not provide the software to third parties as a hosted or managed service, where the service provides users with access to any substantial set of the features or functionality of the software. + +You may not move, change, disable, or circumvent the license key functionality in the software, and you may not remove or obscure any functionality in the software that is protected by the license key. + +You may not alter, remove, or obscure any licensing, copyright, or other notices of the licensor in the software. Any use of the licensor’s trademarks is subject to applicable law. + +**Patents** +The licensor grants you a license, under any patent claims the licensor can license, or becomes able to license, to make, have made, use, sell, offer for sale, import and have imported the software, in each case subject to the limitations and conditions in this license. This license does not cover any patent claims that you cause to be infringed by modifications or additions to the software. If you or your company make any written claim that the software infringes or contributes to infringement of any patent, your patent license for the software granted under these terms ends immediately. If your company makes such a claim, your patent license ends immediately for work on behalf of your company. + +**Notices** +You must ensure that anyone who gets a copy of any part of the software from you also gets a copy of these terms. + +If you modify the software, you must include in any modified copies of the software prominent notices stating that you have modified the software. + +**No Other Rights** +These terms do not imply any licenses other than those expressly granted in these terms. + +**Termination** +If you use the software in violation of these terms, such use is not licensed, and your licenses will automatically terminate. If the licensor provides you with a notice of your violation, and you cease all violation of this license no later than 30 days after you receive that notice, your licenses will be reinstated retroactively. However, if you violate these terms after such reinstatement, any additional violation of these terms will cause your licenses to terminate automatically and permanently. + +**No Liability** +As far as the law allows, the software comes as is, without any warranty or condition, and the licensor will not be liable to you for any damages arising out of these terms or the use or nature of the software, under any kind of legal claim. + +**Definitions** +The *licensor* is the entity offering these terms, and the *software* is the software the licensor makes available under these terms, including any portion of it. + +*you* refers to the individual or entity agreeing to these terms. + +*your company* is any legal entity, sole proprietorship, or other kind of organization that you work for, plus all organizations that have control over, are under the control of, or are under common control with that organization. *control* means ownership of substantially all the assets of an entity, or the power to direct its management and policies by vote, contract, or otherwise. Control can be direct or indirect. + +*your licenses* are all the licenses granted to you for the software under these terms. + +*use* means anything you do with the software requiring one of your licenses. + +*trademark* means trademarks, service marks, and similar rights. \ No newline at end of file diff --git a/README.md b/README.md index 67fa7560..f4447647 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Instill AI Protobufs -This repository is the interface definitions of the APIs of [Instill Base](https://github.com/instill-ai/base), [Instill Model](https://github.com/instill-ai/model), and [Instill VDP](https://github.com/instill-ai/vdp) that support both REST and gRPC protocols. You can also use these definitions with open source tools to generate client libraries, documentation, and other artifacts. +This repository is the interface definitions of the APIs of [Instill Core](https://github.com/instill-ai/core), [Instill Model](https://github.com/instill-ai/model), and [Instill VDP](https://github.com/instill-ai/vdp) that support both REST and gRPC protocols. You can also use these definitions with open source tools to generate client libraries, documentation, and other artifacts. ## Overview diff --git a/buf.lock b/buf.lock index 0df6dff9..fccbfb89 100644 --- a/buf.lock +++ b/buf.lock @@ -4,10 +4,10 @@ deps: - remote: buf.build owner: googleapis repository: googleapis - commit: cc916c31859748a68fd229a3c8d7a2e8 - digest: shake256:469b049d0eb04203d5272062636c078decefc96fec69739159c25d85349c50c34c7706918a8b216c5c27f76939df48452148cff8c5c3ae77fa6ba5c25c1b8bf8 + commit: 28151c0d0a1641bf938a7672c500e01d + digest: shake256:49215edf8ef57f7863004539deff8834cfb2195113f0b890dd1f67815d9353e28e668019165b9d872395871eeafcbab3ccfdb2b5f11734d3cca95be9e8d139de - remote: buf.build owner: grpc-ecosystem repository: grpc-gateway - commit: 11c9972ea0fd4c95a2c38d29bb1dc817 - digest: shake256:9c7ce822dff52ad28714465396fbe98e879409677a61687b7dd9bb3d1484aa5d1704c013698b24f34c5d51023dbff47287ecd9676271953c25e646b42ebb76c5 + commit: 048ae6ff94ca4476b3225904b1078fad + digest: shake256:e5250bf2d999516c02206d757502b902e406f35c099d0e869dc3e4f923f6870fe0805a9974c27df0695462937eae90cd4d9db90bb9a03489412560baa74a87b6 diff --git a/buf.md b/buf.md index 2ed4f432..19799af6 100644 --- a/buf.md +++ b/buf.md @@ -1,6 +1,6 @@ # Instill AI Protobufs -This repository is the interface definitions of the APIs of [Instill Base](https://github.com/instill-ai/base), [Instill Model](https://github.com/instill-ai/model), and [Instill VDP](https://github.com/instill-ai/vdp) that support both REST and gRPC protocols. You can also use these definitions with open source tools to generate client libraries, documentation, and other artifacts. +This repository is the interface definitions of the APIs of [Instill Core](https://github.com/instill-ai/core), [Instill Model](https://github.com/instill-ai/model), and [Instill VDP](https://github.com/instill-ai/vdp) that support both REST and gRPC protocols. You can also use these definitions with open source tools to generate client libraries, documentation, and other artifacts. ## Overview diff --git a/base/metric/v1alpha/metric.proto b/core/metric/v1alpha/metric.proto similarity index 99% rename from base/metric/v1alpha/metric.proto rename to core/metric/v1alpha/metric.proto index 64df19e7..e92f6cd7 100644 --- a/base/metric/v1alpha/metric.proto +++ b/core/metric/v1alpha/metric.proto @@ -1,6 +1,6 @@ syntax = "proto3"; -package base.metric.v1alpha; +package core.metric.v1alpha; // Google API 203 - field behavior documentation import "google/api/field_behavior.proto"; diff --git a/base/metric/v1alpha/metric_service.proto b/core/metric/v1alpha/metric_service.proto similarity index 98% rename from base/metric/v1alpha/metric_service.proto rename to core/metric/v1alpha/metric_service.proto index 7c215270..5eaf110b 100644 --- a/base/metric/v1alpha/metric_service.proto +++ b/core/metric/v1alpha/metric_service.proto @@ -7,9 +7,9 @@ */ syntax = "proto3"; -package base.metric.v1alpha; +package core.metric.v1alpha; -import "base/metric/v1alpha/metric.proto"; +import "core/metric/v1alpha/metric.proto"; // Services related to pipeline trigger records service PipelineService { diff --git a/base/mgmt/v1alpha/metric.proto b/core/mgmt/v1alpha/metric.proto similarity index 92% rename from base/mgmt/v1alpha/metric.proto rename to core/mgmt/v1alpha/metric.proto index 80354426..17b0a9ff 100644 --- a/base/mgmt/v1alpha/metric.proto +++ b/core/mgmt/v1alpha/metric.proto @@ -1,6 +1,6 @@ syntax = "proto3"; -package base.mgmt.v1alpha; +package core.mgmt.v1alpha; // Google API import "google/api/field_behavior.proto"; @@ -51,7 +51,8 @@ message PipelineTriggerRecord { string pipeline_release_uid = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; } -// PipelineTriggerTableRecord represents a aggregated table record for pipeline trigger +// PipelineTriggerTableRecord represents a aggregated table record for pipeline +// trigger message PipelineTriggerTableRecord { // ID for the triggered pipeline string pipeline_id = 1; @@ -67,7 +68,8 @@ message PipelineTriggerTableRecord { string pipeline_release_uid = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; } -// PipelineTriggerChartRecord represents a aggregated chart record for pipeline trigger +// PipelineTriggerChartRecord represents a aggregated chart record for pipeline +// trigger message PipelineTriggerChartRecord { // ID for the triggered pipeline string pipeline_id = 1; @@ -92,9 +94,10 @@ message PipelineTriggerChartRecord { // ListPipelineTriggerRecordsRequest represents a request to list // pipeline trigger record message ListPipelineTriggerRecordsRequest { - // The maximum number of pipeline trigger record to return. The service may return - // fewer than this value. If unspecified, at most 100 record will be returned. The - // maximum value is 1000; values above 1000 will be coerced to 1000. + // The maximum number of pipeline trigger record to return. The service may + // return fewer than this value. If unspecified, at most 100 record will be + // returned. The maximum value is 1000; values above 1000 will be coerced to + // 1000. optional int32 page_size = 1 [(google.api.field_behavior) = OPTIONAL]; // Page token optional string page_token = 2 [(google.api.field_behavior) = OPTIONAL]; @@ -116,9 +119,10 @@ message ListPipelineTriggerRecordsResponse { // ListPipelineTriggerTableRecordsRequest represents a request to list // pipeline trigger table record message ListPipelineTriggerTableRecordsRequest { - // The maximum number of pipeline trigger record to return. The service may return - // fewer than this value. If unspecified, at most 100 record will be returned. The - // maximum value is 1000; values above 1000 will be coerced to 1000. + // The maximum number of pipeline trigger record to return. The service may + // return fewer than this value. If unspecified, at most 100 record will be + // returned. The maximum value is 1000; values above 1000 will be coerced to + // 1000. optional int32 page_size = 1 [(google.api.field_behavior) = OPTIONAL]; // Page token optional string page_token = 2 [(google.api.field_behavior) = OPTIONAL]; @@ -179,7 +183,8 @@ message ConnectorExecuteRecord { Status status = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; } -// ConnectorExecuteTableRecord represents a aggregated table record for connector execute +// ConnectorExecuteTableRecord represents a aggregated table record for +// connector execute message ConnectorExecuteTableRecord { // ID for the executed connector string connector_id = 1; @@ -191,7 +196,8 @@ message ConnectorExecuteTableRecord { int32 execute_count_errored = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; } -// ConnectorExecuteChartRecord represents a aggregated chart record for connector execute +// ConnectorExecuteChartRecord represents a aggregated chart record for +// connector execute message ConnectorExecuteChartRecord { // ID for the executed connector string connector_id = 1; @@ -210,9 +216,10 @@ message ConnectorExecuteChartRecord { // ListConnectorExecuteRecordsRequest represents a request to list // connector execute record message ListConnectorExecuteRecordsRequest { - // The maximum number of connector execution record to return. The service may return - // fewer than this value. If unspecified, at most 100 record will be returned. The - // maximum value is 1000; values above 1000 will be coerced to 1000. + // The maximum number of connector execution record to return. The service may + // return fewer than this value. If unspecified, at most 100 record will be + // returned. The maximum value is 1000; values above 1000 will be coerced to + // 1000. optional int32 page_size = 1 [(google.api.field_behavior) = OPTIONAL]; // Page token optional string page_token = 2 [(google.api.field_behavior) = OPTIONAL]; @@ -234,9 +241,10 @@ message ListConnectorExecuteRecordsResponse { // ListConnectorExecuteTableRecordsRequest represents a request to list // connector execute table record message ListConnectorExecuteTableRecordsRequest { - // The maximum number of connector execution table record to return. The service may return - // fewer than this value. If unspecified, at most 100 record will be returned. The - // maximum value is 1000; values above 1000 will be coerced to 1000. + // The maximum number of connector execution table record to return. The + // service may return fewer than this value. If unspecified, at most 100 + // record will be returned. The maximum value is 1000; values above 1000 will + // be coerced to 1000. optional int32 page_size = 1 [(google.api.field_behavior) = OPTIONAL]; // Page token optional string page_token = 2 [(google.api.field_behavior) = OPTIONAL]; diff --git a/base/mgmt/v1alpha/mgmt.proto b/core/mgmt/v1alpha/mgmt.proto similarity index 99% rename from base/mgmt/v1alpha/mgmt.proto rename to core/mgmt/v1alpha/mgmt.proto index b3d6c578..0bbbfb57 100644 --- a/base/mgmt/v1alpha/mgmt.proto +++ b/core/mgmt/v1alpha/mgmt.proto @@ -1,6 +1,6 @@ syntax = "proto3"; -package base.mgmt.v1alpha; +package core.mgmt.v1alpha; import "common/healthcheck/v1alpha/healthcheck.proto"; import "google/api/field_behavior.proto"; diff --git a/base/mgmt/v1alpha/mgmt_private_service.proto b/core/mgmt/v1alpha/mgmt_private_service.proto similarity index 97% rename from base/mgmt/v1alpha/mgmt_private_service.proto rename to core/mgmt/v1alpha/mgmt_private_service.proto index e0d38b0e..19107120 100644 --- a/base/mgmt/v1alpha/mgmt_private_service.proto +++ b/core/mgmt/v1alpha/mgmt_private_service.proto @@ -1,8 +1,8 @@ syntax = "proto3"; -package base.mgmt.v1alpha; +package core.mgmt.v1alpha; -import "base/mgmt/v1alpha/mgmt.proto"; +import "core/mgmt/v1alpha/mgmt.proto"; // Google API import "google/api/annotations.proto"; import "google/api/client.proto"; diff --git a/base/mgmt/v1alpha/mgmt_public_service.proto b/core/mgmt/v1alpha/mgmt_public_service.proto similarity index 88% rename from base/mgmt/v1alpha/mgmt_public_service.proto rename to core/mgmt/v1alpha/mgmt_public_service.proto index 490c28dd..cc4b4d1b 100644 --- a/base/mgmt/v1alpha/mgmt_public_service.proto +++ b/core/mgmt/v1alpha/mgmt_public_service.proto @@ -1,9 +1,9 @@ syntax = "proto3"; -package base.mgmt.v1alpha; +package core.mgmt.v1alpha; -import "base/mgmt/v1alpha/metric.proto"; -import "base/mgmt/v1alpha/mgmt.proto"; +import "core/mgmt/v1alpha/metric.proto"; +import "core/mgmt/v1alpha/mgmt.proto"; // Google API import "google/api/annotations.proto"; import "google/api/client.proto"; @@ -95,37 +95,43 @@ service MgmtPublicService { // ========== Metric endpoints - // ListPipelineTriggerRecords method receives a ListPipelineTriggerRecordsRequest message and returns a + // ListPipelineTriggerRecords method receives a + // ListPipelineTriggerRecordsRequest message and returns a // ListPipelineTriggerRecordsResponse message. rpc ListPipelineTriggerRecords(ListPipelineTriggerRecordsRequest) returns (ListPipelineTriggerRecordsResponse) { option (google.api.http) = {get: "/v1alpha/metrics/vdp/pipeline/triggers"}; } - // ListPipelineTriggerTableRecords method receives a ListPipelineTriggerTableRecordsRequest message and returns a + // ListPipelineTriggerTableRecords method receives a + // ListPipelineTriggerTableRecordsRequest message and returns a // ListPipelineTriggerTableRecordsResponse message. rpc ListPipelineTriggerTableRecords(ListPipelineTriggerTableRecordsRequest) returns (ListPipelineTriggerTableRecordsResponse) { option (google.api.http) = {get: "/v1alpha/metrics/vdp/pipeline/tables"}; } - // ListPipelineTriggerChartRecords method receives a ListPipelineTriggerChartRecordsRequest message and returns a + // ListPipelineTriggerChartRecords method receives a + // ListPipelineTriggerChartRecordsRequest message and returns a // ListPipelineTriggerChartRecordsResponse message. rpc ListPipelineTriggerChartRecords(ListPipelineTriggerChartRecordsRequest) returns (ListPipelineTriggerChartRecordsResponse) { option (google.api.http) = {get: "/v1alpha/metrics/vdp/pipeline/charts"}; } - // ListConnectorExecuteRecords method receives a ListConnectorExecuteRecordsRequest message and returns a + // ListConnectorExecuteRecords method receives a + // ListConnectorExecuteRecordsRequest message and returns a // ListConnectorExecuteRecordsResponse message. rpc ListConnectorExecuteRecords(ListConnectorExecuteRecordsRequest) returns (ListConnectorExecuteRecordsResponse) { option (google.api.http) = {get: "/v1alpha/metrics/vdp/connector/executes"}; } - // ListConnectorExecuteTableRecords method receives a ListConnectorExecuteTableRecordsRequest message and returns a + // ListConnectorExecuteTableRecords method receives a + // ListConnectorExecuteTableRecordsRequest message and returns a // ListConnectorExecuteTableRecordsResponse message. rpc ListConnectorExecuteTableRecords(ListConnectorExecuteTableRecordsRequest) returns (ListConnectorExecuteTableRecordsResponse) { option (google.api.http) = {get: "/v1alpha/metrics/vdp/connector/tables"}; } - // ListConnectorExecuteChartRecords method receives a ListConnectorExecuteChartRecordsRequest message and returns a + // ListConnectorExecuteChartRecords method receives a + // ListConnectorExecuteChartRecordsRequest message and returns a // ListConnectorExecuteChartRecordsResponse message. rpc ListConnectorExecuteChartRecords(ListConnectorExecuteChartRecordsRequest) returns (ListConnectorExecuteChartRecordsResponse) { option (google.api.http) = {get: "/v1alpha/metrics/vdp/connector/charts"}; diff --git a/base/usage/v1alpha/usage.proto b/core/usage/v1alpha/usage.proto similarity index 95% rename from base/usage/v1alpha/usage.proto rename to core/usage/v1alpha/usage.proto index 6f9ac109..b0832e22 100644 --- a/base/usage/v1alpha/usage.proto +++ b/core/usage/v1alpha/usage.proto @@ -1,11 +1,11 @@ syntax = "proto3"; -package base.usage.v1alpha; +package core.usage.v1alpha; -import "base/mgmt/v1alpha/metric.proto"; -import "base/mgmt/v1alpha/mgmt.proto"; import "common/healthcheck/v1alpha/healthcheck.proto"; import "common/task/v1alpha/task.proto"; +import "core/mgmt/v1alpha/metric.proto"; +import "core/mgmt/v1alpha/mgmt.proto"; import "google/api/field_behavior.proto"; // Google API import "google/api/resource.proto"; @@ -91,7 +91,7 @@ message Session { // Management service usage data message MgmtUsageData { // Repeated user usage data - repeated base.mgmt.v1alpha.User usages = 1; + repeated core.mgmt.v1alpha.User usages = 1; } // Connector service usage data @@ -109,7 +109,7 @@ message ConnectorUsageData { // Definition UID of the connector string connector_definition_uid = 4 [(google.api.field_behavior) = REQUIRED]; // Final status of the execution - base.mgmt.v1alpha.Status status = 5 [(google.api.field_behavior) = REQUIRED]; + core.mgmt.v1alpha.Status status = 5 [(google.api.field_behavior) = REQUIRED]; } // User UUID string user_uid = 1 [(google.api.field_behavior) = REQUIRED]; @@ -137,7 +137,7 @@ message ModelUsageData { // Task of the model common.task.v1alpha.Task model_task = 5 [(google.api.field_behavior) = REQUIRED]; // Final status of the execution - base.mgmt.v1alpha.Status status = 6 [(google.api.field_behavior) = REQUIRED]; + core.mgmt.v1alpha.Status status = 6 [(google.api.field_behavior) = REQUIRED]; } // User UUID string user_uid = 1 [(google.api.field_behavior) = REQUIRED]; @@ -161,9 +161,9 @@ message PipelineUsageData { // Timestamp for the trigger google.protobuf.Timestamp trigger_time = 3 [(google.api.field_behavior) = REQUIRED]; // Trigger mode - base.mgmt.v1alpha.Mode trigger_mode = 4 [(google.api.field_behavior) = REQUIRED]; + core.mgmt.v1alpha.Mode trigger_mode = 4 [(google.api.field_behavior) = REQUIRED]; // Final status of the execution - base.mgmt.v1alpha.Status status = 5 [(google.api.field_behavior) = REQUIRED]; + core.mgmt.v1alpha.Status status = 5 [(google.api.field_behavior) = REQUIRED]; // Version for the triggered release pipeline, empty string if not release string pipeline_release_id = 6 [(google.api.field_behavior) = REQUIRED]; // UID for the triggered release pipeline, empty string if not release diff --git a/base/usage/v1alpha/usage_service.proto b/core/usage/v1alpha/usage_service.proto similarity index 95% rename from base/usage/v1alpha/usage_service.proto rename to core/usage/v1alpha/usage_service.proto index 38de2069..f2085ee9 100644 --- a/base/usage/v1alpha/usage_service.proto +++ b/core/usage/v1alpha/usage_service.proto @@ -1,8 +1,8 @@ syntax = "proto3"; -package base.usage.v1alpha; +package core.usage.v1alpha; -import "base/usage/v1alpha/usage.proto"; +import "core/usage/v1alpha/usage.proto"; // Google API import "google/api/annotations.proto"; import "google/api/client.proto"; diff --git a/openapiv2/openapiv2.swagger.yaml b/openapiv2/openapiv2.swagger.yaml index f37a23db..36eace18 100644 --- a/openapiv2/openapiv2.swagger.yaml +++ b/openapiv2/openapiv2.swagger.yaml @@ -1,6 +1,6 @@ swagger: "2.0" info: - title: base/metric/v1alpha/metric.proto + title: common/healthcheck/v1alpha/healthcheck.proto version: version not set tags: - name: PipelineService @@ -3667,7 +3667,7 @@ paths: "200": description: A successful response. schema: - $ref: '#/definitions/basemgmtv1alphaLivenessResponse' + $ref: '#/definitions/coremgmtv1alphaLivenessResponse' default: description: An unexpected error response. schema: @@ -3739,7 +3739,7 @@ paths: "200": description: A successful response. schema: - $ref: '#/definitions/baseusagev1alphaLivenessResponse' + $ref: '#/definitions/coreusagev1alphaLivenessResponse' default: description: An unexpected error response. schema: @@ -3755,7 +3755,8 @@ paths: /v1alpha/metrics/vdp/connector/charts: get: summary: |- - ListConnectorExecuteChartRecords method receives a ListConnectorExecuteChartRecordsRequest message and returns a + ListConnectorExecuteChartRecords method receives a + ListConnectorExecuteChartRecordsRequest message and returns a ListConnectorExecuteChartRecordsResponse message. operationId: MgmtPublicService_ListConnectorExecuteChartRecords responses: @@ -3784,7 +3785,8 @@ paths: /v1alpha/metrics/vdp/connector/executes: get: summary: |- - ListConnectorExecuteRecords method receives a ListConnectorExecuteRecordsRequest message and returns a + ListConnectorExecuteRecords method receives a + ListConnectorExecuteRecordsRequest message and returns a ListConnectorExecuteRecordsResponse message. operationId: MgmtPublicService_ListConnectorExecuteRecords responses: @@ -3799,9 +3801,10 @@ paths: parameters: - name: page_size description: |- - The maximum number of connector execution record to return. The service may return - fewer than this value. If unspecified, at most 100 record will be returned. The - maximum value is 1000; values above 1000 will be coerced to 1000. + The maximum number of connector execution record to return. The service may + return fewer than this value. If unspecified, at most 100 record will be + returned. The maximum value is 1000; values above 1000 will be coerced to + 1000. in: query required: false type: integer @@ -3821,7 +3824,8 @@ paths: /v1alpha/metrics/vdp/connector/tables: get: summary: |- - ListConnectorExecuteTableRecords method receives a ListConnectorExecuteTableRecordsRequest message and returns a + ListConnectorExecuteTableRecords method receives a + ListConnectorExecuteTableRecordsRequest message and returns a ListConnectorExecuteTableRecordsResponse message. operationId: MgmtPublicService_ListConnectorExecuteTableRecords responses: @@ -3836,9 +3840,10 @@ paths: parameters: - name: page_size description: |- - The maximum number of connector execution table record to return. The service may return - fewer than this value. If unspecified, at most 100 record will be returned. The - maximum value is 1000; values above 1000 will be coerced to 1000. + The maximum number of connector execution table record to return. The + service may return fewer than this value. If unspecified, at most 100 + record will be returned. The maximum value is 1000; values above 1000 will + be coerced to 1000. in: query required: false type: integer @@ -3858,7 +3863,8 @@ paths: /v1alpha/metrics/vdp/pipeline/charts: get: summary: |- - ListPipelineTriggerChartRecords method receives a ListPipelineTriggerChartRecordsRequest message and returns a + ListPipelineTriggerChartRecords method receives a + ListPipelineTriggerChartRecordsRequest message and returns a ListPipelineTriggerChartRecordsResponse message. operationId: MgmtPublicService_ListPipelineTriggerChartRecords responses: @@ -3887,7 +3893,8 @@ paths: /v1alpha/metrics/vdp/pipeline/tables: get: summary: |- - ListPipelineTriggerTableRecords method receives a ListPipelineTriggerTableRecordsRequest message and returns a + ListPipelineTriggerTableRecords method receives a + ListPipelineTriggerTableRecordsRequest message and returns a ListPipelineTriggerTableRecordsResponse message. operationId: MgmtPublicService_ListPipelineTriggerTableRecords responses: @@ -3902,9 +3909,10 @@ paths: parameters: - name: page_size description: |- - The maximum number of pipeline trigger record to return. The service may return - fewer than this value. If unspecified, at most 100 record will be returned. The - maximum value is 1000; values above 1000 will be coerced to 1000. + The maximum number of pipeline trigger record to return. The service may + return fewer than this value. If unspecified, at most 100 record will be + returned. The maximum value is 1000; values above 1000 will be coerced to + 1000. in: query required: false type: integer @@ -3924,7 +3932,8 @@ paths: /v1alpha/metrics/vdp/pipeline/triggers: get: summary: |- - ListPipelineTriggerRecords method receives a ListPipelineTriggerRecordsRequest message and returns a + ListPipelineTriggerRecords method receives a + ListPipelineTriggerRecordsRequest message and returns a ListPipelineTriggerRecordsResponse message. operationId: MgmtPublicService_ListPipelineTriggerRecords responses: @@ -3939,9 +3948,10 @@ paths: parameters: - name: page_size description: |- - The maximum number of pipeline trigger record to return. The service may return - fewer than this value. If unspecified, at most 100 record will be returned. The - maximum value is 1000; values above 1000 will be coerced to 1000. + The maximum number of pipeline trigger record to return. The service may + return fewer than this value. If unspecified, at most 100 record will be + returned. The maximum value is 1000; values above 1000 will be coerced to + 1000. in: query required: false type: integer @@ -4190,7 +4200,7 @@ paths: "200": description: A successful response. schema: - $ref: '#/definitions/basemgmtv1alphaReadinessResponse' + $ref: '#/definitions/coremgmtv1alphaReadinessResponse' default: description: An unexpected error response. schema: @@ -4550,21 +4560,21 @@ definitions: - status - pipeline_release_id - pipeline_release_uid - basemgmtv1alphaLivenessResponse: + coremgmtv1alphaLivenessResponse: type: object properties: health_check_response: $ref: '#/definitions/v1alphaHealthCheckResponse' title: HealthCheckResponse message title: LivenessResponse represents a response for a service liveness status - basemgmtv1alphaReadinessResponse: + coremgmtv1alphaReadinessResponse: type: object properties: health_check_response: $ref: '#/definitions/v1alphaHealthCheckResponse' title: HealthCheckResponse message title: ReadinessResponse represents a response for a service readiness status - basemgmtv1alphaView: + coremgmtv1alphaView: type: string enum: - VIEW_UNSPECIFIED @@ -4579,14 +4589,14 @@ definitions: - VIEW_UNSPECIFIED: View: UNSPECIFIED, equivalent to BASIC. - VIEW_BASIC: View: BASIC - VIEW_FULL: View: FULL - baseusagev1alphaLivenessResponse: + coreusagev1alphaLivenessResponse: type: object properties: health_check_response: $ref: '#/definitions/v1alphaHealthCheckResponse' title: HealthCheckResponse message title: LivenessResponse represents a response for a service liveness status - baseusagev1alphaReadinessResponse: + coreusagev1alphaReadinessResponse: type: object properties: health_check_response: @@ -5341,7 +5351,9 @@ definitions: format: float title: Total compute time duration in each time bucket readOnly: true - title: ConnectorExecuteChartRecord represents a aggregated chart record for connector execute + title: |- + ConnectorExecuteChartRecord represents a aggregated chart record for + connector execute v1alphaConnectorExecuteRecord: type: object properties: @@ -5399,7 +5411,9 @@ definitions: format: int32 title: Execute count with STATUS_ERRORED readOnly: true - title: ConnectorExecuteTableRecord represents a aggregated table record for connector execute + title: |- + ConnectorExecuteTableRecord represents a aggregated table record for + connector execute v1alphaConnectorResource: type: object properties: @@ -7437,7 +7451,9 @@ definitions: type: string title: UID for the triggered pipeline if it is a release pipeline, else emtpy readOnly: true - title: PipelineTriggerChartRecord represents a aggregated chart record for pipeline trigger + title: |- + PipelineTriggerChartRecord represents a aggregated chart record for pipeline + trigger v1alphaPipelineTriggerRecord: type: object properties: @@ -7502,7 +7518,9 @@ definitions: type: string title: UID for the triggered pipeline if it is a release pipeline, else emtpy readOnly: true - title: PipelineTriggerTableRecord represents a aggregated table record for pipeline trigger + title: |- + PipelineTriggerTableRecord represents a aggregated table record for pipeline + trigger v1alphaPipelineUsageData: type: object properties: