Skip to content

Database governance built for humans and agents — controlling changes and access across every major database.

fix: group iam (#19174)

ecmadao2166ec1e310f
diff --git a/backend/api/mcp/gen/openapi.yaml b/backend/api/mcp/gen/openapi.yaml
index fe2dc507a9..04842074d0 100644
--- a/backend/api/mcp/gen/openapi.yaml
+++ b/backend/api/mcp/gen/openapi.yaml
@@ -5,7 +5,7 @@ paths:
post:
tags:
- bytebase.v1.ActuatorService
- summary: 'Clears the system cache to force data refresh. Permissions required: None'
+ summary: DeleteCache
description: |-
Clears the system cache to force data refresh.
Permissions required: None
@@ -43,7 +43,7 @@ paths:
post:
tags:
- bytebase.v1.ActuatorService
- summary: 'Gets system information and health status of the Bytebase instance. Permissions required: None'
+ summary: GetActuatorInfo
description: |-
Gets system information and health status of the Bytebase instance.
Permissions required: None
@@ -81,7 +81,7 @@ paths:
post:
tags:
- bytebase.v1.ActuatorService
- summary: 'Gets custom branding resources such as logos. Permissions required: None'
+ summary: GetResourcePackage
description: |-
Gets custom branding resources such as logos.
Permissions required: None
@@ -119,7 +119,7 @@ paths:
post:
tags:
- bytebase.v1.ActuatorService
- summary: 'Sets up sample data for demonstration and testing purposes. Permissions required: bb.projects.create'
+ summary: SetupSample
description: |-
Sets up sample data for demonstration and testing purposes.
Permissions required: bb.projects.create
@@ -157,7 +157,7 @@ paths:
post:
tags:
- bytebase.v1.AuditLogService
- summary: 'Exports audit logs in a specified format for external analysis. Permissions required: bb.auditLogs.export'
+ summary: ExportAuditLogs
description: |-
Exports audit logs in a specified format for external analysis.
Permissions required: bb.auditLogs.export
@@ -195,7 +195,7 @@ paths:
post:
tags:
- bytebase.v1.AuditLogService
- summary: 'Searches audit logs with optional filtering and pagination. Permissions required: bb.auditLogs.search'
+ summary: SearchAuditLogs
description: |-
Searches audit logs with optional filtering and pagination.
Permissions required: bb.auditLogs.search
@@ -233,7 +233,7 @@ paths:
post:
tags:
- bytebase.v1.AuthService
- summary: 'Exchanges an external OIDC token for a Bytebase access token. Used by CI/CD pipelines with Workload Identity Federation. Permissions required: None (validates via OIDC token)'
+ summary: ExchangeToken
description: |-
Exchanges an external OIDC token for a Bytebase access token.
Used by CI/CD pipelines with Workload Identity Federation.
@@ -272,7 +272,7 @@ paths:
post:
tags:
- bytebase.v1.AuthService
- summary: 'Authenticates a user and returns access tokens. Permissions required: None'
+ summary: Login
description: |-
Authenticates a user and returns access tokens.
Permissions required: None
@@ -310,7 +310,7 @@ paths:
post:
tags:
- bytebase.v1.AuthService
- summary: 'Logs out the current user session. Permissions required: None'
+ summary: Logout
description: |-
Logs out the current user session.
Permissions required: None
@@ -348,7 +348,7 @@ paths:
post:
tags:
- bytebase.v1.AuthService
- summary: 'Refreshes the access token using the refresh token cookie. Permissions required: None (validates via refresh token cookie)'
+ summary: Refresh
description: |-
Refreshes the access token using the refresh token cookie.
Permissions required: None (validates via refresh token cookie)
@@ -386,7 +386,7 @@ paths:
post:
tags:
- bytebase.v1.CelService
- summary: 'Converts multiple CEL AST representations back into expression strings. Permissions required: None'
+ summary: BatchDeparse
description: |-
Converts multiple CEL AST representations back into expression strings.
Permissions required: None
@@ -424,7 +424,7 @@ paths:
post:
tags:
- bytebase.v1.CelService
- summary: 'Parses multiple CEL expression strings into AST representations. Permissions required: None'
+ summary: BatchParse
description: |-
Parses multiple CEL expression strings into AST representations.
Permissions required: None
@@ -462,7 +462,7 @@ paths:
post:
tags:
- bytebase.v1.DatabaseCatalogService
- summary: 'Gets the catalog metadata for a database. Permissions required: bb.databaseCatalogs.get'
+ summary: GetDatabaseCatalog
description: |-
Gets the catalog metadata for a database.
Permissions required: bb.databaseCatalogs.get
@@ -500,7 +500,7 @@ paths:
post:
tags:
- bytebase.v1.DatabaseCatalogService
- summary: 'Updates catalog metadata such as classifications and labels. Permissions required: bb.databaseCatalogs.update'
+ summary: UpdateDatabaseCatalog
description: |-
Updates catalog metadata such as classifications and labels.
Permissions required: bb.databaseCatalogs.update
@@ -538,7 +538,7 @@ paths:
post:
tags:
- bytebase.v1.DatabaseGroupService
- summary: 'Creates a new database group. Permissions required: bb.databaseGroups.create'
+ summary: CreateDatabaseGroup
description: |-
Creates a new database group.
Permissions required: bb.databaseGroups.create
@@ -576,7 +576,7 @@ paths:
post:
tags:
- bytebase.v1.DatabaseGroupService
- summary: 'Deletes a database group. Permissions required: bb.databaseGroups.delete'
+ summary: DeleteDatabaseGroup
description: |-
Deletes a database group.
Permissions required: bb.databaseGroups.delete
@@ -614,7 +614,7 @@ paths:
post:
tags:
- bytebase.v1.DatabaseGroupService
- summary: 'Gets a database group by name. Permissions required: bb.databaseGroups.get'
+ summary: GetDatabaseGroup
description: |-
Gets a database group by name.
Permissions required: bb.databaseGroups.get
@@ -652,7 +652,7 @@ paths:
post:
tags:
- bytebase.v1.DatabaseGroupService
- summary: 'Lists database groups in a project. Permissions required: bb.databaseGroups.list'
+ summary: ListDatabaseGroups
description: |-
Lists database groups in a project.
Permissions required: bb.databaseGroups.list
@@ -690,7 +690,7 @@ paths:
post:
tags:
- bytebase.v1.DatabaseGroupService
- summary: 'Updates a database group. Permissions required: bb.databaseGroups.update When allow_missing=true, also requires: bb.databaseGroups.create'
+ summary: UpdateDatabaseGroup
description: |-
Updates a database group.
Permissions required: bb.databaseGroups.update
@@ -729,7 +729,7 @@ paths:
post:
tags:
- bytebase.v1.DatabaseService
- summary: 'Retrieves multiple databases by their names. Permissions required: bb.databases.get'
+ summary: BatchGetDatabases
description: |-
Retrieves multiple databases by their names.
Permissions required: bb.databases.get
@@ -767,7 +767,7 @@ paths:
post:
tags:
- bytebase.v1.DatabaseService
- summary: 'Synchronizes multiple databases in a single batch operation. Permissions required: bb.databases.sync'
+ summary: BatchSyncDatabases
description: |-
Synchronizes multiple databases in a single batch operation.
Permissions required: bb.databases.sync
@@ -805,7 +805,7 @@ paths:
post:
tags:
- bytebase.v1.DatabaseService
- summary: 'Updates multiple databases in a single batch operation. Permissions required: bb.databases.update'
+ summary: BatchUpdateDatabases
description: |-
Updates multiple databases in a single batch operation.
Permissions required: bb.databases.update
@@ -843,7 +843,7 @@ paths:
post:
tags:
- bytebase.v1.DatabaseService
- summary: 'Compares and generates migration statements between two schemas. Permissions required: bb.databases.get'
+ summary: DiffSchema
description: |-
Compares and generates migration statements between two schemas.
Permissions required: bb.databases.get
@@ -881,7 +881,7 @@ paths:
post:
tags:
- bytebase.v1.DatabaseService
- summary: 'Retrieves a specific changelog entry. Permissions required: bb.changelogs.get'
+ summary: GetChangelog
description: |-
Retrieves a specific changelog entry.
Permissions required: bb.changelogs.get
@@ -919,7 +919,7 @@ paths:
post:
tags:
- bytebase.v1.DatabaseService
- summary: 'Retrieves a database by name. Permissions required: bb.databases.get'
+ summary: GetDatabase
description: |-
Retrieves a database by name.
Permissions required: bb.databases.get
@@ -957,7 +957,7 @@ paths:
post:
tags:
- bytebase.v1.DatabaseService
- summary: 'Retrieves database metadata including tables, columns, and indexes. Permissions required: bb.databases.getSchema'
+ summary: GetDatabaseMetadata
description: |-
Retrieves database metadata including tables, columns, and indexes.
Permissions required: bb.databases.getSchema
@@ -995,7 +995,7 @@ paths:
post:
tags:
- bytebase.v1.DatabaseService
- summary: 'Retrieves database schema in SDL (Schema Definition Language) format. Permissions required: bb.databases.getSchema'
+ summary: GetDatabaseSDLSchema
description: |-
Retrieves database schema in SDL (Schema Definition Language) format.
Permissions required: bb.databases.getSchema
@@ -1033,7 +1033,7 @@ paths:
post:
tags:
- bytebase.v1.DatabaseService
- summary: 'Retrieves database schema as DDL statements. Permissions required: bb.databases.getSchema'
+ summary: GetDatabaseSchema
description: |-
Retrieves database schema as DDL statements.
Permissions required: bb.databases.getSchema
@@ -1071,7 +1071,7 @@ paths:
post:
tags:
- bytebase.v1.DatabaseService
- summary: 'Generates schema DDL for a database object. Permissions required: bb.databases.getSchema'
+ summary: GetSchemaString
description: |-
Generates schema DDL for a database object.
Permissions required: bb.databases.getSchema
@@ -1109,7 +1109,7 @@ paths:
post:
tags:
- bytebase.v1.DatabaseService
- summary: 'Lists migration history for a database. Permissions required: bb.changelogs.list'
+ summary: ListChangelogs
description: |-
Lists migration history for a database.
Permissions required: bb.changelogs.list
@@ -1147,7 +1147,7 @@ paths:
post:
tags:
- bytebase.v1.DatabaseService
- summary: 'Lists databases in a project, instance, or workspace. Permissions required: bb.projects.get (for project parent), bb.databases.list (for workspace parent), or bb.instances.get (for instance parent)'
+ summary: ListDatabases
description: |-
Lists databases in a project, instance, or workspace.
Permissions required: bb.projects.get (for project parent), bb.databases.list (for workspace parent), or bb.instances.get (for instance parent)
@@ -1185,7 +1185,7 @@ paths:
post:
tags:
- bytebase.v1.DatabaseService
- summary: 'Synchronizes database schema from the instance. Permissions required: bb.databases.sync'
+ summary: SyncDatabase
description: |-
Synchronizes database schema from the instance.
Permissions required: bb.databases.sync
@@ -1223,7 +1223,7 @@ paths:
post:
tags:
- bytebase.v1.DatabaseService
- summary: 'Updates database properties such as labels and project assignment. Permissions required: bb.databases.update'
+ summary: UpdateDatabase
description: |-
Updates database properties such as labels and project assignment.
Permissions required: bb.databases.update
@@ -1261,10 +1261,11 @@ paths:
post:
tags:
- bytebase.v1.GroupService
- summary: 'Gets multiple groups in a single request. Permissions required: bb.groups.get'
+ summary: BatchGetGroups
description: |-
Gets multiple groups in a single request.
- Permissions required: bb.groups.get
+ Group members or users with bb.groups.get permission can get the group.
+ Permissions required: bb.groups.get OR caller is the group member
operationId: bytebase.v1.GroupService.BatchGetGroups
parameters:
- name: Connect-Protocol-Version
@@ -1299,7 +1300,7 @@ paths:
post:
tags:
- bytebase.v1.GroupService
- summary: 'Creates a new group. Permissions required: bb.groups.create'
+ summary: CreateGroup
description: |-
Creates a new group.
Permissions required: bb.groups.create
@@ -1337,7 +1338,7 @@ paths:
post:
tags:
- bytebase.v1.GroupService
- summary: 'Deletes a group. Group owners or users with bb.groups.delete permission can delete. Permissions required: bb.groups.delete OR caller is group owner'
+ summary: DeleteGroup
description: |-
Deletes a group. Group owners or users with bb.groups.delete permission can delete.
Permissions required: bb.groups.delete OR caller is group owner
@@ -1375,10 +1376,11 @@ paths:
post:
tags:
- bytebase.v1.GroupService
- summary: 'Gets a group by name. Permissions required: bb.groups.get'
+ summary: GetGroup
description: |-
Gets a group by name.
- Permissions required: bb.groups.get
+ Group members or users with bb.groups.get permission can get the group.
+ Permissions required: bb.groups.get OR caller is the group member
operationId: bytebase.v1.GroupService.GetGroup
parameters:
- name: Connect-Protocol-Version
@@ -1413,7 +1415,7 @@ paths:
post:
tags:
- bytebase.v1.GroupService
- summary: 'Lists all groups in the workspace. Permissions required: bb.groups.list'
+ summary: ListGroups
description: |-
Lists all groups in the workspace.
Permissions required: bb.groups.list
@@ -1451,7 +1453,7 @@ paths:
post:
tags:
- bytebase.v1.GroupService
- summary: 'Updates a group. Group owners or users with bb.groups.update permission can update. Permissions required: bb.groups.update OR caller is group owner When allow_missing=true, also requires: bb.groups.create'
+ summary: UpdateGroup
description: |-
Updates a group. Group owners or users with bb.groups.update permission can update.
Permissions required: bb.groups.update OR caller is group owner
@@ -1490,7 +1492,7 @@ paths:
post:
tags:
- bytebase.v1.IdentityProviderService
- summary: 'Creates a new identity provider. Permissions required: bb.identityProviders.create'
+ summary: CreateIdentityProvider
description: |-
Creates a new identity provider.
Permissions required: bb.identityProviders.create
@@ -1528,7 +1530,7 @@ paths:
post:
tags:
- bytebase.v1.IdentityProviderService
- summary: 'Deletes an identity provider. Permissions required: bb.identityProviders.delete'
+ summary: DeleteIdentityProvider
description: |-
Deletes an identity provider.
Permissions required: bb.identityProviders.delete
@@ -1566,7 +1568,7 @@ paths:
post:
tags:
- bytebase.v1.IdentityProviderService
- summary: 'Gets an identity provider by name. Permissions required: bb.identityProviders.get'
+ summary: GetIdentityProvider
description: |-
Gets an identity provider by name.
Permissions required: bb.identityProviders.get
@@ -1604,7 +1606,7 @@ paths:
post:
tags:
- bytebase.v1.IdentityProviderService
- summary: 'Lists all configured identity providers (public endpoint for login page). Permissions required: None'
+ summary: ListIdentityProviders
description: |-
Lists all configured identity providers (public endpoint for login page).
Permissions required: None
@@ -1642,7 +1644,7 @@ paths:
post:
tags:
- bytebase.v1.IdentityProviderService
- summary: 'Tests the connection and configuration of an identity provider. Permissions required: bb.identityProviders.update'
+ summary: TestIdentityProvider
description: |-
Tests the connection and configuration of an identity provider.
Permissions required: bb.identityProviders.update
@@ -1680,7 +1682,7 @@ paths:
post:
tags:
- bytebase.v1.IdentityProviderService
- summary: 'Updates an identity provider. Permissions required: bb.identityProviders.update When allow_missing=true, also requires: bb.identityProviders.create'
+ summary: UpdateIdentityProvider
description: |-
Updates an identity provider.
Permissions required: bb.identityProviders.update
@@ -1719,7 +1721,7 @@ paths:
post:
tags:
- bytebase.v1.InstanceRoleService
- summary: 'Lists all database roles in an instance. Permissions required: bb.instanceRoles.list'
+ summary: ListInstanceRoles
description: |-
Lists all database roles in an instance.
Permissions required: bb.instanceRoles.list
@@ -1757,7 +1759,7 @@ paths:
post:
tags:
- bytebase.v1.InstanceService
- summary: 'Adds a read-only data source to an instance. Permissions required: bb.instances.update'
+ summary: AddDataSource
description: |-
Adds a read-only data source to an instance.
Permissions required: bb.instances.update
@@ -1795,7 +1797,7 @@ paths:
post:
tags:
- bytebase.v1.InstanceService
- summary: 'Syncs multiple instances in a single request. Permissions required: bb.instances.sync'
+ summary: BatchSyncInstances
description: |-
Syncs multiple instances in a single request.
Permissions required: bb.instances.sync
@@ -1833,7 +1835,7 @@ paths:
post:
tags:
- bytebase.v1.InstanceService
- summary: 'Updates multiple instances in a single request. Permissions required: bb.instances.update'
+ summary: BatchUpdateInstances
description: |-
Updates multiple instances in a single request.
Permissions required: bb.instances.update
@@ -1871,7 +1873,7 @@ paths:
post:
tags:
- bytebase.v1.InstanceService
- summary: 'Creates a new database instance. Permissions required: bb.instances.create'
+ summary: CreateInstance
description: |-
Creates a new database instance.
Permissions required: bb.instances.create
@@ -1909,7 +1911,7 @@ paths:
post:
tags:
- bytebase.v1.InstanceService
- summary: 'Deletes or soft-deletes a database instance. Permissions required: bb.instances.delete'
+ summary: DeleteInstance
description: |-
Deletes or soft-deletes a database instance.
Permissions required: bb.instances.delete
@@ -1947,7 +1949,7 @@ paths:
post:
tags:
- bytebase.v1.InstanceService
- summary: 'Gets a database instance by name. Permissions required: bb.instances.get'
+ summary: GetInstance
description: |-
Gets a database instance by name.
Permissions required: bb.instances.get
@@ -1985,7 +1987,7 @@ paths:
post:
tags:
- bytebase.v1.InstanceService
- summary: 'Lists all databases within an instance without creating them. Permissions required: bb.instances.get'
+ summary: ListInstanceDatabase
description: |-
Lists all databases within an instance without creating them.
Permissions required: bb.instances.get
@@ -2023,7 +2025,7 @@ paths:
post:
tags:
- bytebase.v1.InstanceService
- summary: 'Lists all database instances. Permissions required: bb.instances.list'
+ summary: ListInstances
description: |-
Lists all database instances.
Permissions required: bb.instances.list
@@ -2061,7 +2063,7 @@ paths:
post:
tags:
- bytebase.v1.InstanceService
- summary: 'Removes a read-only data source from an instance. Permissions required: bb.instances.update'
+ summary: RemoveDataSource
description: |-
Removes a read-only data source from an instance.
Permissions required: bb.instances.update
@@ -2099,7 +2101,7 @@ paths:
post:
tags:
- bytebase.v1.InstanceService
- summary: 'Syncs database schemas and metadata from an instance. Permissions required: bb.instances.sync'
+ summary: SyncInstance
description: |-
Syncs database schemas and metadata from an instance.
Permissions required: bb.instances.sync
@@ -2137,7 +2139,7 @@ paths:
post:
tags:
- bytebase.v1.InstanceService
- summary: 'Restores a soft-deleted database instance. Permissions required: bb.instances.undelete'
+ summary: UndeleteInstance
description: |-
Restores a soft-deleted database instance.
Permissions required: bb.instances.undelete
@@ -2175,7 +2177,7 @@ paths:
post:
tags:
- bytebase.v1.InstanceService
- summary: 'Updates a data source configuration. Permissions required: bb.instances.update'
+ summary: UpdateDataSource
description: |-
Updates a data source configuration.
Permissions required: bb.instances.update
@@ -2213,7 +2215,7 @@ paths:
post:
tags:
- bytebase.v1.InstanceService
- summary: 'Updates a database instance. Permissions required: bb.instances.update'
+ summary: UpdateInstance
description: |-
Updates a database instance.
Permissions required: bb.instances.update
@@ -2251,7 +2253,7 @@ paths:
post:
tags:
- bytebase.v1.IssueService
- summary: 'Approves an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step. Permissions required: None (determined by approval flow)'
+ summary: ApproveIssue
description: |-
Approves an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step.
Permissions required: None (determined by approval flow)
@@ -2289,7 +2291,7 @@ paths:
post:
tags:
- bytebase.v1.IssueService
- summary: 'Updates the status of multiple issues in a single operation. Permissions required: bb.issues.update'
+ summary: BatchUpdateIssuesStatus
description: |-
Updates the status of multiple issues in a single operation.
Permissions required: bb.issues.update
@@ -2327,7 +2329,7 @@ paths:
post:
tags:
- bytebase.v1.IssueService
- summary: 'Creates a new issue for database changes or tasks. Permissions required: bb.issues.create'
+ summary: CreateIssue
description: |-
Creates a new issue for database changes or tasks.
Permissions required: bb.issues.create
@@ -2365,7 +2367,7 @@ paths:
post:
tags:
- bytebase.v1.IssueService
- summary: 'Adds a comment to an issue. Permissions required: bb.issueComments.create'
+ summary: CreateIssueComment
description: |-
Adds a comment to an issue.
Permissions required: bb.issueComments.create
@@ -2403,7 +2405,7 @@ paths:
post:
tags:
- bytebase.v1.IssueService
- summary: 'Retrieves an issue by name. Permissions required: bb.issues.get'
+ summary: GetIssue
description: |-
Retrieves an issue by name.
Permissions required: bb.issues.get
@@ -2441,7 +2443,7 @@ paths:
post:
tags:
- bytebase.v1.IssueService
- summary: 'Lists comments on an issue. Permissions required: bb.issueComments.list'
+ summary: ListIssueComments
description: |-
Lists comments on an issue.
Permissions required: bb.issueComments.list
@@ -2479,7 +2481,7 @@ paths:
post:
tags:
- bytebase.v1.IssueService
- summary: 'Lists issues in a project. Permissions required: bb.issues.list'
+ summary: ListIssues
description: |-
Lists issues in a project.
Permissions required: bb.issues.list
@@ -2517,7 +2519,7 @@ paths:
post:
tags:
- bytebase.v1.IssueService
- summary: 'Rejects an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step. Permissions required: None (determined by approval flow)'
+ summary: RejectIssue
description: |-
Rejects an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step.
Permissions required: None (determined by approval flow)
@@ -2555,7 +2557,7 @@ paths:
post:
tags:
- bytebase.v1.IssueService
- summary: 'Requests changes on an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step. Permissions required: None (determined by approval flow)'
+ summary: RequestIssue
description: |-
Requests changes on an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step.
Permissions required: None (determined by approval flow)
@@ -2593,7 +2595,7 @@ paths:
post:
tags:
- bytebase.v1.IssueService
- summary: 'Search for issues that the caller has the bb.issues.get permission on and also satisfy the specified filter & query. Permissions required: bb.issues.get'
+ summary: SearchIssues
description: |-
Search for issues that the caller has the bb.issues.get permission on and also satisfy the specified filter & query.
Permissions required: bb.issues.get
@@ -2631,7 +2633,7 @@ paths:
post:
tags:
- bytebase.v1.IssueService
- summary: 'Updates an issue''s properties such as title, description, or labels. Permissions required: bb.issues.update'
+ summary: UpdateIssue
description: |-
Updates an issue's properties such as title, description, or labels.
Permissions required: bb.issues.update
@@ -2669,7 +2671,7 @@ paths:
post:
tags:
- bytebase.v1.IssueService
- summary: 'Updates an existing issue comment. Permissions required: bb.issueComments.update'
+ summary: UpdateIssueComment
description: |-
Updates an existing issue comment.
Permissions required: bb.issueComments.update
@@ -2707,7 +2709,7 @@ paths:
post:
tags:
- bytebase.v1.OrgPolicyService
- summary: 'Creates a new organizational policy. Permissions required: bb.policies.create'
+ summary: CreatePolicy
description: |-
Creates a new organizational policy.
Permissions required: bb.policies.create
@@ -2745,7 +2747,7 @@ paths:
post:
tags:
- bytebase.v1.OrgPolicyService
- summary: 'Deletes an organizational policy. Permissions required: bb.policies.delete'
+ summary: DeletePolicy
description: |-
Deletes an organizational policy.
Permissions required: bb.policies.delete
@@ -2783,7 +2785,7 @@ paths:
post:
tags:
- bytebase.v1.OrgPolicyService
- summary: 'Retrieves a policy by name. Permissions required: bb.policies.get'
+ summary: GetPolicy
description: |-
Retrieves a policy by name.
Permissions required: bb.policies.get
@@ -2821,7 +2823,7 @@ paths:
post:
tags:
- bytebase.v1.OrgPolicyService
- summary: 'Lists policies at a specified resource level. Permissions required: bb.policies.list'
+ summary: ListPolicies
description: |-
Lists policies at a specified resource level.
Permissions required: bb.policies.list
@@ -2859,7 +2861,7 @@ paths:
post:
tags:
- bytebase.v1.OrgPolicyService
- summary: 'Updates an existing organizational policy. Permissions required: bb.policies.update'
+ summary: UpdatePolicy
description: |-
Updates an existing organizational policy.
Permissions required: bb.policies.update
@@ -2897,7 +2899,7 @@ paths:
post:
tags:
- bytebase.v1.PlanService
- summary: 'Cancels the plan check run for a deployment plan. Permissions required: bb.planCheckRuns.run'
+ summary: CancelPlanCheckRun
description: |-
Cancels the plan check run for a deployment plan.
Permissions required: bb.planCheckRuns.run
@@ -2935,7 +2937,7 @@ paths:
post:
tags:
- bytebase.v1.PlanService
- summary: 'Creates a new deployment plan. Permissions required: bb.plans.create'
+ summary: CreatePlan
description: |-
Creates a new deployment plan.
Permissions required: bb.plans.create
@@ -2973,7 +2975,7 @@ paths:
post:
tags:
- bytebase.v1.PlanService
- summary: 'Retrieves a deployment plan by name. Permissions required: bb.plans.get'
+ summary: GetPlan
description: |-
Retrieves a deployment plan by name.
Permissions required: bb.plans.get
@@ -3011,7 +3013,7 @@ paths:
post:
tags:
- bytebase.v1.PlanService
- summary: 'Gets the plan check run for a deployment plan. Permissions required: bb.planCheckRuns.get'
+ summary: GetPlanCheckRun
description: |-
Gets the plan check run for a deployment plan.
Permissions required: bb.planCheckRuns.get
@@ -3049,7 +3051,7 @@ paths:
post:
tags:
- bytebase.v1.PlanService
- summary: 'Lists deployment plans in a project. Permissions required: bb.plans.list'
+ summary: ListPlans
description: |-
Lists deployment plans in a project.
Permissions required: bb.plans.list
@@ -3087,7 +3089,7 @@ paths:
post:
tags:
- bytebase.v1.PlanService
- summary: 'Executes validation checks on a deployment plan. Permissions required: bb.planCheckRuns.run'
+ summary: RunPlanChecks
description: |-
Executes validation checks on a deployment plan.
Permissions required: bb.planCheckRuns.run
@@ -3125,7 +3127,7 @@ paths:
post:
tags:
- bytebase.v1.PlanService
- summary: 'UpdatePlan updates the plan. The plan creator and the user with bb.plans.update permission on the project can update the plan. Permissions required: bb.plans.update (or creator)'
+ summary: UpdatePlan
description: |-
UpdatePlan updates the plan.
The plan creator and the user with bb.plans.update permission on the project can update the plan.
@@ -3164,7 +3166,7 @@ paths:
post:
tags:
- bytebase.v1.ProjectService
- summary: 'Adds a webhook to a project for notifications. Permissions required: bb.projects.update'
+ summary: AddWebhook
description: |-
Adds a webhook to a project for notifications.
Permissions required: bb.projects.update
@@ -3202,7 +3204,7 @@ paths:
post:
tags:
- bytebase.v1.ProjectService
- summary: 'Deletes multiple projects in a single operation. Permissions required: bb.projects.delete'
+ summary: BatchDeleteProjects
description: |-
Deletes multiple projects in a single operation.
Permissions required: bb.projects.delete
@@ -3240,7 +3242,7 @@ paths:
post:
tags:
- bytebase.v1.ProjectService
- summary: 'BatchGetProjects retrieves multiple projects by their names. Permissions required: bb.projects.get'
+ summary: BatchGetProjects
description: |-
BatchGetProjects retrieves multiple projects by their names.
Permissions required: bb.projects.get
@@ -3278,7 +3280,7 @@ paths:
post:
tags:
- bytebase.v1.ProjectService
- summary: 'Creates a new project in the workspace. Permissions required: bb.projects.create'
+ summary: CreateProject
description: |-
Creates a new project in the workspace.
Permissions required: bb.projects.create
@@ -3316,7 +3318,7 @@ paths:
post:
tags:
- bytebase.v1.ProjectService
- summary: 'Deletes (soft-delete or purge) a project. Permissions required: bb.projects.delete'
+ summary: DeleteProject
description: |-
Deletes (soft-delete or purge) a project.
Permissions required: bb.projects.delete
@@ -3354,7 +3356,7 @@ paths:
post:
tags:
- bytebase.v1.ProjectService
- summary: 'Retrieves the IAM policy for a project. Permissions required: bb.projects.getIamPolicy'
+ summary: GetIamPolicy
description: |-
Retrieves the IAM policy for a project.
Permissions required: bb.projects.getIamPolicy
@@ -3392,7 +3394,7 @@ paths:
post:
tags:
- bytebase.v1.ProjectService
- summary: 'GetProject retrieves a project by name. Users with "bb.projects.get" permission on the workspace or the project owner can access this method. Permissions required: bb.projects.get'
+ summary: GetProject
description: |-
GetProject retrieves a project by name.
Users with "bb.projects.get" permission on the workspace or the project owner can access this method.
@@ -3431,7 +3433,7 @@ paths:
post:
tags:
- bytebase.v1.ProjectService
- summary: 'Lists all projects in the workspace with optional filtering. Permissions required: bb.projects.list'
+ summary: ListProjects
description: |-
Lists all projects in the workspace with optional filtering.
Permissions required: bb.projects.list
@@ -3469,7 +3471,7 @@ paths:
post:
tags:
- bytebase.v1.ProjectService
- summary: 'Removes a webhook from a project. Permissions required: bb.projects.update'
+ summary: RemoveWebhook
description: |-
Removes a webhook from a project.
Permissions required: bb.projects.update
@@ -3507,7 +3509,7 @@ paths:
post:
tags:
- bytebase.v1.ProjectService
- summary: 'Searches for projects with advanced filtering capabilities. Permissions required: bb.projects.get (or project-level bb.projects.get for specific projects)'
+ summary: SearchProjects
description: |-
Searches for projects with advanced filtering capabilities.
Permissions required: bb.projects.get (or project-level bb.projects.get for specific projects)
@@ -3545,7 +3547,7 @@ paths:
post:
tags:
- bytebase.v1.ProjectService
- summary: 'Sets the IAM policy for a project. Permissions required: bb.projects.setIamPolicy'
+ summary: SetIamPolicy
description: |-
Sets the IAM policy for a project.
Permissions required: bb.projects.setIamPolicy
@@ -3583,7 +3585,7 @@ paths:
post:
tags:
- bytebase.v1.ProjectService
- summary: 'Tests a webhook by sending a test notification. Permissions required: bb.projects.update'
+ summary: TestWebhook
description: |-
Tests a webhook by sending a test notification.
Permissions required: bb.projects.update
@@ -3621,7 +3623,7 @@ paths:
post:
tags:
- bytebase.v1.ProjectService
- summary: 'Restores a soft-deleted project. Permissions required: bb.projects.undelete'
+ summary: UndeleteProject
description: |-
Restores a soft-deleted project.
Permissions required: bb.projects.undelete
@@ -3659,7 +3661,7 @@ paths:
post:
tags:
- bytebase.v1.ProjectService
- summary: 'Updates an existing project''s properties. Permissions required: bb.projects.update'
+ summary: UpdateProject
description: |-
Updates an existing project's properties.
Permissions required: bb.projects.update
@@ -3697,7 +3699,7 @@ paths:
post:
tags:
- bytebase.v1.ProjectService
- summary: 'Updates an existing webhook configuration. Permissions required: bb.projects.update'
+ summary: UpdateWebhook
description: |-
Updates an existing webhook configuration.
Permissions required: bb.projects.update
@@ -3735,7 +3737,7 @@ paths:
post:
tags:
- bytebase.v1.ReleaseService
- summary: 'Validates a release by dry-running checks on target databases. Permissions required: bb.releases.check'
+ summary: CheckRelease
description: |-
Validates a release by dry-running checks on target databases.
Permissions required: bb.releases.check
@@ -3773,7 +3775,7 @@ paths:
post:
tags:
- bytebase.v1.ReleaseService
- summary: 'Creates a new release with SQL files. Permissions required: bb.releases.create'
+ summary: CreateRelease
description: |-
Creates a new release with SQL files.
Permissions required: bb.releases.create
@@ -3811,7 +3813,7 @@ paths:
post:
tags:
- bytebase.v1.ReleaseService
- summary: 'Deletes a release. Permissions required: bb.releases.delete'
+ summary: DeleteRelease
description: |-
Deletes a release.
Permissions required: bb.releases.delete
@@ -3849,7 +3851,7 @@ paths:
post:
tags:
- bytebase.v1.ReleaseService
- summary: 'Retrieves a release by name. Permissions required: bb.releases.get'
+ summary: GetRelease
description: |-
Retrieves a release by name.
Permissions required: bb.releases.get
@@ -3887,7 +3889,7 @@ paths:
post:
tags:
- bytebase.v1.ReleaseService
- summary: 'Lists all unique categories in a project. Permissions required: bb.releases.list'
+ summary: ListReleaseCategories
description: |-
Lists all unique categories in a project.
Permissions required: bb.releases.list
@@ -3925,7 +3927,7 @@ paths:
post:
tags:
- bytebase.v1.ReleaseService
- summary: 'Lists releases in a project. Permissions required: bb.releases.list'
+ summary: ListReleases
description: |-
Lists releases in a project.
Permissions required: bb.releases.list
@@ -3963,7 +3965,7 @@ paths:
post:
tags:
- bytebase.v1.ReleaseService
- summary: 'Restores a deleted release. Permissions required: bb.releases.undelete'
+ summary: UndeleteRelease
description: |-
Restores a deleted release.
Permissions required: bb.releases.undelete
@@ -4001,7 +4003,7 @@ paths:
post:
tags:
- bytebase.v1.ReleaseService
- summary: 'Updates an existing release. Permissions required: bb.releases.update When allow_missing=true, also requires: bb.releases.create'
+ summary: UpdateRelease
description: |-
Updates an existing release.
Permissions required: bb.releases.update
@@ -4040,7 +4042,7 @@ paths:
post:
tags:
- bytebase.v1.ReviewConfigService
- summary: 'Creates a new SQL review configuration. Permissions required: bb.reviewConfigs.create'
+ summary: CreateReviewConfig
description: |-
Creates a new SQL review configuration.
Permissions required: bb.reviewConfigs.create
@@ -4078,7 +4080,7 @@ paths:
post:
tags:
- bytebase.v1.ReviewConfigService
- summary: 'Deletes a SQL review configuration. Permissions required: bb.reviewConfigs.delete'
+ summary: DeleteReviewConfig
description: |-
Deletes a SQL review configuration.
Permissions required: bb.reviewConfigs.delete
@@ -4116,7 +4118,7 @@ paths:
post:
tags:
- bytebase.v1.ReviewConfigService
- summary: 'Retrieves a SQL review configuration by name. Permissions required: bb.reviewConfigs.get'
+ summary: GetReviewConfig
description: |-
Retrieves a SQL review configuration by name.
Permissions required: bb.reviewConfigs.get
@@ -4154,7 +4156,7 @@ paths:
post:
tags:
- bytebase.v1.ReviewConfigService
- summary: 'Lists all SQL review configurations. Permissions required: bb.reviewConfigs.list'
+ summary: ListReviewConfigs
description: |-
Lists all SQL review configurations.
Permissions required: bb.reviewConfigs.list
@@ -4192,7 +4194,7 @@ paths:
post:
tags:
- bytebase.v1.ReviewConfigService
- summary: 'Updates a SQL review configuration. Permissions required: bb.reviewConfigs.update When allow_missing=true, also requires: bb.reviewConfigs.create'
+ summary: UpdateReviewConfig
description: |-
Updates a SQL review configuration.
Permissions required: bb.reviewConfigs.update
@@ -4231,7 +4233,7 @@ paths:
post:
tags:
- bytebase.v1.RevisionService
- summary: 'Creates multiple schema revisions in a single operation. Permissions required: bb.revisions.create'
+ summary: BatchCreateRevisions
description: |-
Creates multiple schema revisions in a single operation.
Permissions required: bb.revisions.create
@@ -4269,7 +4271,7 @@ paths:
post:
tags:
- bytebase.v1.RevisionService
- summary: 'Deletes a schema revision. Permissions required: bb.revisions.delete'
+ summary: DeleteRevision
description: |-
Deletes a schema revision.
Permissions required: bb.revisions.delete
@@ -4307,7 +4309,7 @@ paths:
post:
tags:
- bytebase.v1.RevisionService
- summary: 'Retrieves a schema revision by name. Permissions required: bb.revisions.get'
+ summary: GetRevision
description: |-
Retrieves a schema revision by name.
Permissions required: bb.revisions.get
@@ -4345,7 +4347,7 @@ paths:
post:
tags:
- bytebase.v1.RevisionService
- summary: 'Lists schema revisions for a database. Permissions required: bb.revisions.list'
+ summary: ListRevisions
description: |-
Lists schema revisions for a database.
Permissions required: bb.revisions.list
@@ -4383,7 +4385,7 @@ paths:
post:
tags:
- bytebase.v1.RoleService
- summary: 'Creates a new custom role. Permissions required: bb.roles.create'
+ summary: CreateRole
description: |-
Creates a new custom role.
Permissions required: bb.roles.create
@@ -4421,7 +4423,7 @@ paths:
post:
tags:
- bytebase.v1.RoleService
- summary: 'Deletes a custom role. Permissions required: bb.roles.delete'
+ summary: DeleteRole
description: |-
Deletes a custom role.
Permissions required: bb.roles.delete
@@ -4459,7 +4461,7 @@ paths:
post:
tags:
- bytebase.v1.RoleService
- summary: 'Retrieves a role by name. Permissions required: bb.roles.get'
+ summary: GetRole
description: |-
Retrieves a role by name.
Permissions required: bb.roles.get
@@ -4497,7 +4499,7 @@ paths:
post:
tags:
- bytebase.v1.RoleService
- summary: 'Lists roles in the workspace. Permissions required: bb.roles.list'
+ summary: ListRoles
description: |-
Lists roles in the workspace.
Permissions required: bb.roles.list
@@ -4535,7 +4537,7 @@ paths:
post:
tags:
- bytebase.v1.RoleService
- summary: 'Updates a role''s properties. Permissions required: bb.roles.update When allow_missing=true, also requires: bb.roles.create'
+ summary: UpdateRole
description: |-
Updates a role's properties.
Permissions required: bb.roles.update
@@ -4574,7 +4576,7 @@ paths:
post:
tags:
- bytebase.v1.RolloutService
- summary: 'Cancels multiple running task executions. Permissions required: bb.taskRuns.create (or issue creator for data export issues, or user with rollout policy role for the environment)'
+ summary: BatchCancelTaskRuns
description: |-
Cancels multiple running task executions.
Permissions required: bb.taskRuns.create (or issue creator for data export issues, or user with rollout policy role for the environment)
@@ -4612,7 +4614,7 @@ paths:
post:
tags:
- bytebase.v1.RolloutService
- summary: 'Executes multiple tasks in a rollout stage. Permissions required: bb.taskRuns.create (or issue creator for data export issues, or user with rollout policy role for the environment)'
+ summary: BatchRunTasks
description: |-
Executes multiple tasks in a rollout stage.
Permissions required: bb.taskRuns.create (or issue creator for data export issues, or user with rollout policy role for the environment)
@@ -4650,7 +4652,7 @@ paths:
post:
tags:
- bytebase.v1.RolloutService
- summary: 'Skips multiple tasks in a rollout stage. Permissions required: bb.taskRuns.create (or issue creator for data export issues, or user with rollout policy role for the environment)'
+ summary: BatchSkipTasks
description: |-
Skips multiple tasks in a rollout stage.
Permissions required: bb.taskRuns.create (or issue creator for data export issues, or user with rollout policy role for the environment)
@@ -4688,7 +4690,7 @@ paths:
post:
tags:
- bytebase.v1.RolloutService
- summary: 'Creates a new rollout for a plan. Permissions required: bb.rollouts.create (or issue creator for data export issues)'
+ summary: CreateRollout
description: |-
Creates a new rollout for a plan.
Permissions required: bb.rollouts.create (or issue creator for data export issues)
@@ -4726,7 +4728,7 @@ paths:
post:
tags:
- bytebase.v1.RolloutService
- summary: 'Retrieves a rollout by its plan name. Permissions required: bb.rollouts.get'
+ summary: GetRollout
description: |-
Retrieves a rollout by its plan name.
Permissions required: bb.rollouts.get
@@ -4764,7 +4766,7 @@ paths:
post:
tags:
- bytebase.v1.RolloutService
- summary: 'Retrieves a task run by name. Permissions required: bb.taskRuns.list'
+ summary: GetTaskRun
description: |-
Retrieves a task run by name.
Permissions required: bb.taskRuns.list
@@ -4802,7 +4804,7 @@ paths:
post:
tags:
- bytebase.v1.RolloutService
- summary: 'Retrieves execution logs for a task run. Permissions required: bb.taskRuns.list'
+ summary: GetTaskRunLog
description: |-
Retrieves execution logs for a task run.
Permissions required: bb.taskRuns.list
@@ -4840,7 +4842,7 @@ paths:
post:
tags:
- bytebase.v1.RolloutService
- summary: 'Retrieves database session information for a running task. Permissions required: bb.taskRuns.list'
+ summary: GetTaskRunSession
description: |-
Retrieves database session information for a running task.
Permissions required: bb.taskRuns.list
@@ -4878,7 +4880,7 @@ paths:
post:
tags:
- bytebase.v1.RolloutService
- summary: 'Lists rollouts in a project. Permissions required: bb.rollouts.list'
+ summary: ListRollouts
description: |-
Lists rollouts in a project.
Permissions required: bb.rollouts.list
@@ -4916,7 +4918,7 @@ paths:
post:
tags:
- bytebase.v1.RolloutService
- summary: 'Lists task run executions for a task. Permissions required: bb.taskRuns.list'
+ summary: ListTaskRuns
description: |-
Lists task run executions for a task.
Permissions required: bb.taskRuns.list
@@ -4954,7 +4956,7 @@ paths:
post:
tags:
- bytebase.v1.RolloutService
- summary: 'Generates rollback SQL for a completed task run. Permissions required: bb.taskRuns.list'
+ summary: PreviewTaskRunRollback
description: |-
Generates rollback SQL for a completed task run.
Permissions required: bb.taskRuns.list
@@ -4992,7 +4994,7 @@ paths:
post:
tags:
- bytebase.v1.SQLService
- summary: 'Provides AI-powered SQL completion and generation. Permissions required: None (authenticated users only, requires AI to be enabled)'
+ summary: AICompletion
description: |-
Provides AI-powered SQL completion and generation.
Permissions required: None (authenticated users only, requires AI to be enabled)
@@ -5031,7 +5033,7 @@ paths:
post:
tags:
- bytebase.v1.SQLService
- summary: 'Computes schema differences between two database metadata. Permissions required: None'
+ summary: DiffMetadata
description: |-
Computes schema differences between two database metadata.
Permissions required: None
@@ -5069,7 +5071,7 @@ paths:
post:
tags:
- bytebase.v1.SQLService
- summary: 'Exports query results to a file format. Permissions required: bb.databases.get'
+ summary: Export
description: |-
Exports query results to a file format.
Permissions required: bb.databases.get
@@ -5107,7 +5109,7 @@ paths:
post:
tags:
- bytebase.v1.SQLService
- summary: 'Executes a read-only SQL query against a database. Permissions required: bb.databases.get'
+ summary: Query
description: |-
Executes a read-only SQL query against a database.
Permissions required: bb.databases.get
@@ -5145,7 +5147,7 @@ paths:
post:
tags:
- bytebase.v1.SQLService
- summary: 'SearchQueryHistories searches query histories for the caller. Permissions required: None (only returns caller''s own query histories)'
+ summary: SearchQueryHistories
description: |-
SearchQueryHistories searches query histories for the caller.
Permissions required: None (only returns caller's own query histories)
@@ -5183,7 +5185,7 @@ paths:
post:
tags:
- bytebase.v1.ServiceAccountService
- summary: 'Creates a new service account. For workspace-level: parent is workspaces/-, permission bb.serviceAccounts.create on workspace. For project-level: parent is projects/{project}, permission bb.serviceAccounts.create on project.'
+ summary: CreateServiceAccount
description: |-
Creates a new service account.
For workspace-level: parent is workspaces/-, permission bb.serviceAccounts.create on workspace.
@@ -5222,7 +5224,7 @@ paths:
post:
tags:
- bytebase.v1.ServiceAccountService
- summary: 'Deletes a service account. Permissions required: bb.serviceAccounts.delete'
+ summary: DeleteServiceAccount
description: |-
Deletes a service account.
Permissions required: bb.serviceAccounts.delete
@@ -5260,7 +5262,7 @@ paths:
post:
tags:
- bytebase.v1.ServiceAccountService
- summary: 'Gets a service account by name. Permissions required: bb.serviceAccounts.get'
+ summary: GetServiceAccount
description: |-
Gets a service account by name.
Permissions required: bb.serviceAccounts.get
@@ -5298,7 +5300,7 @@ paths:
post:
tags:
- bytebase.v1.ServiceAccountService
- summary: 'Lists service accounts. For workspace-level: parent is workspaces/-, permission bb.serviceAccounts.list on workspace. For project-level: parent is projects/{project}, permission bb.serviceAccounts.list on project.'
+ summary: ListServiceAccounts
description: |-
Lists service accounts.
For workspace-level: parent is workspaces/-, permission bb.serviceAccounts.list on workspace.
@@ -5337,7 +5339,7 @@ paths:
post:
tags:
- bytebase.v1.ServiceAccountService
- summary: 'Restores a deleted service account. Permissions required: bb.serviceAccounts.undelete'
+ summary: UndeleteServiceAccount
description: |-
Restores a deleted service account.
Permissions required: bb.serviceAccounts.undelete
@@ -5375,7 +5377,7 @@ paths:
post:
tags:
- bytebase.v1.ServiceAccountService
- summary: 'Updates a service account. Permissions required: bb.serviceAccounts.update'
+ summary: UpdateServiceAccount
description: |-
Updates a service account.
Permissions required: bb.serviceAccounts.update
@@ -5413,7 +5415,7 @@ paths:
post:
tags:
- bytebase.v1.SettingService
- summary: 'Retrieves a workspace setting by name. Permissions required: bb.settings.get'
+ summary: GetSetting
description: |-
Retrieves a workspace setting by name.
Permissions required: bb.settings.get
@@ -5451,7 +5453,7 @@ paths:
post:
tags:
- bytebase.v1.SettingService
- summary: 'Lists all workspace settings. Permissions required: bb.settings.list'
+ summary: ListSettings
description: |-
Lists all workspace settings.
Permissions required: bb.settings.list
@@ -5489,7 +5491,7 @@ paths:
post:
tags:
- bytebase.v1.SettingService
- summary: 'Updates a workspace setting. Permissions required: bb.settings.set'
+ summary: UpdateSetting
description: |-
Updates a workspace setting.
Permissions required: bb.settings.set
@@ -5527,7 +5529,7 @@ paths:
post:
tags:
- bytebase.v1.SheetService
- summary: 'Creates multiple SQL sheets in a single operation. Permissions required: bb.sheets.create'
+ summary: BatchCreateSheets
description: |-
Creates multiple SQL sheets in a single operation.
Permissions required: bb.sheets.create
@@ -5565,7 +5567,7 @@ paths:
post:
tags:
- bytebase.v1.SheetService
- summary: 'Creates a new SQL sheet. Permissions required: bb.sheets.create'
+ summary: CreateSheet
description: |-
Creates a new SQL sheet.
Permissions required: bb.sheets.create
@@ -5603,7 +5605,7 @@ paths:
post:
tags:
- bytebase.v1.SheetService
- summary: 'Retrieves a SQL sheet by name. Permissions required: bb.sheets.get'
+ summary: GetSheet
description: |-
Retrieves a SQL sheet by name.
Permissions required: bb.sheets.get
@@ -5641,7 +5643,7 @@ paths:
post:
tags:
- bytebase.v1.SubscriptionService
- summary: 'GetSubscription returns the current subscription. If there is no license, we will return a free plan subscription without expiration time. If there is expired license, we will return a free plan subscription with the expiration time of the expired license. Permissions required: None'
+ summary: GetSubscription
description: |-
GetSubscription returns the current subscription.
If there is no license, we will return a free plan subscription without expiration time.
@@ -5681,7 +5683,7 @@ paths:
post:
tags:
- bytebase.v1.SubscriptionService
- summary: 'Updates the enterprise license subscription. Permissions required: bb.settings.set'
+ summary: UpdateSubscription
description: |-
Updates the enterprise license subscription.
Permissions required: bb.settings.set
@@ -5719,7 +5721,7 @@ paths:
post:
tags:
- bytebase.v1.UserService
- summary: 'Get the users in batch. Any authenticated user can batch get users. Permissions required: bb.users.get'
+ summary: BatchGetUsers
description: |-
Get the users in batch.
Any authenticated user can batch get users.
@@ -5758,7 +5760,7 @@ paths:
post:
tags:
- bytebase.v1.UserService
- summary: 'Creates a user. When Disallow Signup is enabled, requires bb.users.create permission; otherwise any user can sign up. Permissions required: bb.users.create (only when Disallow Signup is enabled)'
+ summary: CreateUser
description: |-
Creates a user. When Disallow Signup is enabled, requires bb.users.create permission; otherwise any user can sign up.
Permissions required: bb.users.create (only when Disallow Signup is enabled)
@@ -5796,7 +5798,7 @@ paths:
post:
tags:
- bytebase.v1.UserService
- summary: 'Deletes a user. Requires bb.users.delete permission with additional validation: the last remaining workspace admin cannot be deleted. Permissions required: bb.users.delete'
+ summary: DeleteUser
description: |-
Deletes a user. Requires bb.users.delete permission with additional validation: the last remaining workspace admin cannot be deleted.
Permissions required: bb.users.delete
@@ -5834,7 +5836,7 @@ paths:
post:
tags:
- bytebase.v1.UserService
- summary: 'Get the current authenticated user. Permissions required: None'
+ summary: GetCurrentUser
description: |-
Get the current authenticated user.
Permissions required: None
@@ -5872,7 +5874,7 @@ paths:
post:
tags:
- bytebase.v1.UserService
- summary: 'Get the user. Any authenticated user can get the user. Permissions required: bb.users.get'
+ summary: GetUser
description: |-
Get the user.
Any authenticated user can get the user.
@@ -5911,7 +5913,7 @@ paths:
post:
tags:
- bytebase.v1.UserService
- summary: 'List all users. Any authenticated user can list users. Permissions required: bb.users.list'
+ summary: ListUsers
description: |-
List all users.
Any authenticated user can list users.
@@ -5950,7 +5952,7 @@ paths:
post:
tags:
- bytebase.v1.UserService
- summary: 'Restores a deleted user. Permissions required: bb.users.undelete'
+ summary: UndeleteUser
description: |-
Restores a deleted user.
Permissions required: bb.users.undelete
@@ -5988,7 +5990,7 @@ paths:
post:
tags:
- bytebase.v1.UserService
- summary: 'Updates a user''s email address. Permissions required: bb.users.updateEmail'
+ summary: UpdateEmail
description: |-
Updates a user's email address.
Permissions required: bb.users.updateEmail
@@ -6026,7 +6028,7 @@ paths:
post:
tags:
- bytebase.v1.UserService
- summary: 'Updates a user. Users can update their own profile, or users with bb.users.update permission can update any user. Note: Email updates are not supported through this API. Use UpdateEmail instead. Permissions required: bb.users.update (or self)'
+ summary: UpdateUser
description: |-
Updates a user. Users can update their own profile, or users with bb.users.update permission can update any user.
Note: Email updates are not supported through this API. Use UpdateEmail instead.
@@ -6065,7 +6067,7 @@ paths:
post:
tags:
- bytebase.v1.WorkloadIdentityService
- summary: 'Creates a new workload identity. For workspace-level: parent is workspaces/-, permission bb.workloadIdentities.create on workspace. For project-level: parent is projects/{project}, permission bb.workloadIdentities.create on project.'
+ summary: CreateWorkloadIdentity
description: |-
Creates a new workload identity.
For workspace-level: parent is workspaces/-, permission bb.workloadIdentities.create on workspace.
@@ -6104,7 +6106,7 @@ paths:
post:
tags:
- bytebase.v1.WorkloadIdentityService
- summary: 'Deletes a workload identity. Permissions required: bb.workloadIdentities.delete'
+ summary: DeleteWorkloadIdentity
description: |-
Deletes a workload identity.
Permissions required: bb.workloadIdentities.delete
@@ -6142,7 +6144,7 @@ paths:
post:
tags:
- bytebase.v1.WorkloadIdentityService
- summary: 'Gets a workload identity by name. Permissions required: bb.workloadIdentities.get'
+ summary: GetWorkloadIdentity
description: |-
Gets a workload identity by name.
Permissions required: bb.workloadIdentities.get
@@ -6180,7 +6182,7 @@ paths:
post:
tags:
- bytebase.v1.WorkloadIdentityService
- summary: 'Lists workload identities. For workspace-level: parent is workspaces/-, permission bb.workloadIdentities.list on workspace. For project-level: parent is projects/{project}, permission bb.workloadIdentities.list on project.'
+ summary: ListWorkloadIdentities
description: |-
Lists workload identities.
For workspace-level: parent is workspaces/-, permission bb.workloadIdentities.list on workspace.
@@ -6219,7 +6221,7 @@ paths:
post:
tags:
- bytebase.v1.WorkloadIdentityService
- summary: 'Restores a deleted workload identity. Permissions required: bb.workloadIdentities.undelete'
+ summary: UndeleteWorkloadIdentity
description: |-
Restores a deleted workload identity.
Permissions required: bb.workloadIdentities.undelete
@@ -6257,7 +6259,7 @@ paths:
post:
tags:
- bytebase.v1.WorkloadIdentityService
- summary: 'Updates a workload identity. Permissions required: bb.workloadIdentities.update'
+ summary: UpdateWorkloadIdentity
description: |-
Updates a workload identity.
Permissions required: bb.workloadIdentities.update
@@ -6295,7 +6297,7 @@ paths:
post:
tags:
- bytebase.v1.WorksheetService
- summary: 'Batch update the organizers of worksheets. The access is the same as UpdateWorksheet method. Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)'
+ summary: BatchUpdateWorksheetOrganizer
description: |-
Batch update the organizers of worksheets.
The access is the same as UpdateWorksheet method.
@@ -6334,7 +6336,7 @@ paths:
post:
tags:
- bytebase.v1.WorksheetService
- summary: 'Creates a personal worksheet used in SQL Editor. Any authenticated user can create their own worksheets. Permissions required: None (authenticated users only)'
+ summary: CreateWorksheet
description: |-
Creates a personal worksheet used in SQL Editor. Any authenticated user can create their own worksheets.
Permissions required: None (authenticated users only)
@@ -6372,7 +6374,7 @@ paths:
post:
tags:
- bytebase.v1.WorksheetService
- summary: 'Delete a worksheet. The access is the same as UpdateWorksheet method. Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE worksheets)'
+ summary: DeleteWorksheet
description: |-
Delete a worksheet.
The access is the same as UpdateWorksheet method.
@@ -6411,7 +6413,7 @@ paths:
post:
tags:
- bytebase.v1.WorksheetService
- summary: 'Get a worksheet by name. The users can access this method if, - they are the creator of the worksheet; - they have bb.worksheets.get permission on the workspace; - the sheet is shared with them with PROJECT_READ and PROJECT_WRITE visibility, and they have bb.projects.get permission on the project. Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)'
+ summary: GetWorksheet
description: |-
Get a worksheet by name.
The users can access this method if,
@@ -6453,7 +6455,7 @@ paths:
post:
tags:
- bytebase.v1.WorksheetService
- summary: 'Search for worksheets. This is used for finding my worksheets or worksheets shared by other people. The sheet accessibility is the same as GetWorksheet(). Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)'
+ summary: SearchWorksheets
description: |-
Search for worksheets.
This is used for finding my worksheets or worksheets shared by other people.
@@ -6493,7 +6495,7 @@ paths:
post:
tags:
- bytebase.v1.WorksheetService
- summary: 'Update a worksheet. The users can access this method if, - they are the creator of the worksheet; - they have bb.worksheets.manage permission on the workspace; - the sheet is shared with them with PROJECT_WRITE visibility, and they have bb.projects.get permission on the project. Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE worksheets)'
+ summary: UpdateWorksheet
description: |-
Update a worksheet.
The users can access this method if,
@@ -6535,7 +6537,7 @@ paths:
post:
tags:
- bytebase.v1.WorksheetService
- summary: 'Update the organizer of a worksheet. The access is the same as UpdateWorksheet method. Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)'
+ summary: UpdateWorksheetOrganizer
description: |-
Update the organizer of a worksheet.
The access is the same as UpdateWorksheet method.
@@ -6574,7 +6576,7 @@ paths:
post:
tags:
- bytebase.v1.WorkspaceService
- summary: 'Retrieves IAM policy for the workspace. Permissions required: bb.workspaces.getIamPolicy'
+ summary: GetIamPolicy
description: |-
Retrieves IAM policy for the workspace.
Permissions required: bb.workspaces.getIamPolicy
@@ -6612,7 +6614,7 @@ paths:
post:
tags:
- bytebase.v1.WorkspaceService
- summary: 'Sets IAM policy for the workspace. Permissions required: bb.workspaces.setIamPolicy'
+ summary: SetIamPolicy
description: |-
Sets IAM policy for the workspace.
Permissions required: bb.workspaces.setIamPolicy
@@ -7696,9 +7698,11 @@ components:
The tasks to run.
Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}
runTime:
+ oneOf:
+ - $ref: '#/components/schemas/google.protobuf.Timestamp'
+ - type: "null"
title: run_time
description: The task run should run after run_time.
- $ref: '#/components/schemas/google.protobuf.Timestamp'
title: BatchRunTasksRequest
additionalProperties: false
bytebase.v1.BatchRunTasksResponse:
@@ -8170,9 +8174,11 @@ components:
title: classification
description: The data classification level for this column.
objectSchema:
+ oneOf:
+ - $ref: '#/components/schemas/bytebase.v1.ObjectSchema'
+ - type: "null"
title: object_schema
description: Object schema for complex column types like JSON.
- $ref: '#/components/schemas/bytebase.v1.ObjectSchema'
title: ColumnCatalog
additionalProperties: false
description: Column metadata within a table.
@@ -11341,11 +11347,15 @@ components:
- "null"
title: to_description
fromStatus:
+ oneOf:
+ - $ref: '#/components/schemas/bytebase.v1.IssueStatus'
+ - type: "null"
title: from_status
- $ref: '#/components/schemas/bytebase.v1.IssueStatus'
toStatus:
+ oneOf:
+ - $ref: '#/components/schemas/bytebase.v1.IssueStatus'
+ - type: "null"
title: to_status
- $ref: '#/components/schemas/bytebase.v1.IssueStatus'
fromLabels:
type: array
items:
@@ -11783,9 +11793,11 @@ components:
The name of the instance.
Format: instances/{instance}
instance:
+ oneOf:
+ - $ref: '#/components/schemas/bytebase.v1.Instance'
+ - type: "null"
title: instance
description: The target instance. We need to set this field if the target instance is not created yet.
- $ref: '#/components/schemas/bytebase.v1.Instance'
title: ListInstanceDatabaseRequest
additionalProperties: false
bytebase.v1.ListInstanceDatabaseResponse:
@@ -12139,9 +12151,11 @@ components:
The parent, which owns this collection of policies.
Format: {resource type}/{resource id}
policyType:
+ oneOf:
+ - $ref: '#/components/schemas/bytebase.v1.PolicyType'
+ - type: "null"
title: policy_type
description: Filter by specific policy type.
- $ref: '#/components/schemas/bytebase.v1.PolicyType'
showDeleted:
type: boolean
title: show_deleted
@@ -16495,17 +16509,21 @@ components:
Format: instances/{instance} if the task is DatabaseCreate.
Format: instances/{instance}/databases/{database}
updateTime:
+ oneOf:
+ - $ref: '#/components/schemas/google.protobuf.Timestamp'
+ - type: "null"
title: update_time
description: |-
The update_time is the update time of latest task run.
If there are no task runs, it will be empty.
- $ref: '#/components/schemas/google.protobuf.Timestamp'
runTime:
+ oneOf:
+ - $ref: '#/components/schemas/google.protobuf.Timestamp'
+ - type: "null"
title: run_time
description: |-
The run_time is the scheduled run time of latest task run.
If there are no task runs or the task run is not scheduled, it will be empty.
- $ref: '#/components/schemas/google.protobuf.Timestamp'
- oneOf:
- properties:
databaseCreate:
@@ -16698,11 +16716,13 @@ components:
description: Scheduling information about the task run.
$ref: '#/components/schemas/bytebase.v1.TaskRun.SchedulerInfo'
runTime:
+ oneOf:
+ - $ref: '#/components/schemas/google.protobuf.Timestamp'
+ - type: "null"
title: run_time
description: |-
The task run should run after run_time.
This can only be set when creating the task run calling BatchRunTasks.
- $ref: '#/components/schemas/google.protobuf.Timestamp'
title: TaskRun
additionalProperties: false
bytebase.v1.TaskRun.ExportArchiveStatus:
@@ -17182,13 +17202,17 @@ components:
description: When the backend process started.
$ref: '#/components/schemas/google.protobuf.Timestamp'
xactStart:
+ oneOf:
+ - $ref: '#/components/schemas/google.protobuf.Timestamp'
+ - type: "null"
title: xact_start
description: When the current transaction started.
- $ref: '#/components/schemas/google.protobuf.Timestamp'
queryStart:
+ oneOf:
+ - $ref: '#/components/schemas/google.protobuf.Timestamp'
+ - type: "null"
title: query_start
description: When the current query started.
- $ref: '#/components/schemas/google.protobuf.Timestamp'
title: Session
additionalProperties: false
description: PostgreSQL session information read from `pg_stat_activity`.
diff --git a/backend/api/v1/auth_service.go b/backend/api/v1/auth_service.go
index 23a7880895..872b8c6f34 100644
--- a/backend/api/v1/auth_service.go
+++ b/backend/api/v1/auth_service.go
@@ -570,13 +570,7 @@ func (s *AuthService) syncUserGroups(ctx context.Context, user *store.UserMessag
break
}
}
- var isBBGroupMember bool
- for _, member := range bbGroup.Payload.Members {
- if member.Member == common.FormatUserEmail(user.Email) {
- isBBGroupMember = true
- break
- }
- }
+ isBBGroupMember := getMemberInGroup(user, bbGroup) != nil
if isMember != isBBGroupMember {
if isMember {
// Add the user to the group.
diff --git a/backend/api/v1/group_service.go b/backend/api/v1/group_service.go
index 723f37e24d..5bbf191ea0 100644
--- a/backend/api/v1/group_service.go
+++ b/backend/api/v1/group_service.go
@@ -47,6 +47,10 @@ func (s *GroupService) GetGroup(ctx context.Context, req *connect.Request[v1pb.G
return nil, connect.NewError(connect.CodeNotFound, errors.Errorf("cannot found the group %v", req.Msg.Name))
}
+ if err := s.checkGroupPermission(ctx, req, group); err != nil {
+ return nil, err
+ }
+
result, err := s.convertToV1Group(group)
if err != nil {
return nil, err
@@ -257,16 +261,12 @@ func (s *GroupService) DeleteGroup(ctx context.Context, req *connect.Request[v1p
}
func (s *GroupService) checkPermission(ctx context.Context, group *store.GroupMessage, user *store.UserMessage, permission string) error {
- userName := common.FormatUserEmail(user.Email)
+ member := getMemberInGroup(user, group)
+ if member != nil && member.Role == storepb.GroupMember_OWNER {
+ return nil
+ }
- ok, err := func() (bool, error) {
- for _, member := range group.Payload.GetMembers() {
- if member.Role == storepb.GroupMember_OWNER && member.Member == userName {
- return true, nil
- }
- }
- return s.iamManager.CheckPermission(ctx, permission, user)
- }()
+ ok, err := s.iamManager.CheckPermission(ctx, permission, user)
if err != nil {
return connect.NewError(connect.CodeInternal, errors.Wrap(err, "failed to check permission"))
}
@@ -360,3 +360,39 @@ func (*GroupService) convertToV1Group(groupMessage *store.GroupMessage) (*v1pb.G
return group, nil
}
+
+func (s *GroupService) checkGroupPermission(ctx context.Context, req connect.AnyRequest, group *store.GroupMessage) error {
+ user, ok := GetUserFromContext(ctx)
+ if !ok {
+ return connect.NewError(connect.CodeInternal, errors.Errorf("user not found"))
+ }
+
+ if getMemberInGroup(user, group) == nil {
+ ok, err := s.iamManager.CheckPermission(ctx, permission.GroupsGet, user)
+ if err != nil {
+ return connect.NewError(connect.CodeInternal, errors.Errorf("failed to check permission with error: %v", err.Error()))
+ }
+ if !ok {
+ err := connect.NewError(connect.CodePermissionDenied, errors.Errorf("user does not have permission %q", permission.GroupsGet))
+ if detail, detailErr := connect.NewErrorDetail(&v1pb.PermissionDeniedDetail{
+ Method: req.Spec().Procedure,
+ RequiredPermissions: []string{string(permission.GroupsGet)},
+ }); detailErr == nil {
+ err.AddDetail(detail)
+ }
+ return err
+ }
+ }
+
+ return nil
+}
+
+func getMemberInGroup(user *store.UserMessage, group *store.GroupMessage) *storepb.GroupMember {
+ userName := common.FormatUserEmail(user.Email)
+ for _, member := range group.Payload.Members {
+ if member.Member == userName {
+ return member
+ }
+ }
+ return nil
+}
diff --git a/backend/generated-go/v1/group_service.pb.go b/backend/generated-go/v1/group_service.pb.go
index 7a42ae8366..e30169954d 100644
--- a/backend/generated-go/v1/group_service.pb.go
+++ b/backend/generated-go/v1/group_service.pb.go
@@ -730,8 +730,8 @@ const file_v1_group_service_proto_rawDesc = "" +
"\x05email\x18\x06 \x01(\tR\x05email:'\xeaA$\n" +
"\x12bytebase.com/Group\x12\x0egroups/{group}2\xbb\x06\n" +
"\fGroupService\x12u\n" +
- "\bGetGroup\x12\x1c.bytebase.v1.GetGroupRequest\x1a\x12.bytebase.v1.Group\"7\xdaA\x04name\x8a\xea0\rbb.groups.get\x90\xea0\x01\x82\xd3\xe4\x93\x02\x15\x12\x13/v1/{name=groups/*}\x12\x8b\x01\n" +
- "\x0eBatchGetGroups\x12\".bytebase.v1.BatchGetGroupsRequest\x1a#.bytebase.v1.BatchGetGroupsResponse\"0\x8a\xea0\rbb.groups.get\x90\xea0\x01\x82\xd3\xe4\x93\x02\x15\x12\x13/v1/groups:batchGet\x12z\n" +
+ "\bGetGroup\x12\x1c.bytebase.v1.GetGroupRequest\x1a\x12.bytebase.v1.Group\"7\xdaA\x04name\x8a\xea0\rbb.groups.get\x90\xea0\x02\x82\xd3\xe4\x93\x02\x15\x12\x13/v1/{name=groups/*}\x12\x8b\x01\n" +
+ "\x0eBatchGetGroups\x12\".bytebase.v1.BatchGetGroupsRequest\x1a#.bytebase.v1.BatchGetGroupsResponse\"0\x8a\xea0\rbb.groups.get\x90\xea0\x02\x82\xd3\xe4\x93\x02\x15\x12\x13/v1/groups:batchGet\x12z\n" +
"\n" +
"ListGroups\x12\x1e.bytebase.v1.ListGroupsRequest\x1a\x1f.bytebase.v1.ListGroupsResponse\"+\xdaA\x00\x8a\xea0\x0ebb.groups.list\x90\xea0\x01\x82\xd3\xe4\x93\x02\f\x12\n" +
"/v1/groups\x12\x81\x01\n" +
diff --git a/backend/generated-go/v1/group_service_grpc.pb.go b/backend/generated-go/v1/group_service_grpc.pb.go
index edcfa9cf27..e77ad20167 100644
--- a/backend/generated-go/v1/group_service_grpc.pb.go
+++ b/backend/generated-go/v1/group_service_grpc.pb.go
@@ -35,10 +35,12 @@ const (
// GroupService manages user groups for organizing users and permissions.
type GroupServiceClient interface {
// Gets a group by name.
- // Permissions required: bb.groups.get
+ // Group members or users with bb.groups.get permission can get the group.
+ // Permissions required: bb.groups.get OR caller is the group member
GetGroup(ctx context.Context, in *GetGroupRequest, opts ...grpc.CallOption) (*Group, error)
// Gets multiple groups in a single request.
- // Permissions required: bb.groups.get
+ // Group members or users with bb.groups.get permission can get the group.
+ // Permissions required: bb.groups.get OR caller is the group member
BatchGetGroups(ctx context.Context, in *BatchGetGroupsRequest, opts ...grpc.CallOption) (*BatchGetGroupsResponse, error)
// Lists all groups in the workspace.
// Permissions required: bb.groups.list
@@ -130,10 +132,12 @@ func (c *groupServiceClient) DeleteGroup(ctx context.Context, in *DeleteGroupReq
// GroupService manages user groups for organizing users and permissions.
type GroupServiceServer interface {
// Gets a group by name.
- // Permissions required: bb.groups.get
+ // Group members or users with bb.groups.get permission can get the group.
+ // Permissions required: bb.groups.get OR caller is the group member
GetGroup(context.Context, *GetGroupRequest) (*Group, error)
// Gets multiple groups in a single request.
- // Permissions required: bb.groups.get
+ // Group members or users with bb.groups.get permission can get the group.
+ // Permissions required: bb.groups.get OR caller is the group member
BatchGetGroups(context.Context, *BatchGetGroupsRequest) (*BatchGetGroupsResponse, error)
// Lists all groups in the workspace.
// Permissions required: bb.groups.list
diff --git a/backend/generated-go/v1/v1connect/group_service.connect.go b/backend/generated-go/v1/v1connect/group_service.connect.go
index f43a8e7d1d..7fa654576c 100644
--- a/backend/generated-go/v1/v1connect/group_service.connect.go
+++ b/backend/generated-go/v1/v1connect/group_service.connect.go
@@ -55,10 +55,12 @@ const (
// GroupServiceClient is a client for the bytebase.v1.GroupService service.
type GroupServiceClient interface {
// Gets a group by name.
- // Permissions required: bb.groups.get
+ // Group members or users with bb.groups.get permission can get the group.
+ // Permissions required: bb.groups.get OR caller is the group member
GetGroup(context.Context, *connect.Request[v1.GetGroupRequest]) (*connect.Response[v1.Group], error)
// Gets multiple groups in a single request.
- // Permissions required: bb.groups.get
+ // Group members or users with bb.groups.get permission can get the group.
+ // Permissions required: bb.groups.get OR caller is the group member
BatchGetGroups(context.Context, *connect.Request[v1.BatchGetGroupsRequest]) (*connect.Response[v1.BatchGetGroupsResponse], error)
// Lists all groups in the workspace.
// Permissions required: bb.groups.list
@@ -168,10 +170,12 @@ func (c *groupServiceClient) DeleteGroup(ctx context.Context, req *connect.Reque
// GroupServiceHandler is an implementation of the bytebase.v1.GroupService service.
type GroupServiceHandler interface {
// Gets a group by name.
- // Permissions required: bb.groups.get
+ // Group members or users with bb.groups.get permission can get the group.
+ // Permissions required: bb.groups.get OR caller is the group member
GetGroup(context.Context, *connect.Request[v1.GetGroupRequest]) (*connect.Response[v1.Group], error)
// Gets multiple groups in a single request.
- // Permissions required: bb.groups.get
+ // Group members or users with bb.groups.get permission can get the group.
+ // Permissions required: bb.groups.get OR caller is the group member
BatchGetGroups(context.Context, *connect.Request[v1.BatchGetGroupsRequest]) (*connect.Response[v1.BatchGetGroupsResponse], error)
// Lists all groups in the workspace.
// Permissions required: bb.groups.list
diff --git a/frontend/src/types/proto-es/v1/group_service_pb.d.ts b/frontend/src/types/proto-es/v1/group_service_pb.d.ts
index 76f955a70c..45af4b0551 100644
--- a/frontend/src/types/proto-es/v1/group_service_pb.d.ts
+++ b/frontend/src/types/proto-es/v1/group_service_pb.d.ts
@@ -370,7 +370,8 @@ export declare const GroupSchema: GenMessage<Group>;
export declare const GroupService: GenService<{
/**
* Gets a group by name.
- * Permissions required: bb.groups.get
+ * Group members or users with bb.groups.get permission can get the group.
+ * Permissions required: bb.groups.get OR caller is the group member
*
* @generated from rpc bytebase.v1.GroupService.GetGroup
*/
@@ -381,7 +382,8 @@ export declare const GroupService: GenService<{
},
/**
* Gets multiple groups in a single request.
- * Permissions required: bb.groups.get
+ * Group members or users with bb.groups.get permission can get the group.
+ * Permissions required: bb.groups.get OR caller is the group member
*
* @generated from rpc bytebase.v1.GroupService.BatchGetGroups
*/
diff --git a/frontend/src/types/proto-es/v1/group_service_pb.js b/frontend/src/types/proto-es/v1/group_service_pb.js
index fd46c91186..51954b0d1d 100644
--- a/frontend/src/types/proto-es/v1/group_service_pb.js
+++ b/frontend/src/types/proto-es/v1/group_service_pb.js
@@ -15,7 +15,7 @@ import { file_v1_annotation } from "./annotation_pb";
* Describes the file v1/group_service.proto.
*/
export const file_v1_group_service = /*@__PURE__*/
- fileDesc("ChZ2MS9ncm91cF9zZXJ2aWNlLnByb3RvEgtieXRlYmFzZS52MSI7Cg9HZXRHcm91cFJlcXVlc3QSKAoEbmFtZRgBIAEoCUIa4EEC+kEUChJieXRlYmFzZS5jb20vR3JvdXAiQgoVQmF0Y2hHZXRHcm91cHNSZXF1ZXN0EikKBW5hbWVzGAEgAygJQhrgQQL6QRQKEmJ5dGViYXNlLmNvbS9Hcm91cCI8ChZCYXRjaEdldEdyb3Vwc1Jlc3BvbnNlEiIKBmdyb3VwcxgBIAMoCzISLmJ5dGViYXNlLnYxLkdyb3VwIkoKEUxpc3RHcm91cHNSZXF1ZXN0EhEKCXBhZ2Vfc2l6ZRgBIAEoBRISCgpwYWdlX3Rva2VuGAIgASgJEg4KBmZpbHRlchgDIAEoCSJRChJMaXN0R3JvdXBzUmVzcG9uc2USIgoGZ3JvdXBzGAEgAygLMhIuYnl0ZWJhc2UudjEuR3JvdXASFwoPbmV4dF9wYWdlX3Rva2VuGAIgASgJIlYKEkNyZWF0ZUdyb3VwUmVxdWVzdBImCgVncm91cBgBIAEoCzISLmJ5dGViYXNlLnYxLkdyb3VwQgPgQQISGAoLZ3JvdXBfZW1haWwYAiABKAlCA+BBAiKEAQoSVXBkYXRlR3JvdXBSZXF1ZXN0EiYKBWdyb3VwGAEgASgLMhIuYnl0ZWJhc2UudjEuR3JvdXBCA+BBAhIvCgt1cGRhdGVfbWFzaxgCIAEoCzIaLmdvb2dsZS5wcm90b2J1Zi5GaWVsZE1hc2sSFQoNYWxsb3dfbWlzc2luZxgDIAEoCCI+ChJEZWxldGVHcm91cFJlcXVlc3QSKAoEbmFtZRgBIAEoCUIa4EEC+kEUChJieXRlYmFzZS5jb20vR3JvdXAifwoLR3JvdXBNZW1iZXISDgoGbWVtYmVyGAEgASgJEisKBHJvbGUYAiABKA4yHS5ieXRlYmFzZS52MS5Hcm91cE1lbWJlci5Sb2xlIjMKBFJvbGUSFAoQUk9MRV9VTlNQRUNJRklFRBAAEgkKBU9XTkVSEAESCgoGTUVNQkVSEAIixQEKBUdyb3VwEhEKBG5hbWUYASABKAlCA+BBAxIXCgV0aXRsZRgCIAEoCUIIukgFcgMYyAESHQoLZGVzY3JpcHRpb24YAyABKAlCCLpIBXIDGOgHEikKB21lbWJlcnMYBCADKAsyGC5ieXRlYmFzZS52MS5Hcm91cE1lbWJlchIOCgZzb3VyY2UYBSABKAkSDQoFZW1haWwYBiABKAk6J+pBJAoSYnl0ZWJhc2UuY29tL0dyb3VwEg5ncm91cHMve2dyb3VwfTK7BgoMR3JvdXBTZXJ2aWNlEnUKCEdldEdyb3VwEhwuYnl0ZWJhc2UudjEuR2V0R3JvdXBSZXF1ZXN0GhIuYnl0ZWJhc2UudjEuR3JvdXAiN9pBBG5hbWWK6jANYmIuZ3JvdXBzLmdldJDqMAGC0+STAhUSEy92MS97bmFtZT1ncm91cHMvKn0SiwEKDkJhdGNoR2V0R3JvdXBzEiIuYnl0ZWJhc2UudjEuQmF0Y2hHZXRHcm91cHNSZXF1ZXN0GiMuYnl0ZWJhc2UudjEuQmF0Y2hHZXRHcm91cHNSZXNwb25zZSIwiuowDWJiLmdyb3Vwcy5nZXSQ6jABgtPkkwIVEhMvdjEvZ3JvdXBzOmJhdGNoR2V0EnoKCkxpc3RHcm91cHMSHi5ieXRlYmFzZS52MS5MaXN0R3JvdXBzUmVxdWVzdBofLmJ5dGViYXNlLnYxLkxpc3RHcm91cHNSZXNwb25zZSIr2kEAiuowDmJiLmdyb3Vwcy5saXN0kOowAYLT5JMCDBIKL3YxL2dyb3VwcxKBAQoLQ3JlYXRlR3JvdXASHy5ieXRlYmFzZS52MS5DcmVhdGVHcm91cFJlcXVlc3QaEi5ieXRlYmFzZS52MS5Hcm91cCI92kEFZ3JvdXCK6jAQYmIuZ3JvdXBzLmNyZWF0ZZDqMAGY6jABgtPkkwITOgVncm91cCIKL3YxL2dyb3VwcxKcAQoLVXBkYXRlR3JvdXASHy5ieXRlYmFzZS52MS5VcGRhdGVHcm91cFJlcXVlc3QaEi5ieXRlYmFzZS52MS5Hcm91cCJY2kERZ3JvdXAsdXBkYXRlX21hc2uK6jAQYmIuZ3JvdXBzLnVwZGF0ZZDqMAKY6jABgtPkkwIiOgVncm91cDIZL3YxL3tncm91cC5uYW1lPWdyb3Vwcy8qfRKGAQoLRGVsZXRlR3JvdXASHy5ieXRlYmFzZS52MS5EZWxldGVHcm91cFJlcXVlc3QaFi5nb29nbGUucHJvdG9idWYuRW1wdHkiPtpBBG5hbWWK6jAQYmIuZ3JvdXBzLmRlbGV0ZZDqMAKY6jABgtPkkwIVKhMvdjEve25hbWU9Z3JvdXBzLyp9QqcBCg9jb20uYnl0ZWJhc2UudjFCEUdyb3VwU2VydmljZVByb3RvUAFaNGdpdGh1Yi5jb20vYnl0ZWJhc2UvYnl0ZWJhc2UvYmFja2VuZC9nZW5lcmF0ZWQtZ28vdjGiAgNCWFiqAgtCeXRlYmFzZS5WMcoCC0J5dGViYXNlXFYx4gIXQnl0ZWJhc2VcVjFcR1BCTWV0YWRhdGHqAgxCeXRlYmFzZTo6VjFiBnByb3RvMw", [file_buf_validate_validate, file_google_api_annotations, file_google_api_client, file_google_api_field_behavior, file_google_api_resource, file_google_protobuf_empty, file_google_protobuf_field_mask, file_v1_annotation]);
+ fileDesc("ChZ2MS9ncm91cF9zZXJ2aWNlLnByb3RvEgtieXRlYmFzZS52MSI7Cg9HZXRHcm91cFJlcXVlc3QSKAoEbmFtZRgBIAEoCUIa4EEC+kEUChJieXRlYmFzZS5jb20vR3JvdXAiQgoVQmF0Y2hHZXRHcm91cHNSZXF1ZXN0EikKBW5hbWVzGAEgAygJQhrgQQL6QRQKEmJ5dGViYXNlLmNvbS9Hcm91cCI8ChZCYXRjaEdldEdyb3Vwc1Jlc3BvbnNlEiIKBmdyb3VwcxgBIAMoCzISLmJ5dGViYXNlLnYxLkdyb3VwIkoKEUxpc3RHcm91cHNSZXF1ZXN0EhEKCXBhZ2Vfc2l6ZRgBIAEoBRISCgpwYWdlX3Rva2VuGAIgASgJEg4KBmZpbHRlchgDIAEoCSJRChJMaXN0R3JvdXBzUmVzcG9uc2USIgoGZ3JvdXBzGAEgAygLMhIuYnl0ZWJhc2UudjEuR3JvdXASFwoPbmV4dF9wYWdlX3Rva2VuGAIgASgJIlYKEkNyZWF0ZUdyb3VwUmVxdWVzdBImCgVncm91cBgBIAEoCzISLmJ5dGViYXNlLnYxLkdyb3VwQgPgQQISGAoLZ3JvdXBfZW1haWwYAiABKAlCA+BBAiKEAQoSVXBkYXRlR3JvdXBSZXF1ZXN0EiYKBWdyb3VwGAEgASgLMhIuYnl0ZWJhc2UudjEuR3JvdXBCA+BBAhIvCgt1cGRhdGVfbWFzaxgCIAEoCzIaLmdvb2dsZS5wcm90b2J1Zi5GaWVsZE1hc2sSFQoNYWxsb3dfbWlzc2luZxgDIAEoCCI+ChJEZWxldGVHcm91cFJlcXVlc3QSKAoEbmFtZRgBIAEoCUIa4EEC+kEUChJieXRlYmFzZS5jb20vR3JvdXAifwoLR3JvdXBNZW1iZXISDgoGbWVtYmVyGAEgASgJEisKBHJvbGUYAiABKA4yHS5ieXRlYmFzZS52MS5Hcm91cE1lbWJlci5Sb2xlIjMKBFJvbGUSFAoQUk9MRV9VTlNQRUNJRklFRBAAEgkKBU9XTkVSEAESCgoGTUVNQkVSEAIixQEKBUdyb3VwEhEKBG5hbWUYASABKAlCA+BBAxIXCgV0aXRsZRgCIAEoCUIIukgFcgMYyAESHQoLZGVzY3JpcHRpb24YAyABKAlCCLpIBXIDGOgHEikKB21lbWJlcnMYBCADKAsyGC5ieXRlYmFzZS52MS5Hcm91cE1lbWJlchIOCgZzb3VyY2UYBSABKAkSDQoFZW1haWwYBiABKAk6J+pBJAoSYnl0ZWJhc2UuY29tL0dyb3VwEg5ncm91cHMve2dyb3VwfTK7BgoMR3JvdXBTZXJ2aWNlEnUKCEdldEdyb3VwEhwuYnl0ZWJhc2UudjEuR2V0R3JvdXBSZXF1ZXN0GhIuYnl0ZWJhc2UudjEuR3JvdXAiN9pBBG5hbWWK6jANYmIuZ3JvdXBzLmdldJDqMAKC0+STAhUSEy92MS97bmFtZT1ncm91cHMvKn0SiwEKDkJhdGNoR2V0R3JvdXBzEiIuYnl0ZWJhc2UudjEuQmF0Y2hHZXRHcm91cHNSZXF1ZXN0GiMuYnl0ZWJhc2UudjEuQmF0Y2hHZXRHcm91cHNSZXNwb25zZSIwiuowDWJiLmdyb3Vwcy5nZXSQ6jACgtPkkwIVEhMvdjEvZ3JvdXBzOmJhdGNoR2V0EnoKCkxpc3RHcm91cHMSHi5ieXRlYmFzZS52MS5MaXN0R3JvdXBzUmVxdWVzdBofLmJ5dGViYXNlLnYxLkxpc3RHcm91cHNSZXNwb25zZSIr2kEAiuowDmJiLmdyb3Vwcy5saXN0kOowAYLT5JMCDBIKL3YxL2dyb3VwcxKBAQoLQ3JlYXRlR3JvdXASHy5ieXRlYmFzZS52MS5DcmVhdGVHcm91cFJlcXVlc3QaEi5ieXRlYmFzZS52MS5Hcm91cCI92kEFZ3JvdXCK6jAQYmIuZ3JvdXBzLmNyZWF0ZZDqMAGY6jABgtPkkwITOgVncm91cCIKL3YxL2dyb3VwcxKcAQoLVXBkYXRlR3JvdXASHy5ieXRlYmFzZS52MS5VcGRhdGVHcm91cFJlcXVlc3QaEi5ieXRlYmFzZS52MS5Hcm91cCJY2kERZ3JvdXAsdXBkYXRlX21hc2uK6jAQYmIuZ3JvdXBzLnVwZGF0ZZDqMAKY6jABgtPkkwIiOgVncm91cDIZL3YxL3tncm91cC5uYW1lPWdyb3Vwcy8qfRKGAQoLRGVsZXRlR3JvdXASHy5ieXRlYmFzZS52MS5EZWxldGVHcm91cFJlcXVlc3QaFi5nb29nbGUucHJvdG9idWYuRW1wdHkiPtpBBG5hbWWK6jAQYmIuZ3JvdXBzLmRlbGV0ZZDqMAKY6jABgtPkkwIVKhMvdjEve25hbWU9Z3JvdXBzLyp9QqcBCg9jb20uYnl0ZWJhc2UudjFCEUdyb3VwU2VydmljZVByb3RvUAFaNGdpdGh1Yi5jb20vYnl0ZWJhc2UvYnl0ZWJhc2UvYmFja2VuZC9nZW5lcmF0ZWQtZ28vdjGiAgNCWFiqAgtCeXRlYmFzZS5WMcoCC0J5dGViYXNlXFYx4gIXQnl0ZWJhc2VcVjFcR1BCTWV0YWRhdGHqAgxCeXRlYmFzZTo6VjFiBnByb3RvMw", [file_buf_validate_validate, file_google_api_annotations, file_google_api_client, file_google_api_field_behavior, file_google_api_resource, file_google_protobuf_empty, file_google_protobuf_field_mask, file_v1_annotation]);
/**
* Describes the message bytebase.v1.GetGroupRequest.
diff --git a/proto/gen/grpc-doc/openapi.yaml b/proto/gen/grpc-doc/openapi.yaml
index e8007fa121..0571a5f03b 100644
--- a/proto/gen/grpc-doc/openapi.yaml
+++ b/proto/gen/grpc-doc/openapi.yaml
@@ -262,9 +262,11 @@ paths:
in: query
description: Filter by specific policy type.
schema:
+ oneOf:
+ - $ref: '#/components/schemas/bytebase.v1.PolicyType'
+ - type: "null"
title: policy_type
description: Filter by specific policy type.
- $ref: '#/components/schemas/bytebase.v1.PolicyType'
- name: showDeleted
in: query
description: Show deleted policies if specified.
@@ -394,15 +396,211 @@ paths:
required: true
schema:
type: string
- - name: updateMask.paths
+ - name: updateMask
in: query
- description: The set of field mask paths.
+ description: The list of fields to update.
schema:
- type: array
- items:
- type: string
- title: paths
- description: The set of field mask paths.
+ type: string
+ description: |-
+ `FieldMask` represents a set of symbolic field paths, for example:
+
+ paths: "f.a"
+ paths: "f.b.d"
+
+ Here `f` represents a field in some root message, `a` and `b`
+ fields in the message found in `f`, and `d` a field found in the
+ message in `f.b`.
+
+ Field masks are used to specify a subset of fields that should be
+ returned by a get operation or modified by an update operation.
+ Field masks also have a custom JSON encoding (see below).
+
+ # Field Masks in Projections
+
+ When used in the context of a projection, a response message or
+ sub-message is filtered by the API to only contain those fields as
+ specified in the mask. For example, if the mask in the previous
+ example is applied to a response message as follows:
+
+ f {
+ a : 22
+ b {
+ d : 1
+ x : 2
+ }
+ y : 13
+ }
+ z: 8
+
+ The result will not contain specific values for fields x,y and z
+ (their value will be set to the default, and omitted in proto text
+ output):
+
+
+ f {
+ a : 22
+ b {
+ d : 1
+ }
+ }
+
+ A repeated field is not allowed except at the last position of a
+ paths string.
+
+ If a FieldMask object is not present in a get operation, the
+ operation applies to all fields (as if a FieldMask of all fields
+ had been specified).
+
+ Note that a field mask does not necessarily apply to the
+ top-level response message. In case of a REST get operation, the
+ field mask applies directly to the response, but in case of a REST
+ list operation, the mask instead applies to each individual message
+ in the returned resource list. In case of a REST custom method,
+ other definitions may be used. Where the mask applies will be
+ clearly documented together with its declaration in the API. In
+ any case, the effect on the returned resource/resources is required
+ behavior for APIs.
+
+ # Field Masks in Update Operations
+
+ A field mask in update operations specifies which fields of the
+ targeted resource are going to be updated. The API is required
+ to only change the values of the fields as specified in the mask
+ and leave the others untouched. If a resource is passed in to
+ describe the updated values, the API ignores the values of all
+ fields not covered by the mask.
+
+ If a repeated field is specified for an update operation, new values will
+ be appended to the existing repeated field in the target resource. Note that
+ a repeated field is only allowed in the last position of a `paths` string.
+
+ If a sub-message is specified in the last position of the field mask for an
+ update operation, then new value will be merged into the existing sub-message
+ in the target resource.
+
+ For example, given the target message:
+
+ f {
+ b {
+ d: 1
+ x: 2
+ }
+ c: [1]
+ }
+
+ And an update message:
+
+ f {
+ b {
+ d: 10
+ }
+ c: [2]
+ }
+
+ then if the field mask is:
+
+ paths: ["f.b", "f.c"]
+
+ then the result will be:
+
+ f {
+ b {
+ d: 10
+ x: 2
+ }
+ c: [1, 2]
+ }
+
+ An implementation may provide options to override this default behavior for
+ repeated and message fields.
+
+ In order to reset a field's value to the default, the field must
+ be in the mask and set to the default value in the provided resource.
+ Hence, in order to reset all fields of a resource, provide a default
+ instance of the resource and set all fields in the mask, or do
+ not provide a mask as described below.
+
+ If a field mask is not present on update, the operation applies to
+ all fields (as if a field mask of all fields has been specified).
+ Note that in the presence of schema evolution, this may mean that
+ fields the client does not know and has therefore not filled into
+ the request will be reset to their default. If this is unwanted
+ behavior, a specific service may require a client to always specify
+ a field mask, producing an error if not.
+
+ As with get operations, the location of the resource which
+ describes the updated values in the request message depends on the
+ operation kind. In any case, the effect of the field mask is
+ required to be honored by the API.
+
+ ## Considerations for HTTP REST
+
+ The HTTP kind of an update operation which uses a field mask must
+ be set to PATCH instead of PUT in order to satisfy HTTP semantics
+ (PUT must only be used for full updates).
+
+ # JSON Encoding of Field Masks
+
+ In JSON, a field mask is encoded as a single string where paths are
+ separated by a comma. Fields name in each path are converted
+ to/from lower-camel naming conventions.
+
+ As an example, consider the following message declarations:
+
+ message Profile {
+ User user = 1;
+ Photo photo = 2;
+ }
+ message User {
+ string display_name = 1;
+ string address = 2;
+ }
+
+ In proto a field mask for `Profile` may look as such:
+
+ mask {
+ paths: "user.display_name"
+ paths: "photo"
+ }
+
+ In JSON, the same mask is represented as below:
+
+ {
+ mask: "user.displayName,photo"
+ }
+
+ # Field Masks and Oneof Fields
+
+ Field masks treat fields in oneofs just as regular fields. Consider the
+ following message:
+
+ message SampleMessage {
+ oneof test_oneof {
+ string name = 4;
+ SubMessage sub_message = 9;
+ }
+ }
+
+ The field mask can be:
+
+ mask {
+ paths: "name"
+ }
+
+ Or:
+
+ mask {
+ paths: "sub_message"
+ }
+
+ Note that oneof type names ("test_oneof" in this case) cannot be used in
+ paths.
+
+ ## Field Mask Verification
+
+ The implementation of any API method which has a FieldMask type field in the
+ request should verify the included field paths, and return an
+ `INVALID_ARGUMENT` error if any path is unmappable.
- name: allowMissing
in: query
description: |-
@@ -577,7 +775,8 @@ paths:
summary: GetGroup
description: |-
Gets a group by name.
- Permissions required: bb.groups.get
+ Group members or users with bb.groups.get permission can get the group.
+ Permissions required: bb.groups.get OR caller is the group member
operationId: GroupService_GetGroup
parameters:
- name: group
@@ -631,15 +830,211 @@ paths:
required: true
schema:
type: string
- - name: updateMask.paths
+ - name: updateMask
in: query
- description: The set of field mask paths.
+ description: The list of fields to update.
schema:
- type: array
- items:
- type: string
- title: paths
- description: The set of field mask paths.
+ type: string
+ description: |-
+ `FieldMask` represents a set of symbolic field paths, for example:
+
+ paths: "f.a"
+ paths: "f.b.d"
+
+ Here `f` represents a field in some root message, `a` and `b`
+ fields in the message found in `f`, and `d` a field found in the
+ message in `f.b`.
+
+ Field masks are used to specify a subset of fields that should be
+ returned by a get operation or modified by an update operation.
+ Field masks also have a custom JSON encoding (see below).
+
+ # Field Masks in Projections
+
+ When used in the context of a projection, a response message or
+ sub-message is filtered by the API to only contain those fields as
+ specified in the mask. For example, if the mask in the previous
+ example is applied to a response message as follows:
+
+ f {
+ a : 22
+ b {
+ d : 1
+ x : 2
+ }
+ y : 13
+ }
+ z: 8
+
+ The result will not contain specific values for fields x,y and z
+ (their value will be set to the default, and omitted in proto text
+ output):
+
+
+ f {
+ a : 22
+ b {
+ d : 1
+ }
+ }
+
+ A repeated field is not allowed except at the last position of a
+ paths string.
+
+ If a FieldMask object is not present in a get operation, the
+ operation applies to all fields (as if a FieldMask of all fields
+ had been specified).
+
+ Note that a field mask does not necessarily apply to the
+ top-level response message. In case of a REST get operation, the
+ field mask applies directly to the response, but in case of a REST
+ list operation, the mask instead applies to each individual message
+ in the returned resource list. In case of a REST custom method,
+ other definitions may be used. Where the mask applies will be
+ clearly documented together with its declaration in the API. In
+ any case, the effect on the returned resource/resources is required
+ behavior for APIs.
+
+ # Field Masks in Update Operations
+
+ A field mask in update operations specifies which fields of the
+ targeted resource are going to be updated. The API is required
+ to only change the values of the fields as specified in the mask
+ and leave the others untouched. If a resource is passed in to
+ describe the updated values, the API ignores the values of all
+ fields not covered by the mask.
+
+ If a repeated field is specified for an update operation, new values will
+ be appended to the existing repeated field in the target resource. Note that
+ a repeated field is only allowed in the last position of a `paths` string.
+
+ If a sub-message is specified in the last position of the field mask for an
+ update operation, then new value will be merged into the existing sub-message
+ in the target resource.
+
+ For example, given the target message:
+
+ f {
+ b {
+ d: 1
+ x: 2
+ }
+ c: [1]
+ }
+
+ And an update message:
+
+ f {
+ b {
+ d: 10
+ }
+ c: [2]
+ }
+
+ then if the field mask is:
+
+ paths: ["f.b", "f.c"]
+
+ then the result will be:
+
+ f {
+ b {
+ d: 10
+ x: 2
+ }
+ c: [1, 2]
+ }
+
+ An implementation may provide options to override this default behavior for
+ repeated and message fields.
+
+ In order to reset a field's value to the default, the field must
+ be in the mask and set to the default value in the provided resource.
+ Hence, in order to reset all fields of a resource, provide a default
+ instance of the resource and set all fields in the mask, or do
+ not provide a mask as described below.
+
+ If a field mask is not present on update, the operation applies to
+ all fields (as if a field mask of all fields has been specified).
+ Note that in the presence of schema evolution, this may mean that
+ fields the client does not know and has therefore not filled into
+ the request will be reset to their default. If this is unwanted
+ behavior, a specific service may require a client to always specify
+ a field mask, producing an error if not.
+
+ As with get operations, the location of the resource which
+ describes the updated values in the request message depends on the
+ operation kind. In any case, the effect of the field mask is
+ required to be honored by the API.
+
+ ## Considerations for HTTP REST
+
+ The HTTP kind of an update operation which uses a field mask must
+ be set to PATCH instead of PUT in order to satisfy HTTP semantics
+ (PUT must only be used for full updates).
+
+ # JSON Encoding of Field Masks
+
+ In JSON, a field mask is encoded as a single string where paths are
+ separated by a comma. Fields name in each path are converted
+ to/from lower-camel naming conventions.
+
+ As an example, consider the following message declarations:
+
+ message Profile {
+ User user = 1;
+ Photo photo = 2;
+ }
+ message User {
+ string display_name = 1;
+ string address = 2;
+ }
+
+ In proto a field mask for `Profile` may look as such:
+
+ mask {
+ paths: "user.display_name"
+ paths: "photo"
+ }
+
+ In JSON, the same mask is represented as below:
+
+ {
+ mask: "user.displayName,photo"
+ }
+
+ # Field Masks and Oneof Fields
+
+ Field masks treat fields in oneofs just as regular fields. Consider the
+ following message:
+
+ message SampleMessage {
+ oneof test_oneof {
+ string name = 4;
+ SubMessage sub_message = 9;
+ }
+ }
+
+ The field mask can be:
+
+ mask {
+ paths: "name"
+ }
+
+ Or:
+
+ mask {
+ paths: "sub_message"
+ }
+
+ Note that oneof type names ("test_oneof" in this case) cannot be used in
+ paths.
+
+ ## Field Mask Verification
+
+ The implementation of any API method which has a FieldMask type field in the
+ request should verify the included field paths, and return an
+ `INVALID_ARGUMENT` error if any path is unmappable.
- name: allowMissing
in: query
description: |-
@@ -681,7 +1076,8 @@ paths:
summary: BatchGetGroups
description: |-
Gets multiple groups in a single request.
- Permissions required: bb.groups.get
+ Group members or users with bb.groups.get permission can get the group.
+ Permissions required: bb.groups.get OR caller is the group member
operationId: GroupService_BatchGetGroups
parameters:
- name: names
@@ -852,15 +1248,211 @@ paths:
required: true
schema:
type: string
- - name: updateMask.paths
+ - name: updateMask
in: query
- description: The set of field mask paths.
+ description: The list of fields to update.
schema:
- type: array
- items:
- type: string
- title: paths
- description: The set of field mask paths.
+ type: string
+ description: |-
+ `FieldMask` represents a set of symbolic field paths, for example:
+
+ paths: "f.a"
+ paths: "f.b.d"
+
+ Here `f` represents a field in some root message, `a` and `b`
+ fields in the message found in `f`, and `d` a field found in the
+ message in `f.b`.
+
+ Field masks are used to specify a subset of fields that should be
+ returned by a get operation or modified by an update operation.
+ Field masks also have a custom JSON encoding (see below).
+
+ # Field Masks in Projections
+
+ When used in the context of a projection, a response message or
+ sub-message is filtered by the API to only contain those fields as
+ specified in the mask. For example, if the mask in the previous
+ example is applied to a response message as follows:
+
+ f {
+ a : 22
+ b {
+ d : 1
+ x : 2
+ }
+ y : 13
+ }
+ z: 8
+
+ The result will not contain specific values for fields x,y and z
+ (their value will be set to the default, and omitted in proto text
+ output):
+
+
+ f {
+ a : 22
+ b {
+ d : 1
+ }
+ }
+
+ A repeated field is not allowed except at the last position of a
+ paths string.
+
+ If a FieldMask object is not present in a get operation, the
+ operation applies to all fields (as if a FieldMask of all fields
+ had been specified).
+
+ Note that a field mask does not necessarily apply to the
+ top-level response message. In case of a REST get operation, the
+ field mask applies directly to the response, but in case of a REST
+ list operation, the mask instead applies to each individual message
+ in the returned resource list. In case of a REST custom method,
+ other definitions may be used. Where the mask applies will be
+ clearly documented together with its declaration in the API. In
+ any case, the effect on the returned resource/resources is required
+ behavior for APIs.
+
+ # Field Masks in Update Operations
+
+ A field mask in update operations specifies which fields of the
+ targeted resource are going to be updated. The API is required
+ to only change the values of the fields as specified in the mask
+ and leave the others untouched. If a resource is passed in to
+ describe the updated values, the API ignores the values of all
+ fields not covered by the mask.
+
+ If a repeated field is specified for an update operation, new values will
+ be appended to the existing repeated field in the target resource. Note that
+ a repeated field is only allowed in the last position of a `paths` string.
+
+ If a sub-message is specified in the last position of the field mask for an
+ update operation, then new value will be merged into the existing sub-message
+ in the target resource.
+
+ For example, given the target message:
+
+ f {
+ b {
+ d: 1
+ x: 2
+ }
+ c: [1]
+ }
+
+ And an update message:
+
+ f {
+ b {
+ d: 10
+ }
+ c: [2]
+ }
+
+ then if the field mask is:
+
+ paths: ["f.b", "f.c"]
+
+ then the result will be:
+
+ f {
+ b {
+ d: 10
+ x: 2
+ }
+ c: [1, 2]
+ }
+
+ An implementation may provide options to override this default behavior for
+ repeated and message fields.
+
+ In order to reset a field's value to the default, the field must
+ be in the mask and set to the default value in the provided resource.
+ Hence, in order to reset all fields of a resource, provide a default
+ instance of the resource and set all fields in the mask, or do
+ not provide a mask as described below.
+
+ If a field mask is not present on update, the operation applies to
+ all fields (as if a field mask of all fields has been specified).
+ Note that in the presence of schema evolution, this may mean that
+ fields the client does not know and has therefore not filled into
+ the request will be reset to their default. If this is unwanted
+ behavior, a specific service may require a client to always specify
+ a field mask, producing an error if not.
+
+ As with get operations, the location of the resource which
+ describes the updated values in the request message depends on the
+ operation kind. In any case, the effect of the field mask is
+ required to be honored by the API.
+
+ ## Considerations for HTTP REST
+
+ The HTTP kind of an update operation which uses a field mask must
+ be set to PATCH instead of PUT in order to satisfy HTTP semantics
+ (PUT must only be used for full updates).
+
+ # JSON Encoding of Field Masks
+
+ In JSON, a field mask is encoded as a single string where paths are
+ separated by a comma. Fields name in each path are converted
+ to/from lower-camel naming conventions.
+
+ As an example, consider the following message declarations:
+
+ message Profile {
+ User user = 1;
+ Photo photo = 2;
+ }
+ message User {
+ string display_name = 1;
+ string address = 2;
+ }
+
+ In proto a field mask for `Profile` may look as such:
+
+ mask {
+ paths: "user.display_name"
+ paths: "photo"
+ }
+
+ In JSON, the same mask is represented as below:
+
+ {
+ mask: "user.displayName,photo"
+ }
+
+ # Field Masks and Oneof Fields
+
+ Field masks treat fields in oneofs just as regular fields. Consider the
+ following message:
+
+ message SampleMessage {
+ oneof test_oneof {
+ string name = 4;
+ SubMessage sub_message = 9;
+ }
+ }
+
+ The field mask can be:
+
+ mask {
+ paths: "name"
+ }
+
+ Or:
+
+ mask {
+ paths: "sub_message"
+ }
+
+ Note that oneof type names ("test_oneof" in this case) cannot be used in
+ paths.
+
+ ## Field Mask Verification
+
+ The implementation of any API method which has a FieldMask type field in the
+ request should verify the included field paths, and return an
+ `INVALID_ARGUMENT` error if any path is unmappable.
- name: allowMissing
in: query
description: |-
@@ -1178,15 +1770,211 @@ paths:
required: true
schema:
type: string
- - name: updateMask.paths
+ - name: updateMask
in: query
- description: The set of field mask paths.
+ description: The list of fields to update.
schema:
- type: array
- items:
- type: string
- title: paths
- description: The set of field mask paths.
+ type: string
+ description: |-
+ `FieldMask` represents a set of symbolic field paths, for example:
+
+ paths: "f.a"
+ paths: "f.b.d"
+
+ Here `f` represents a field in some root message, `a` and `b`
+ fields in the message found in `f`, and `d` a field found in the
+ message in `f.b`.
+
+ Field masks are used to specify a subset of fields that should be
+ returned by a get operation or modified by an update operation.
+ Field masks also have a custom JSON encoding (see below).
+
+ # Field Masks in Projections
+
+ When used in the context of a projection, a response message or
+ sub-message is filtered by the API to only contain those fields as
+ specified in the mask. For example, if the mask in the previous
+ example is applied to a response message as follows:
+
+ f {
+ a : 22
+ b {
+ d : 1
+ x : 2
+ }
+ y : 13
+ }
+ z: 8
+
+ The result will not contain specific values for fields x,y and z
+ (their value will be set to the default, and omitted in proto text
+ output):
+
+
+ f {
+ a : 22
+ b {
+ d : 1
+ }
+ }
+
+ A repeated field is not allowed except at the last position of a
+ paths string.
+
+ If a FieldMask object is not present in a get operation, the
+ operation applies to all fields (as if a FieldMask of all fields
+ had been specified).
+
+ Note that a field mask does not necessarily apply to the
+ top-level response message. In case of a REST get operation, the
+ field mask applies directly to the response, but in case of a REST
+ list operation, the mask instead applies to each individual message
+ in the returned resource list. In case of a REST custom method,
+ other definitions may be used. Where the mask applies will be
+ clearly documented together with its declaration in the API. In
+ any case, the effect on the returned resource/resources is required
+ behavior for APIs.
+
+ # Field Masks in Update Operations
+
+ A field mask in update operations specifies which fields of the
+ targeted resource are going to be updated. The API is required
+ to only change the values of the fields as specified in the mask
+ and leave the others untouched. If a resource is passed in to
+ describe the updated values, the API ignores the values of all
+ fields not covered by the mask.
+
+ If a repeated field is specified for an update operation, new values will
+ be appended to the existing repeated field in the target resource. Note that
+ a repeated field is only allowed in the last position of a `paths` string.
+
+ If a sub-message is specified in the last position of the field mask for an
+ update operation, then new value will be merged into the existing sub-message
+ in the target resource.
+
+ For example, given the target message:
+
+ f {
+ b {
+ d: 1
+ x: 2
+ }
+ c: [1]
+ }
+
+ And an update message:
+
+ f {
+ b {
+ d: 10
+ }
+ c: [2]
+ }
+
+ then if the field mask is:
+
+ paths: ["f.b", "f.c"]
+
+ then the result will be:
+
+ f {
+ b {
+ d: 10
+ x: 2
+ }
+ c: [1, 2]
+ }
+
+ An implementation may provide options to override this default behavior for
+ repeated and message fields.
+
+ In order to reset a field's value to the default, the field must
+ be in the mask and set to the default value in the provided resource.
+ Hence, in order to reset all fields of a resource, provide a default
+ instance of the resource and set all fields in the mask, or do
+ not provide a mask as described below.
+
+ If a field mask is not present on update, the operation applies to
+ all fields (as if a field mask of all fields has been specified).
+ Note that in the presence of schema evolution, this may mean that
+ fields the client does not know and has therefore not filled into
+ the request will be reset to their default. If this is unwanted
+ behavior, a specific service may require a client to always specify
+ a field mask, producing an error if not.
+
+ As with get operations, the location of the resource which
+ describes the updated values in the request message depends on the
+ operation kind. In any case, the effect of the field mask is
+ required to be honored by the API.
+
+ ## Considerations for HTTP REST
+
+ The HTTP kind of an update operation which uses a field mask must
+ be set to PATCH instead of PUT in order to satisfy HTTP semantics
+ (PUT must only be used for full updates).
+
+ # JSON Encoding of Field Masks
+
+ In JSON, a field mask is encoded as a single string where paths are
+ separated by a comma. Fields name in each path are converted
+ to/from lower-camel naming conventions.
+
+ As an example, consider the following message declarations:
+
+ message Profile {
+ User user = 1;
+ Photo photo = 2;
+ }
+ message User {
+ string display_name = 1;
+ string address = 2;
+ }
+
+ In proto a field mask for `Profile` may look as such:
+
+ mask {
+ paths: "user.display_name"
+ paths: "photo"
+ }
+
+ In JSON, the same mask is represented as below:
+
+ {
+ mask: "user.displayName,photo"
+ }
+
+ # Field Masks and Oneof Fields
+
+ Field masks treat fields in oneofs just as regular fields. Consider the
+ following message:
+
+ message SampleMessage {
+ oneof test_oneof {
+ string name = 4;
+ SubMessage sub_message = 9;
+ }
+ }
+
+ The field mask can be:
+
+ mask {
+ paths: "name"
+ }
+
+ Or:
+
+ mask {
+ paths: "sub_message"
+ }
+
+ Note that oneof type names ("test_oneof" in this case) cannot be used in
+ paths.
+
+ ## Field Mask Verification
+
+ The implementation of any API method which has a FieldMask type field in the
+ request should verify the included field paths, and return an
+ `INVALID_ARGUMENT` error if any path is unmappable.
- name: allowMissing
in: query
description: |-
@@ -1422,15 +2210,211 @@ paths:
required: true
schema:
type: string
- - name: updateMask.paths
+ - name: updateMask
in: query
- description: The set of field mask paths.
+ description: The list of fields to update.
schema:
- type: array
- items:
- type: string
- title: paths
- description: The set of field mask paths.
+ type: string
+ description: |-
+ `FieldMask` represents a set of symbolic field paths, for example:
+
+ paths: "f.a"
+ paths: "f.b.d"
+
+ Here `f` represents a field in some root message, `a` and `b`
+ fields in the message found in `f`, and `d` a field found in the
+ message in `f.b`.
+
+ Field masks are used to specify a subset of fields that should be
+ returned by a get operation or modified by an update operation.
+ Field masks also have a custom JSON encoding (see below).
+
+ # Field Masks in Projections
+
+ When used in the context of a projection, a response message or
+ sub-message is filtered by the API to only contain those fields as
+ specified in the mask. For example, if the mask in the previous
+ example is applied to a response message as follows:
+
+ f {
+ a : 22
+ b {
+ d : 1
+ x : 2
+ }
+ y : 13
+ }
+ z: 8
+
+ The result will not contain specific values for fields x,y and z
+ (their value will be set to the default, and omitted in proto text
+ output):
+
+
+ f {
+ a : 22
+ b {
+ d : 1
+ }
+ }
+
+ A repeated field is not allowed except at the last position of a
+ paths string.
+
+ If a FieldMask object is not present in a get operation, the
+ operation applies to all fields (as if a FieldMask of all fields
+ had been specified).
+
+ Note that a field mask does not necessarily apply to the
+ top-level response message. In case of a REST get operation, the
+ field mask applies directly to the response, but in case of a REST
+ list operation, the mask instead applies to each individual message
+ in the returned resource list. In case of a REST custom method,
+ other definitions may be used. Where the mask applies will be
+ clearly documented together with its declaration in the API. In
+ any case, the effect on the returned resource/resources is required
+ behavior for APIs.
+
+ # Field Masks in Update Operations
+
+ A field mask in update operations specifies which fields of the
+ targeted resource are going to be updated. The API is required
+ to only change the values of the fields as specified in the mask
+ and leave the others untouched. If a resource is passed in to
+ describe the updated values, the API ignores the values of all
+ fields not covered by the mask.
+
+ If a repeated field is specified for an update operation, new values will
+ be appended to the existing repeated field in the target resource. Note that
+ a repeated field is only allowed in the last position of a `paths` string.
+
+ If a sub-message is specified in the last position of the field mask for an
+ update operation, then new value will be merged into the existing sub-message
+ in the target resource.
+
+ For example, given the target message:
+
+ f {
+ b {
+ d: 1
+ x: 2
+ }
+ c: [1]
+ }
+
+ And an update message:
+
+ f {
+ b {
+ d: 10
+ }
+ c: [2]
+ }
+
+ then if the field mask is:
+
+ paths: ["f.b", "f.c"]
+
+ then the result will be:
+
+ f {
+ b {
+ d: 10
+ x: 2
+ }
+ c: [1, 2]
+ }
+
+ An implementation may provide options to override this default behavior for
+ repeated and message fields.
+
+ In order to reset a field's value to the default, the field must
+ be in the mask and set to the default value in the provided resource.
+ Hence, in order to reset all fields of a resource, provide a default
+ instance of the resource and set all fields in the mask, or do
+ not provide a mask as described below.
+
+ If a field mask is not present on update, the operation applies to
+ all fields (as if a field mask of all fields has been specified).
+ Note that in the presence of schema evolution, this may mean that
+ fields the client does not know and has therefore not filled into
+ the request will be reset to their default. If this is unwanted
+ behavior, a specific service may require a client to always specify
+ a field mask, producing an error if not.
+
+ As with get operations, the location of the resource which
+ describes the updated values in the request message depends on the
+ operation kind. In any case, the effect of the field mask is
+ required to be honored by the API.
+
+ ## Considerations for HTTP REST
+
+ The HTTP kind of an update operation which uses a field mask must
+ be set to PATCH instead of PUT in order to satisfy HTTP semantics
+ (PUT must only be used for full updates).
+
+ # JSON Encoding of Field Masks
+
+ In JSON, a field mask is encoded as a single string where paths are
+ separated by a comma. Fields name in each path are converted
+ to/from lower-camel naming conventions.
+
+ As an example, consider the following message declarations:
+
+ message Profile {
+ User user = 1;
+ Photo photo = 2;
+ }
+ message User {
+ string display_name = 1;
+ string address = 2;
+ }
+
+ In proto a field mask for `Profile` may look as such:
+
+ mask {
+ paths: "user.display_name"
+ paths: "photo"
+ }
+
+ In JSON, the same mask is represented as below:
+
+ {
+ mask: "user.displayName,photo"
+ }
+
+ # Field Masks and Oneof Fields
+
+ Field masks treat fields in oneofs just as regular fields. Consider the
+ following message:
+
+ message SampleMessage {
+ oneof test_oneof {
+ string name = 4;
+ SubMessage sub_message = 9;
+ }
+ }
+
+ The field mask can be:
+
+ mask {
+ paths: "name"
+ }
+
+ Or:
+
+ mask {
+ paths: "sub_message"
+ }
+
+ Note that oneof type names ("test_oneof" in this case) cannot be used in
+ paths.
+
+ ## Field Mask Verification
+
+ The implementation of any API method which has a FieldMask type field in the
+ request should verify the included field paths, and return an
+ `INVALID_ARGUMENT` error if any path is unmappable.
- name: allowMissing
in: query
description: |-
@@ -1824,9 +2808,11 @@ paths:
in: query
description: Filter by specific policy type.
schema:
+ oneOf:
+ - $ref: '#/components/schemas/bytebase.v1.PolicyType'
+ - type: "null"
title: policy_type
description: Filter by specific policy type.
- $ref: '#/components/schemas/bytebase.v1.PolicyType'
- name: showDeleted
in: query
description: Show deleted policies if specified.
@@ -1980,15 +2966,211 @@ paths:
required: true
schema:
type: string
- - name: updateMask.paths
+ - name: updateMask
in: query
- description: The set of field mask paths.
+ description: The list of fields to update.
schema:
- type: array
- items:
- type: string
- title: paths
- description: The set of field mask paths.
+ type: string
+ description: |-
+ `FieldMask` represents a set of symbolic field paths, for example:
+
+ paths: "f.a"
+ paths: "f.b.d"
+
+ Here `f` represents a field in some root message, `a` and `b`
+ fields in the message found in `f`, and `d` a field found in the
+ message in `f.b`.
+
+ Field masks are used to specify a subset of fields that should be
+ returned by a get operation or modified by an update operation.
+ Field masks also have a custom JSON encoding (see below).
+
+ # Field Masks in Projections
+
+ When used in the context of a projection, a response message or
+ sub-message is filtered by the API to only contain those fields as
+ specified in the mask. For example, if the mask in the previous
+ example is applied to a response message as follows:
+
+ f {
+ a : 22
+ b {
+ d : 1
+ x : 2
+ }
+ y : 13
+ }
+ z: 8
+
+ The result will not contain specific values for fields x,y and z
+ (their value will be set to the default, and omitted in proto text
+ output):
+
+
+ f {
+ a : 22
+ b {
+ d : 1
+ }
+ }
+
+ A repeated field is not allowed except at the last position of a
+ paths string.
+
+ If a FieldMask object is not present in a get operation, the
+ operation applies to all fields (as if a FieldMask of all fields
+ had been specified).
+
+ Note that a field mask does not necessarily apply to the
+ top-level response message. In case of a REST get operation, the
+ field mask applies directly to the response, but in case of a REST
+ list operation, the mask instead applies to each individual message
+ in the returned resource list. In case of a REST custom method,
+ other definitions may be used. Where the mask applies will be
+ clearly documented together with its declaration in the API. In
+ any case, the effect on the returned resource/resources is required
+ behavior for APIs.
+
+ # Field Masks in Update Operations
+
+ A field mask in update operations specifies which fields of the
+ targeted resource are going to be updated. The API is required
+ to only change the values of the fields as specified in the mask
+ and leave the others untouched. If a resource is passed in to
+ describe the updated values, the API ignores the values of all
+ fields not covered by the mask.
+
+ If a repeated field is specified for an update operation, new values will
+ be appended to the existing repeated field in the target resource. Note that
+ a repeated field is only allowed in the last position of a `paths` string.
+
+ If a sub-message is specified in the last position of the field mask for an
+ update operation, then new value will be merged into the existing sub-message
+ in the target resource.
+
+ For example, given the target message:
+
+ f {
+ b {
+ d: 1
+ x: 2
+ }
+ c: [1]
+ }
+
+ And an update message:
+
+ f {
+ b {
+ d: 10
+ }
+ c: [2]
+ }
+
+ then if the field mask is:
+
+ paths: ["f.b", "f.c"]
+
+ then the result will be:
+
+ f {
+ b {
+ d: 10
+ x: 2
+ }
+ c: [1, 2]
+ }
+
+ An implementation may provide options to override this default behavior for
+ repeated and message fields.
+
+ In order to reset a field's value to the default, the field must
+ be in the mask and set to the default value in the provided resource.
+ Hence, in order to reset all fields of a resource, provide a default
+ instance of the resource and set all fields in the mask, or do
+ not provide a mask as described below.
+
+ If a field mask is not present on update, the operation applies to
+ all fields (as if a field mask of all fields has been specified).
+ Note that in the presence of schema evolution, this may mean that
+ fields the client does not know and has therefore not filled into
+ the request will be reset to their default. If this is unwanted
+ behavior, a specific service may require a client to always specify
+ a field mask, producing an error if not.
+
+ As with get operations, the location of the resource which
+ describes the updated values in the request message depends on the
+ operation kind. In any case, the effect of the field mask is
+ required to be honored by the API.
+
+ ## Considerations for HTTP REST
+
+ The HTTP kind of an update operation which uses a field mask must
+ be set to PATCH instead of PUT in order to satisfy HTTP semantics
+ (PUT must only be used for full updates).
+
+ # JSON Encoding of Field Masks
+
+ In JSON, a field mask is encoded as a single string where paths are
+ separated by a comma. Fields name in each path are converted
+ to/from lower-camel naming conventions.
+
+ As an example, consider the following message declarations:
+
+ message Profile {
+ User user = 1;
+ Photo photo = 2;
+ }
+ message User {
+ string display_name = 1;
+ string address = 2;
+ }
+
+ In proto a field mask for `Profile` may look as such:
+
+ mask {
+ paths: "user.display_name"
+ paths: "photo"
+ }
+
+ In JSON, the same mask is represented as below:
+
+ {
+ mask: "user.displayName,photo"
+ }
+
+ # Field Masks and Oneof Fields
+
+ Field masks treat fields in oneofs just as regular fields. Consider the
+ following message:
+
+ message SampleMessage {
+ oneof test_oneof {
+ string name = 4;
+ SubMessage sub_message = 9;
+ }
+ }
+
+ The field mask can be:
+
+ mask {
+ paths: "name"
+ }
+
+ Or:
+
+ mask {
+ paths: "sub_message"
+ }
+
+ Note that oneof type names ("test_oneof" in this case) cannot be used in
+ paths.
+
+ ## Field Mask Verification
+
+ The implementation of any API method which has a FieldMask type field in the
+ request should verify the included field paths, and return an
+ `INVALID_ARGUMENT` error if any path is unmappable.
- name: allowMissing
in: query
description: |-
@@ -4208,9 +5390,11 @@ paths:
in: query
description: Filter by specific policy type.
schema:
+ oneOf:
+ - $ref: '#/components/schemas/bytebase.v1.PolicyType'
+ - type: "null"
title: policy_type
description: Filter by specific policy type.
- $ref: '#/components/schemas/bytebase.v1.PolicyType'
- name: showDeleted
in: query
description: Show deleted policies if specified.
@@ -4340,15 +5524,211 @@ paths:
required: true
schema:
type: string
- - name: updateMask.paths
+ - name: updateMask
in: query
- description: The set of field mask paths.
+ description: The list of fields to update.
schema:
- type: array
- items:
- type: string
- title: paths
- description: The set of field mask paths.
+ type: string
+ description: |-
+ `FieldMask` represents a set of symbolic field paths, for example:
+
+ paths: "f.a"
+ paths: "f.b.d"
+
+ Here `f` represents a field in some root message, `a` and `b`
+ fields in the message found in `f`, and `d` a field found in the
+ message in `f.b`.
+
+ Field masks are used to specify a subset of fields that should be
+ returned by a get operation or modified by an update operation.
+ Field masks also have a custom JSON encoding (see below).
+
+ # Field Masks in Projections
+
+ When used in the context of a projection, a response message or
+ sub-message is filtered by the API to only contain those fields as
+ specified in the mask. For example, if the mask in the previous
+ example is applied to a response message as follows:
+
+ f {
+ a : 22
+ b {
+ d : 1
+ x : 2
+ }
+ y : 13
+ }
+ z: 8
+
+ The result will not contain specific values for fields x,y and z
+ (their value will be set to the default, and omitted in proto text
+ output):
+
+
+ f {
+ a : 22
+ b {
+ d : 1
+ }
+ }
+
+ A repeated field is not allowed except at the last position of a
+ paths string.
+
+ If a FieldMask object is not present in a get operation, the
+ operation applies to all fields (as if a FieldMask of all fields
+ had been specified).
+
+ Note that a field mask does not necessarily apply to the
+ top-level response message. In case of a REST get operation, the
+ field mask applies directly to the response, but in case of a REST
+ list operation, the mask instead applies to each individual message
+ in the returned resource list. In case of a REST custom method,
+ other definitions may be used. Where the mask applies will be
+ clearly documented together with its declaration in the API. In
+ any case, the effect on the returned resource/resources is required
+ behavior for APIs.
+
+ # Field Masks in Update Operations
+
+ A field mask in update operations specifies which fields of the
+ targeted resource are going to be updated. The API is required
+ to only change the values of the fields as specified in the mask
+ and leave the others untouched. If a resource is passed in to
+ describe the updated values, the API ignores the values of all
+ fields not covered by the mask.
+
+ If a repeated field is specified for an update operation, new values will
+ be appended to the existing repeated field in the target resource. Note that
+ a repeated field is only allowed in the last position of a `paths` string.
+
+ If a sub-message is specified in the last position of the field mask for an
+ update operation, then new value will be merged into the existing sub-message
+ in the target resource.
+
+ For example, given the target message:
+
+ f {
+ b {
+ d: 1
+ x: 2
+ }
+ c: [1]
+ }
+
+ And an update message:
+
+ f {
+ b {
+ d: 10
+ }
+ c: [2]
+ }
+
+ then if the field mask is:
+
+ paths: ["f.b", "f.c"]
+
+ then the result will be:
+
+ f {
+ b {
+ d: 10
+ x: 2
+ }
+ c: [1, 2]
+ }
+
+ An implementation may provide options to override this default behavior for
+ repeated and message fields.
+
+ In order to reset a field's value to the default, the field must
+ be in the mask and set to the default value in the provided resource.
+ Hence, in order to reset all fields of a resource, provide a default
+ instance of the resource and set all fields in the mask, or do
+ not provide a mask as described below.
+
+ If a field mask is not present on update, the operation applies to
+ all fields (as if a field mask of all fields has been specified).
+ Note that in the presence of schema evolution, this may mean that
+ fields the client does not know and has therefore not filled into
+ the request will be reset to their default. If this is unwanted
+ behavior, a specific service may require a client to always specify
+ a field mask, producing an error if not.
+
+ As with get operations, the location of the resource which
+ describes the updated values in the request message depends on the
+ operation kind. In any case, the effect of the field mask is
+ required to be honored by the API.
+
+ ## Considerations for HTTP REST
+
+ The HTTP kind of an update operation which uses a field mask must
+ be set to PATCH instead of PUT in order to satisfy HTTP semantics
+ (PUT must only be used for full updates).
+
+ # JSON Encoding of Field Masks
+
+ In JSON, a field mask is encoded as a single string where paths are
+ separated by a comma. Fields name in each path are converted
+ to/from lower-camel naming conventions.
+
+ As an example, consider the following message declarations:
+
+ message Profile {
+ User user = 1;
+ Photo photo = 2;
+ }
+ message User {
+ string display_name = 1;
+ string address = 2;
+ }
+
+ In proto a field mask for `Profile` may look as such:
+
+ mask {
+ paths: "user.display_name"
+ paths: "photo"
+ }
+
+ In JSON, the same mask is represented as below:
+
+ {
+ mask: "user.displayName,photo"
+ }
+
+ # Field Masks and Oneof Fields
+
+ Field masks treat fields in oneofs just as regular fields. Consider the
+ following message:
+
+ message SampleMessage {
+ oneof test_oneof {
+ string name = 4;
+ SubMessage sub_message = 9;
+ }
+ }
+
+ The field mask can be:
+
+ mask {
+ paths: "name"
+ }
+
+ Or:
+
+ mask {
+ paths: "sub_message"
+ }
+
+ Note that oneof type names ("test_oneof" in this case) cannot be used in
+ paths.
+
+ ## Field Mask Verification
+
+ The implementation of any API method which has a FieldMask type field in the
+ request should verify the included field paths, and return an
+ `INVALID_ARGUMENT` error if any path is unmappable.
- name: allowMissing
in: query
description: |-
@@ -4525,9 +5905,11 @@ paths:
type: object
properties:
instance:
+ oneOf:
+ - $ref: '#/components/schemas/bytebase.v1.Instance'
+ - type: "null"
title: instance
description: The target instance. We need to set this field if the target instance is not created yet.
- $ref: '#/components/schemas/bytebase.v1.Instance'
title: ListInstanceDatabaseRequest
required:
- instance
@@ -4657,15 +6039,211 @@ paths:
required: true
schema:
type: string
- - name: updateMask.paths
+ - name: updateMask
in: query
- description: The set of field mask paths.
+ description: The list of fields to update.
schema:
- type: array
- items:
- type: string
- title: paths
- description: The set of field mask paths.
+ type: string
+ description: |-
+ `FieldMask` represents a set of symbolic field paths, for example:
+
+ paths: "f.a"
+ paths: "f.b.d"
+
+ Here `f` represents a field in some root message, `a` and `b`
+ fields in the message found in `f`, and `d` a field found in the
+ message in `f.b`.
+
+ Field masks are used to specify a subset of fields that should be
+ returned by a get operation or modified by an update operation.
+ Field masks also have a custom JSON encoding (see below).
+
+ # Field Masks in Projections
+
+ When used in the context of a projection, a response message or
+ sub-message is filtered by the API to only contain those fields as
+ specified in the mask. For example, if the mask in the previous
+ example is applied to a response message as follows:
+
+ f {
+ a : 22
+ b {
+ d : 1
+ x : 2
+ }
+ y : 13
+ }
+ z: 8
+
+ The result will not contain specific values for fields x,y and z
+ (their value will be set to the default, and omitted in proto text
+ output):
+
+
+ f {
+ a : 22
+ b {
+ d : 1
+ }
+ }
+
+ A repeated field is not allowed except at the last position of a
+ paths string.
+
+ If a FieldMask object is not present in a get operation, the
+ operation applies to all fields (as if a FieldMask of all fields
+ had been specified).
+
+ Note that a field mask does not necessarily apply to the
+ top-level response message. In case of a REST get operation, the
+ field mask applies directly to the response, but in case of a REST
+ list operation, the mask instead applies to each individual message
+ in the returned resource list. In case of a REST custom method,
+ other definitions may be used. Where the mask applies will be
+ clearly documented together with its declaration in the API. In
+ any case, the effect on the returned resource/resources is required
+ behavior for APIs.
+
+ # Field Masks in Update Operations
+
+ A field mask in update operations specifies which fields of the
+ targeted resource are going to be updated. The API is required
+ to only change the values of the fields as specified in the mask
+ and leave the others untouched. If a resource is passed in to
+ describe the updated values, the API ignores the values of all
+ fields not covered by the mask.
+
+ If a repeated field is specified for an update operation, new values will
+ be appended to the existing repeated field in the target resource. Note that
+ a repeated field is only allowed in the last position of a `paths` string.
+
+ If a sub-message is specified in the last position of the field mask for an
+ update operation, then new value will be merged into the existing sub-message
+ in the target resource.
+
+ For example, given the target message:
+
+ f {
+ b {
+ d: 1
+ x: 2
+ }
+ c: [1]
+ }
+
+ And an update message:
+
+ f {
+ b {
+ d: 10
+ }
+ c: [2]
+ }
+
+ then if the field mask is:
+
+ paths: ["f.b", "f.c"]
+
+ then the result will be:
+
+ f {
+ b {
+ d: 10
+ x: 2
+ }
+ c: [1, 2]
+ }
+
+ An implementation may provide options to override this default behavior for
+ repeated and message fields.
+
+ In order to reset a field's value to the default, the field must
+ be in the mask and set to the default value in the provided resource.
+ Hence, in order to reset all fields of a resource, provide a default
+ instance of the resource and set all fields in the mask, or do
+ not provide a mask as described below.
+
+ If a field mask is not present on update, the operation applies to
+ all fields (as if a field mask of all fields has been specified).
+ Note that in the presence of schema evolution, this may mean that
+ fields the client does not know and has therefore not filled into
+ the request will be reset to their default. If this is unwanted
+ behavior, a specific service may require a client to always specify
+ a field mask, producing an error if not.
+
+ As with get operations, the location of the resource which
+ describes the updated values in the request message depends on the
+ operation kind. In any case, the effect of the field mask is
+ required to be honored by the API.
+
+ ## Considerations for HTTP REST
+
+ The HTTP kind of an update operation which uses a field mask must
+ be set to PATCH instead of PUT in order to satisfy HTTP semantics
+ (PUT must only be used for full updates).
+
+ # JSON Encoding of Field Masks
+
+ In JSON, a field mask is encoded as a single string where paths are
+ separated by a comma. Fields name in each path are converted
+ to/from lower-camel naming conventions.
+
+ As an example, consider the following message declarations:
+
+ message Profile {
+ User user = 1;
+ Photo photo = 2;
+ }
+ message User {
+ string display_name = 1;
+ string address = 2;
+ }
+
+ In proto a field mask for `Profile` may look as such:
+
+ mask {
+ paths: "user.display_name"
+ paths: "photo"
+ }
+
+ In JSON, the same mask is represented as below:
+
+ {
+ mask: "user.displayName,photo"
+ }
+
+ # Field Masks and Oneof Fields
+
+ Field masks treat fields in oneofs just as regular fields. Consider the
+ following message:
+
+ message SampleMessage {
+ oneof test_oneof {
+ string name = 4;
+ SubMessage sub_message = 9;
+ }
+ }
+
+ The field mask can be:
+
+ mask {
+ paths: "name"
+ }
+
+ Or:
+
+ mask {
+ paths: "sub_message"
+ }
+
+ Note that oneof type names ("test_oneof" in this case) cannot be used in
+ paths.
+
+ ## Field Mask Verification
+
+ The implementation of any API method which has a FieldMask type field in the
+ request should verify the included field paths, and return an
+ `INVALID_ARGUMENT` error if any path is unmappable.
- name: validateOnly
in: query
description: Validate only also tests the data source connection.
@@ -4769,9 +6347,11 @@ paths:
in: query
description: Filter by specific policy type.
schema:
+ oneOf:
+ - $ref: '#/components/schemas/bytebase.v1.PolicyType'
+ - type: "null"
title: policy_type
description: Filter by specific policy type.
- $ref: '#/components/schemas/bytebase.v1.PolicyType'
- name: showDeleted
in: query
description: Show deleted policies if specified.
@@ -4895,15 +6475,211 @@ paths:
required: true
schema:
type: string
- - name: updateMask.paths
+ - name: updateMask
in: query
- description: The set of field mask paths.
+ description: The list of fields to update.
schema:
- type: array
- items:
- type: string
- title: paths
- description: The set of field mask paths.
+ type: string
+ description: |-
+ `FieldMask` represents a set of symbolic field paths, for example:
+
+ paths: "f.a"
+ paths: "f.b.d"
+
+ Here `f` represents a field in some root message, `a` and `b`
+ fields in the message found in `f`, and `d` a field found in the
+ message in `f.b`.
+
+ Field masks are used to specify a subset of fields that should be
+ returned by a get operation or modified by an update operation.
+ Field masks also have a custom JSON encoding (see below).
+
+ # Field Masks in Projections
+
+ When used in the context of a projection, a response message or
+ sub-message is filtered by the API to only contain those fields as
+ specified in the mask. For example, if the mask in the previous
+ example is applied to a response message as follows:
+
+ f {
+ a : 22
+ b {
+ d : 1
+ x : 2
+ }
+ y : 13
+ }
+ z: 8
+
+ The result will not contain specific values for fields x,y and z
+ (their value will be set to the default, and omitted in proto text
+ output):
+
+
+ f {
+ a : 22
+ b {
+ d : 1
+ }
+ }
+
+ A repeated field is not allowed except at the last position of a
+ paths string.
+
+ If a FieldMask object is not present in a get operation, the
+ operation applies to all fields (as if a FieldMask of all fields
+ had been specified).
+
+ Note that a field mask does not necessarily apply to the
+ top-level response message. In case of a REST get operation, the
+ field mask applies directly to the response, but in case of a REST
+ list operation, the mask instead applies to each individual message
+ in the returned resource list. In case of a REST custom method,
+ other definitions may be used. Where the mask applies will be
+ clearly documented together with its declaration in the API. In
+ any case, the effect on the returned resource/resources is required
+ behavior for APIs.
+
+ # Field Masks in Update Operations
+
+ A field mask in update operations specifies which fields of the
+ targeted resource are going to be updated. The API is required
+ to only change the values of the fields as specified in the mask
+ and leave the others untouched. If a resource is passed in to
+ describe the updated values, the API ignores the values of all
+ fields not covered by the mask.
+
+ If a repeated field is specified for an update operation, new values will
+ be appended to the existing repeated field in the target resource. Note that
+ a repeated field is only allowed in the last position of a `paths` string.
+
+ If a sub-message is specified in the last position of the field mask for an
+ update operation, then new value will be merged into the existing sub-message
+ in the target resource.
+
+ For example, given the target message:
+
+ f {
+ b {
+ d: 1
+ x: 2
+ }
+ c: [1]
+ }
+
+ And an update message:
+
+ f {
+ b {
+ d: 10
+ }
+ c: [2]
+ }
+
+ then if the field mask is:
+
+ paths: ["f.b", "f.c"]
+
+ then the result will be:
+
+ f {
+ b {
+ d: 10
+ x: 2
+ }
+ c: [1, 2]
+ }
+
+ An implementation may provide options to override this default behavior for
+ repeated and message fields.
+
+ In order to reset a field's value to the default, the field must
+ be in the mask and set to the default value in the provided resource.
+ Hence, in order to reset all fields of a resource, provide a default
+ instance of the resource and set all fields in the mask, or do
+ not provide a mask as described below.
+
+ If a field mask is not present on update, the operation applies to
+ all fields (as if a field mask of all fields has been specified).
+ Note that in the presence of schema evolution, this may mean that
+ fields the client does not know and has therefore not filled into
+ the request will be reset to their default. If this is unwanted
+ behavior, a specific service may require a client to always specify
+ a field mask, producing an error if not.
+
+ As with get operations, the location of the resource which
+ describes the updated values in the request message depends on the
+ operation kind. In any case, the effect of the field mask is
+ required to be honored by the API.
+
+ ## Considerations for HTTP REST
+
+ The HTTP kind of an update operation which uses a field mask must
+ be set to PATCH instead of PUT in order to satisfy HTTP semantics
+ (PUT must only be used for full updates).
+
+ # JSON Encoding of Field Masks
+
+ In JSON, a field mask is encoded as a single string where paths are
+ separated by a comma. Fields name in each path are converted
+ to/from lower-camel naming conventions.
+
+ As an example, consider the following message declarations:
+
+ message Profile {
+ User user = 1;
+ Photo photo = 2;
+ }
+ message User {
+ string display_name = 1;
+ string address = 2;
+ }
+
+ In proto a field mask for `Profile` may look as such:
+
+ mask {
+ paths: "user.display_name"
+ paths: "photo"
+ }
+
+ In JSON, the same mask is represented as below:
+
+ {
+ mask: "user.displayName,photo"
+ }
+
+ # Field Masks and Oneof Fields
+
+ Field masks treat fields in oneofs just as regular fields. Consider the
+ following message:
+
+ message SampleMessage {
+ oneof test_oneof {
+ string name = 4;
+ SubMessage sub_message = 9;
+ }
+ }
+
+ The field mask can be:
+
+ mask {
+ paths: "name"
+ }
+
+ Or:
+
+ mask {
+ paths: "sub_message"
+ }
+
+ Note that oneof type names ("test_oneof" in this case) cannot be used in
+ paths.
+
+ ## Field Mask Verification
+
+ The implementation of any API method which has a FieldMask type field in the
+ request should verify the included field paths, and return an
+ `INVALID_ARGUMENT` error if any path is unmappable.
- name: allowMissing
in: query
description: |-
@@ -5156,15 +6932,211 @@ paths:
required: true
schema:
type: string
- - name: updateMask.paths
+ - name: updateMask
in: query
- description: The set of field mask paths.
+ description: The list of fields to update.
schema:
- type: array
- items:
- type: string
- title: paths
- description: The set of field mask paths.
+ type: string
+ description: |-
+ `FieldMask` represents a set of symbolic field paths, for example:
+
+ paths: "f.a"
+ paths: "f.b.d"
+
+ Here `f` represents a field in some root message, `a` and `b`
+ fields in the message found in `f`, and `d` a field found in the
+ message in `f.b`.
+
+ Field masks are used to specify a subset of fields that should be
+ returned by a get operation or modified by an update operation.
+ Field masks also have a custom JSON encoding (see below).
+
+ # Field Masks in Projections
+
+ When used in the context of a projection, a response message or
+ sub-message is filtered by the API to only contain those fields as
+ specified in the mask. For example, if the mask in the previous
+ example is applied to a response message as follows:
+
+ f {
+ a : 22
+ b {
+ d : 1
+ x : 2
+ }
+ y : 13
+ }
+ z: 8
+
+ The result will not contain specific values for fields x,y and z
+ (their value will be set to the default, and omitted in proto text
+ output):
+
+
+ f {
+ a : 22
+ b {
+ d : 1
+ }
+ }
+
+ A repeated field is not allowed except at the last position of a
+ paths string.
+
+ If a FieldMask object is not present in a get operation, the
+ operation applies to all fields (as if a FieldMask of all fields
+ had been specified).
+
+ Note that a field mask does not necessarily apply to the
+ top-level response message. In case of a REST get operation, the
+ field mask applies directly to the response, but in case of a REST
+ list operation, the mask instead applies to each individual message
+ in the returned resource list. In case of a REST custom method,
+ other definitions may be used. Where the mask applies will be
+ clearly documented together with its declaration in the API. In
+ any case, the effect on the returned resource/resources is required
+ behavior for APIs.
+
+ # Field Masks in Update Operations
+
+ A field mask in update operations specifies which fields of the
+ targeted resource are going to be updated. The API is required
+ to only change the values of the fields as specified in the mask
+ and leave the others untouched. If a resource is passed in to
+ describe the updated values, the API ignores the values of all
+ fields not covered by the mask.
+
+ If a repeated field is specified for an update operation, new values will
+ be appended to the existing repeated field in the target resource. Note that
+ a repeated field is only allowed in the last position of a `paths` string.
+
+ If a sub-message is specified in the last position of the field mask for an
+ update operation, then new value will be merged into the existing sub-message
+ in the target resource.
+
+ For example, given the target message:
+
+ f {
+ b {
+ d: 1
+ x: 2
+ }
+ c: [1]
+ }
+
+ And an update message:
+
+ f {
+ b {
+ d: 10
+ }
+ c: [2]
+ }
+
+ then if the field mask is:
+
+ paths: ["f.b", "f.c"]
+
+ then the result will be:
+
+ f {
+ b {
+ d: 10
+ x: 2
+ }
+ c: [1, 2]
+ }
+
+ An implementation may provide options to override this default behavior for
+ repeated and message fields.
+
+ In order to reset a field's value to the default, the field must
+ be in the mask and set to the default value in the provided resource.
+ Hence, in order to reset all fields of a resource, provide a default
+ instance of the resource and set all fields in the mask, or do
+ not provide a mask as described below.
+
+ If a field mask is not present on update, the operation applies to
+ all fields (as if a field mask of all fields has been specified).
+ Note that in the presence of schema evolution, this may mean that
+ fields the client does not know and has therefore not filled into
+ the request will be reset to their default. If this is unwanted
+ behavior, a specific service may require a client to always specify
+ a field mask, producing an error if not.
+
+ As with get operations, the location of the resource which
+ describes the updated values in the request message depends on the
+ operation kind. In any case, the effect of the field mask is
+ required to be honored by the API.
+
+ ## Considerations for HTTP REST
+
+ The HTTP kind of an update operation which uses a field mask must
+ be set to PATCH instead of PUT in order to satisfy HTTP semantics
+ (PUT must only be used for full updates).
+
+ # JSON Encoding of Field Masks
+
+ In JSON, a field mask is encoded as a single string where paths are
+ separated by a comma. Fields name in each path are converted
+ to/from lower-camel naming conventions.
+
+ As an example, consider the following message declarations:
+
+ message Profile {
+ User user = 1;
+ Photo photo = 2;
+ }
+ message User {
+ string display_name = 1;
+ string address = 2;
+ }
+
+ In proto a field mask for `Profile` may look as such:
+
+ mask {
+ paths: "user.display_name"
+ paths: "photo"
+ }
+
+ In JSON, the same mask is represented as below:
+
+ {
+ mask: "user.displayName,photo"
+ }
+
+ # Field Masks and Oneof Fields
+
+ Field masks treat fields in oneofs just as regular fields. Consider the
+ following message:
+
+ message SampleMessage {
+ oneof test_oneof {
+ string name = 4;
+ SubMessage sub_message = 9;
+ }
+ }
+
+ The field mask can be:
+
+ mask {
+ paths: "name"
+ }
+
+ Or:
+
+ mask {
+ paths: "sub_message"
+ }
+
+ Note that oneof type names ("test_oneof" in this case) cannot be used in
+ paths.
+
+ ## Field Mask Verification
+
+ The implementation of any API method which has a FieldMask type field in the
+ request should verify the included field paths, and return an
+ `INVALID_ARGUMENT` error if any path is unmappable.
- name: allowMissing
in: query
description: |-
@@ -5511,15 +7483,211 @@ paths:
required: true
schema:
type: string
- - name: updateMask.paths
+ - name: updateMask
in: query
- description: The set of field mask paths.
+ description: The list of fields to update.
schema:
- type: array
- items:
- type: string
- title: paths
- description: The set of field mask paths.
+ type: string
+ description: |-
+ `FieldMask` represents a set of symbolic field paths, for example:
+
+ paths: "f.a"
+ paths: "f.b.d"
+
+ Here `f` represents a field in some root message, `a` and `b`
+ fields in the message found in `f`, and `d` a field found in the
+ message in `f.b`.
+
+ Field masks are used to specify a subset of fields that should be
+ returned by a get operation or modified by an update operation.
+ Field masks also have a custom JSON encoding (see below).
+
+ # Field Masks in Projections
+
+ When used in the context of a projection, a response message or
+ sub-message is filtered by the API to only contain those fields as
+ specified in the mask. For example, if the mask in the previous
+ example is applied to a response message as follows:
+
+ f {
+ a : 22
+ b {
+ d : 1
+ x : 2
+ }
+ y : 13
+ }
+ z: 8
+
+ The result will not contain specific values for fields x,y and z
+ (their value will be set to the default, and omitted in proto text
+ output):
+
+
+ f {
+ a : 22
+ b {
+ d : 1
+ }
+ }
+
+ A repeated field is not allowed except at the last position of a
+ paths string.
+
+ If a FieldMask object is not present in a get operation, the
+ operation applies to all fields (as if a FieldMask of all fields
+ had been specified).
+
+ Note that a field mask does not necessarily apply to the
+ top-level response message. In case of a REST get operation, the
+ field mask applies directly to the response, but in case of a REST
+ list operation, the mask instead applies to each individual message
+ in the returned resource list. In case of a REST custom method,
+ other definitions may be used. Where the mask applies will be
+ clearly documented together with its declaration in the API. In
+ any case, the effect on the returned resource/resources is required
+ behavior for APIs.
+
+ # Field Masks in Update Operations
+
+ A field mask in update operations specifies which fields of the
+ targeted resource are going to be updated. The API is required
+ to only change the values of the fields as specified in the mask
+ and leave the others untouched. If a resource is passed in to
+ describe the updated values, the API ignores the values of all
+ fields not covered by the mask.
+
+ If a repeated field is specified for an update operation, new values will
+ be appended to the existing repeated field in the target resource. Note that
+ a repeated field is only allowed in the last position of a `paths` string.
+
+ If a sub-message is specified in the last position of the field mask for an
+ update operation, then new value will be merged into the existing sub-message
+ in the target resource.
+
+ For example, given the target message:
+
+ f {
+ b {
+ d: 1
+ x: 2
+ }
+ c: [1]
+ }
+
+ And an update message:
+
+ f {
+ b {
+ d: 10
+ }
+ c: [2]
+ }
+
+ then if the field mask is:
+
+ paths: ["f.b", "f.c"]
+
+ then the result will be:
+
+ f {
+ b {
+ d: 10
+ x: 2
+ }
+ c: [1, 2]
+ }
+
+ An implementation may provide options to override this default behavior for
+ repeated and message fields.
+
+ In order to reset a field's value to the default, the field must
+ be in the mask and set to the default value in the provided resource.
+ Hence, in order to reset all fields of a resource, provide a default
+ instance of the resource and set all fields in the mask, or do
+ not provide a mask as described below.
+
+ If a field mask is not present on update, the operation applies to
+ all fields (as if a field mask of all fields has been specified).
+ Note that in the presence of schema evolution, this may mean that
+ fields the client does not know and has therefore not filled into
+ the request will be reset to their default. If this is unwanted
+ behavior, a specific service may require a client to always specify
+ a field mask, producing an error if not.
+
+ As with get operations, the location of the resource which
+ describes the updated values in the request message depends on the
+ operation kind. In any case, the effect of the field mask is
+ required to be honored by the API.
+
+ ## Considerations for HTTP REST
+
+ The HTTP kind of an update operation which uses a field mask must
+ be set to PATCH instead of PUT in order to satisfy HTTP semantics
+ (PUT must only be used for full updates).
+
+ # JSON Encoding of Field Masks
+
+ In JSON, a field mask is encoded as a single string where paths are
+ separated by a comma. Fields name in each path are converted
+ to/from lower-camel naming conventions.
+
+ As an example, consider the following message declarations:
+
+ message Profile {
+ User user = 1;
+ Photo photo = 2;
+ }
+ message User {
+ string display_name = 1;
+ string address = 2;
+ }
+
+ In proto a field mask for `Profile` may look as such:
+
+ mask {
+ paths: "user.display_name"
+ paths: "photo"
+ }
+
+ In JSON, the same mask is represented as below:
+
+ {
+ mask: "user.displayName,photo"
+ }
+
+ # Field Masks and Oneof Fields
+
+ Field masks treat fields in oneofs just as regular fields. Consider the
+ following message:
+
+ message SampleMessage {
+ oneof test_oneof {
+ string name = 4;
+ SubMessage sub_message = 9;
+ }
+ }
+
+ The field mask can be:
+
+ mask {
+ paths: "name"
+ }
+
+ Or:
+
+ mask {
+ paths: "sub_message"
+ }
+
+ Note that oneof type names ("test_oneof" in this case) cannot be used in
+ paths.
+
+ ## Field Mask Verification
+
+ The implementation of any API method which has a FieldMask type field in the
+ request should verify the included field paths, and return an
+ `INVALID_ARGUMENT` error if any path is unmappable.
- name: allowMissing
in: query
description: |-
@@ -5929,15 +8097,211 @@ paths:
required: true
schema:
type: string
- - name: updateMask.paths
+ - name: updateMask
in: query
- description: The set of field mask paths.
+ description: The list of fields to update.
schema:
- type: array
- items:
- type: string
- title: paths
- description: The set of field mask paths.
+ type: string
+ description: |-
+ `FieldMask` represents a set of symbolic field paths, for example:
+
+ paths: "f.a"
+ paths: "f.b.d"
+
+ Here `f` represents a field in some root message, `a` and `b`
+ fields in the message found in `f`, and `d` a field found in the
+ message in `f.b`.
+
+ Field masks are used to specify a subset of fields that should be
+ returned by a get operation or modified by an update operation.
+ Field masks also have a custom JSON encoding (see below).
+
+ # Field Masks in Projections
+
+ When used in the context of a projection, a response message or
+ sub-message is filtered by the API to only contain those fields as
+ specified in the mask. For example, if the mask in the previous
+ example is applied to a response message as follows:
+
+ f {
+ a : 22
+ b {
+ d : 1
+ x : 2
+ }
+ y : 13
+ }
+ z: 8
+
+ The result will not contain specific values for fields x,y and z
+ (their value will be set to the default, and omitted in proto text
+ output):
+
+
+ f {
+ a : 22
+ b {
+ d : 1
+ }
+ }
+
+ A repeated field is not allowed except at the last position of a
+ paths string.
+
+ If a FieldMask object is not present in a get operation, the
+ operation applies to all fields (as if a FieldMask of all fields
+ had been specified).
+
+ Note that a field mask does not necessarily apply to the
+ top-level response message. In case of a REST get operation, the
+ field mask applies directly to the response, but in case of a REST
+ list operation, the mask instead applies to each individual message
+ in the returned resource list. In case of a REST custom method,
+ other definitions may be used. Where the mask applies will be
+ clearly documented together with its declaration in the API. In
+ any case, the effect on the returned resource/resources is required
+ behavior for APIs.
+
+ # Field Masks in Update Operations
+
+ A field mask in update operations specifies which fields of the
+ targeted resource are going to be updated. The API is required
+ to only change the values of the fields as specified in the mask
+ and leave the others untouched. If a resource is passed in to
+ describe the updated values, the API ignores the values of all
+ fields not covered by the mask.
+
+ If a repeated field is specified for an update operation, new values will
+ be appended to the existing repeated field in the target resource. Note that
+ a repeated field is only allowed in the last position of a `paths` string.
+
+ If a sub-message is specified in the last position of the field mask for an
+ update operation, then new value will be merged into the existing sub-message
+ in the target resource.
+
+ For example, given the target message:
+
+ f {
+ b {
+ d: 1
+ x: 2
+ }
+ c: [1]
+ }
+
+ And an update message:
+
+ f {
+ b {
+ d: 10
+ }
+ c: [2]
+ }
+
+ then if the field mask is:
+
+ paths: ["f.b", "f.c"]
+
+ then the result will be:
+
+ f {
+ b {
+ d: 10
+ x: 2
+ }
+ c: [1, 2]
+ }
+
+ An implementation may provide options to override this default behavior for
+ repeated and message fields.
+
+ In order to reset a field's value to the default, the field must
+ be in the mask and set to the default value in the provided resource.
+ Hence, in order to reset all fields of a resource, provide a default
+ instance of the resource and set all fields in the mask, or do
+ not provide a mask as described below.
+
+ If a field mask is not present on update, the operation applies to
+ all fields (as if a field mask of all fields has been specified).
+ Note that in the presence of schema evolution, this may mean that
+ fields the client does not know and has therefore not filled into
+ the request will be reset to their default. If this is unwanted
+ behavior, a specific service may require a client to always specify
+ a field mask, producing an error if not.
+
+ As with get operations, the location of the resource which
+ describes the updated values in the request message depends on the
+ operation kind. In any case, the effect of the field mask is
+ required to be honored by the API.
+
+ ## Considerations for HTTP REST
+
+ The HTTP kind of an update operation which uses a field mask must
+ be set to PATCH instead of PUT in order to satisfy HTTP semantics
+ (PUT must only be used for full updates).
+
+ # JSON Encoding of Field Masks
+
+ In JSON, a field mask is encoded as a single string where paths are
+ separated by a comma. Fields name in each path are converted
+ to/from lower-camel naming conventions.
+
+ As an example, consider the following message declarations:
+
+ message Profile {
+ User user = 1;
+ Photo photo = 2;
+ }
+ message User {
+ string display_name = 1;
+ string address = 2;
+ }
+
+ In proto a field mask for `Profile` may look as such:
+
+ mask {
+ paths: "user.display_name"
+ paths: "photo"
+ }
+
+ In JSON, the same mask is represented as below:
+
+ {
+ mask: "user.displayName,photo"
+ }
+
+ # Field Masks and Oneof Fields
+
+ Field masks treat fields in oneofs just as regular fields. Consider the
+ following message:
+
+ message SampleMessage {
+ oneof test_oneof {
+ string name = 4;
+ SubMessage sub_message = 9;
+ }
+ }
+
+ The field mask can be:
+
+ mask {
+ paths: "name"
+ }
+
+ Or:
+
+ mask {
+ paths: "sub_message"
+ }
+
+ Note that oneof type names ("test_oneof" in this case) cannot be used in
+ paths.
+
+ ## Field Mask Verification
+
+ The implementation of any API method which has a FieldMask type field in the
+ request should verify the included field paths, and return an
+ `INVALID_ARGUMENT` error if any path is unmappable.
- name: allowMissing
in: query
description: |-
@@ -6134,15 +8498,211 @@ paths:
required: true
schema:
type: string
- - name: updateMask.paths
+ - name: updateMask
in: query
- description: The set of field mask paths.
+ description: The list of fields to update.
schema:
- type: array
- items:
- type: string
- title: paths
- description: The set of field mask paths.
+ type: string
+ description: |-
+ `FieldMask` represents a set of symbolic field paths, for example:
+
+ paths: "f.a"
+ paths: "f.b.d"
+
+ Here `f` represents a field in some root message, `a` and `b`
+ fields in the message found in `f`, and `d` a field found in the
+ message in `f.b`.
+
+ Field masks are used to specify a subset of fields that should be
+ returned by a get operation or modified by an update operation.
+ Field masks also have a custom JSON encoding (see below).
+
+ # Field Masks in Projections
+
+ When used in the context of a projection, a response message or
+ sub-message is filtered by the API to only contain those fields as
+ specified in the mask. For example, if the mask in the previous
+ example is applied to a response message as follows:
+
+ f {
+ a : 22
+ b {
+ d : 1
+ x : 2
+ }
+ y : 13
+ }
+ z: 8
+
+ The result will not contain specific values for fields x,y and z
+ (their value will be set to the default, and omitted in proto text
+ output):
+
+
+ f {
+ a : 22
+ b {
+ d : 1
+ }
+ }
+
+ A repeated field is not allowed except at the last position of a
+ paths string.
+
+ If a FieldMask object is not present in a get operation, the
+ operation applies to all fields (as if a FieldMask of all fields
+ had been specified).
+
+ Note that a field mask does not necessarily apply to the
+ top-level response message. In case of a REST get operation, the
+ field mask applies directly to the response, but in case of a REST
+ list operation, the mask instead applies to each individual message
+ in the returned resource list. In case of a REST custom method,
+ other definitions may be used. Where the mask applies will be
+ clearly documented together with its declaration in the API. In
+ any case, the effect on the returned resource/resources is required
+ behavior for APIs.
+
+ # Field Masks in Update Operations
+
+ A field mask in update operations specifies which fields of the
+ targeted resource are going to be updated. The API is required
+ to only change the values of the fields as specified in the mask
+ and leave the others untouched. If a resource is passed in to
+ describe the updated values, the API ignores the values of all
+ fields not covered by the mask.
+
+ If a repeated field is specified for an update operation, new values will
+ be appended to the existing repeated field in the target resource. Note that
+ a repeated field is only allowed in the last position of a `paths` string.
+
+ If a sub-message is specified in the last position of the field mask for an
+ update operation, then new value will be merged into the existing sub-message
+ in the target resource.
+
+ For example, given the target message:
+
+ f {
+ b {
+ d: 1
+ x: 2
+ }
+ c: [1]
+ }
+
+ And an update message:
+
+ f {
+ b {
+ d: 10
+ }
+ c: [2]
+ }
+
+ then if the field mask is:
+
+ paths: ["f.b", "f.c"]
+
+ then the result will be:
+
+ f {
+ b {
+ d: 10
+ x: 2
+ }
+ c: [1, 2]
+ }
+
+ An implementation may provide options to override this default behavior for
+ repeated and message fields.
+
+ In order to reset a field's value to the default, the field must
+ be in the mask and set to the default value in the provided resource.
+ Hence, in order to reset all fields of a resource, provide a default
+ instance of the resource and set all fields in the mask, or do
+ not provide a mask as described below.
+
+ If a field mask is not present on update, the operation applies to
+ all fields (as if a field mask of all fields has been specified).
+ Note that in the presence of schema evolution, this may mean that
+ fields the client does not know and has therefore not filled into
+ the request will be reset to their default. If this is unwanted
+ behavior, a specific service may require a client to always specify
+ a field mask, producing an error if not.
+
+ As with get operations, the location of the resource which
+ describes the updated values in the request message depends on the
+ operation kind. In any case, the effect of the field mask is
+ required to be honored by the API.
+
+ ## Considerations for HTTP REST
+
+ The HTTP kind of an update operation which uses a field mask must
+ be set to PATCH instead of PUT in order to satisfy HTTP semantics
+ (PUT must only be used for full updates).
+
+ # JSON Encoding of Field Masks
+
+ In JSON, a field mask is encoded as a single string where paths are
+ separated by a comma. Fields name in each path are converted
+ to/from lower-camel naming conventions.
+
+ As an example, consider the following message declarations:
+
+ message Profile {
+ User user = 1;
+ Photo photo = 2;
+ }
+ message User {
+ string display_name = 1;
+ string address = 2;
+ }
+
+ In proto a field mask for `Profile` may look as such:
+
+ mask {
+ paths: "user.display_name"
+ paths: "photo"
+ }
+
+ In JSON, the same mask is represented as below:
+
+ {
+ mask: "user.displayName,photo"
+ }
+
+ # Field Masks and Oneof Fields
+
+ Field masks treat fields in oneofs just as regular fields. Consider the
+ following message:
+
+ message SampleMessage {
+ oneof test_oneof {
+ string name = 4;
+ SubMessage sub_message = 9;
+ }
+ }
+
+ The field mask can be:
+
+ mask {
+ paths: "name"
+ }
+
+ Or:
+
+ mask {
+ paths: "sub_message"
+ }
+
+ Note that oneof type names ("test_oneof" in this case) cannot be used in
+ paths.
+
+ ## Field Mask Verification
+
+ The implementation of any API method which has a FieldMask type field in the
+ request should verify the included field paths, and return an
+ `INVALID_ARGUMENT` error if any path is unmappable.
- name: allowMissing
in: query
description: |-
@@ -6543,15 +9103,211 @@ paths:
required: true
schema:
type: string
- - name: updateMask.paths
+ - name: updateMask
in: query
- description: The set of field mask paths.
+ description: The list of fields to update.
schema:
- type: array
- items:
- type: string
- title: paths
- description: The set of field mask paths.
+ type: string
+ description: |-
+ `FieldMask` represents a set of symbolic field paths, for example:
+
+ paths: "f.a"
+ paths: "f.b.d"
+
+ Here `f` represents a field in some root message, `a` and `b`
+ fields in the message found in `f`, and `d` a field found in the
+ message in `f.b`.
+
+ Field masks are used to specify a subset of fields that should be
+ returned by a get operation or modified by an update operation.
+ Field masks also have a custom JSON encoding (see below).
+
+ # Field Masks in Projections
+
+ When used in the context of a projection, a response message or
+ sub-message is filtered by the API to only contain those fields as
+ specified in the mask. For example, if the mask in the previous
+ example is applied to a response message as follows:
+
+ f {
+ a : 22
+ b {
+ d : 1
+ x : 2
+ }
+ y : 13
+ }
+ z: 8
+
+ The result will not contain specific values for fields x,y and z
+ (their value will be set to the default, and omitted in proto text
+ output):
+
+
+ f {
+ a : 22
+ b {
+ d : 1
+ }
+ }
+
+ A repeated field is not allowed except at the last position of a
+ paths string.
+
+ If a FieldMask object is not present in a get operation, the
+ operation applies to all fields (as if a FieldMask of all fields
+ had been specified).
+
+ Note that a field mask does not necessarily apply to the
+ top-level response message. In case of a REST get operation, the
+ field mask applies directly to the response, but in case of a REST
+ list operation, the mask instead applies to each individual message
+ in the returned resource list. In case of a REST custom method,
+ other definitions may be used. Where the mask applies will be
+ clearly documented together with its declaration in the API. In
+ any case, the effect on the returned resource/resources is required
+ behavior for APIs.
+
+ # Field Masks in Update Operations
+
+ A field mask in update operations specifies which fields of the
+ targeted resource are going to be updated. The API is required
+ to only change the values of the fields as specified in the mask
+ and leave the others untouched. If a resource is passed in to
+ describe the updated values, the API ignores the values of all
+ fields not covered by the mask.
+
+ If a repeated field is specified for an update operation, new values will
+ be appended to the existing repeated field in the target resource. Note that
+ a repeated field is only allowed in the last position of a `paths` string.
+
+ If a sub-message is specified in the last position of the field mask for an
+ update operation, then new value will be merged into the existing sub-message
+ in the target resource.
+
+ For example, given the target message:
+
+ f {
+ b {
+ d: 1
+ x: 2
+ }
+ c: [1]
+ }
+
+ And an update message:
+
+ f {
+ b {
+ d: 10
+ }
+ c: [2]
+ }
+
+ then if the field mask is:
+
+ paths: ["f.b", "f.c"]
+
+ then the result will be:
+
+ f {
+ b {
+ d: 10
+ x: 2
+ }
+ c: [1, 2]
+ }
+
+ An implementation may provide options to override this default behavior for
+ repeated and message fields.
+
+ In order to reset a field's value to the default, the field must
+ be in the mask and set to the default value in the provided resource.
+ Hence, in order to reset all fields of a resource, provide a default
+ instance of the resource and set all fields in the mask, or do
+ not provide a mask as described below.
+
+ If a field mask is not present on update, the operation applies to
+ all fields (as if a field mask of all fields has been specified).
+ Note that in the presence of schema evolution, this may mean that
+ fields the client does not know and has therefore not filled into
+ the request will be reset to their default. If this is unwanted
+ behavior, a specific service may require a client to always specify
+ a field mask, producing an error if not.
+
+ As with get operations, the location of the resource which
+ describes the updated values in the request message depends on the
+ operation kind. In any case, the effect of the field mask is
+ required to be honored by the API.
+
+ ## Considerations for HTTP REST
+
+ The HTTP kind of an update operation which uses a field mask must
+ be set to PATCH instead of PUT in order to satisfy HTTP semantics
+ (PUT must only be used for full updates).
+
+ # JSON Encoding of Field Masks
+
+ In JSON, a field mask is encoded as a single string where paths are
+ separated by a comma. Fields name in each path are converted
+ to/from lower-camel naming conventions.
+
+ As an example, consider the following message declarations:
+
+ message Profile {
+ User user = 1;
+ Photo photo = 2;
+ }
+ message User {
+ string display_name = 1;
+ string address = 2;
+ }
+
+ In proto a field mask for `Profile` may look as such:
+
+ mask {
+ paths: "user.display_name"
+ paths: "photo"
+ }
+
+ In JSON, the same mask is represented as below:
+
+ {
+ mask: "user.displayName,photo"
+ }
+
+ # Field Masks and Oneof Fields
+
+ Field masks treat fields in oneofs just as regular fields. Consider the
+ following message:
+
+ message SampleMessage {
+ oneof test_oneof {
+ string name = 4;
+ SubMessage sub_message = 9;
+ }
+ }
+
+ The field mask can be:
+
+ mask {
+ paths: "name"
+ }
+
+ Or:
+
+ mask {
+ paths: "sub_message"
+ }
+
+ Note that oneof type names ("test_oneof" in this case) cannot be used in
+ paths.
+
+ ## Field Mask Verification
+
+ The implementation of any API method which has a FieldMask type field in the
+ request should verify the included field paths, and return an
+ `INVALID_ARGUMENT` error if any path is unmappable.
- name: allowMissing
in: query
description: |-
@@ -7050,9 +9806,11 @@ paths:
The tasks to run.
Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}
runTime:
+ oneOf:
+ - $ref: '#/components/schemas/google.protobuf.Timestamp'
+ - type: "null"
title: run_time
description: The task run should run after run_time.
- $ref: '#/components/schemas/google.protobuf.Timestamp'
title: BatchRunTasksRequest
additionalProperties: false
required: true
@@ -7347,9 +10105,11 @@ paths:
in: query
description: Filter by specific policy type.
schema:
+ oneOf:
+ - $ref: '#/components/schemas/bytebase.v1.PolicyType'
+ - type: "null"
title: policy_type
description: Filter by specific policy type.
- $ref: '#/components/schemas/bytebase.v1.PolicyType'
- name: showDeleted
in: query
description: Show deleted policies if specified.
@@ -7479,15 +10239,211 @@ paths:
required: true
schema:
type: string
- - name: updateMask.paths
+ - name: updateMask
in: query
- description: The set of field mask paths.
+ description: The list of fields to update.
schema:
- type: array
- items:
- type: string
- title: paths
- description: The set of field mask paths.
+ type: string
+ description: |-
+ `FieldMask` represents a set of symbolic field paths, for example:
+
+ paths: "f.a"
+ paths: "f.b.d"
+
+ Here `f` represents a field in some root message, `a` and `b`
+ fields in the message found in `f`, and `d` a field found in the
+ message in `f.b`.
+
+ Field masks are used to specify a subset of fields that should be
+ returned by a get operation or modified by an update operation.
+ Field masks also have a custom JSON encoding (see below).
+
+ # Field Masks in Projections
+
+ When used in the context of a projection, a response message or
+ sub-message is filtered by the API to only contain those fields as
+ specified in the mask. For example, if the mask in the previous
+ example is applied to a response message as follows:
+
+ f {
+ a : 22
+ b {
+ d : 1
+ x : 2
+ }
+ y : 13
+ }
+ z: 8
+
+ The result will not contain specific values for fields x,y and z
+ (their value will be set to the default, and omitted in proto text
+ output):
+
+
+ f {
+ a : 22
+ b {
+ d : 1
+ }
+ }
+
+ A repeated field is not allowed except at the last position of a
+ paths string.
+
+ If a FieldMask object is not present in a get operation, the
+ operation applies to all fields (as if a FieldMask of all fields
+ had been specified).
+
+ Note that a field mask does not necessarily apply to the
+ top-level response message. In case of a REST get operation, the
+ field mask applies directly to the response, but in case of a REST
+ list operation, the mask instead applies to each individual message
+ in the returned resource list. In case of a REST custom method,
+ other definitions may be used. Where the mask applies will be
+ clearly documented together with its declaration in the API. In
+ any case, the effect on the returned resource/resources is required
+ behavior for APIs.
+
+ # Field Masks in Update Operations
+
+ A field mask in update operations specifies which fields of the
+ targeted resource are going to be updated. The API is required
+ to only change the values of the fields as specified in the mask
+ and leave the others untouched. If a resource is passed in to
+ describe the updated values, the API ignores the values of all
+ fields not covered by the mask.
+
+ If a repeated field is specified for an update operation, new values will
+ be appended to the existing repeated field in the target resource. Note that
+ a repeated field is only allowed in the last position of a `paths` string.
+
+ If a sub-message is specified in the last position of the field mask for an
+ update operation, then new value will be merged into the existing sub-message
+ in the target resource.
+
+ For example, given the target message:
+
+ f {
+ b {
+ d: 1
+ x: 2
+ }
+ c: [1]
+ }
+
+ And an update message:
+
+ f {
+ b {
+ d: 10
+ }
+ c: [2]
+ }
+
+ then if the field mask is:
+
+ paths: ["f.b", "f.c"]
+
+ then the result will be:
+
+ f {
+ b {
+ d: 10
+ x: 2
+ }
+ c: [1, 2]
+ }
+
+ An implementation may provide options to override this default behavior for
+ repeated and message fields.
+
+ In order to reset a field's value to the default, the field must
+ be in the mask and set to the default value in the provided resource.
+ Hence, in order to reset all fields of a resource, provide a default
+ instance of the resource and set all fields in the mask, or do
+ not provide a mask as described below.
+
+ If a field mask is not present on update, the operation applies to
+ all fields (as if a field mask of all fields has been specified).
+ Note that in the presence of schema evolution, this may mean that
+ fields the client does not know and has therefore not filled into
+ the request will be reset to their default. If this is unwanted
+ behavior, a specific service may require a client to always specify
+ a field mask, producing an error if not.
+
+ As with get operations, the location of the resource which
+ describes the updated values in the request message depends on the
+ operation kind. In any case, the effect of the field mask is
+ required to be honored by the API.
+
+ ## Considerations for HTTP REST
+
+ The HTTP kind of an update operation which uses a field mask must
+ be set to PATCH instead of PUT in order to satisfy HTTP semantics
+ (PUT must only be used for full updates).
+
+ # JSON Encoding of Field Masks
+
+ In JSON, a field mask is encoded as a single string where paths are
+ separated by a comma. Fields name in each path are converted
+ to/from lower-camel naming conventions.
+
+ As an example, consider the following message declarations:
+
+ message Profile {
+ User user = 1;
+ Photo photo = 2;
+ }
+ message User {
+ string display_name = 1;
+ string address = 2;
+ }
+
+ In proto a field mask for `Profile` may look as such:
+
+ mask {
+ paths: "user.display_name"
+ paths: "photo"
+ }
+
+ In JSON, the same mask is represented as below:
+
+ {
+ mask: "user.displayName,photo"
+ }
+
+ # Field Masks and Oneof Fields
+
+ Field masks treat fields in oneofs just as regular fields. Consider the
+ following message:
+
+ message SampleMessage {
+ oneof test_oneof {
+ string name = 4;
+ SubMessage sub_message = 9;
+ }
+ }
+
+ The field mask can be:
+
+ mask {
+ paths: "name"
+ }
+
+ Or:
+
+ mask {
+ paths: "sub_message"
+ }
+
+ Note that oneof type names ("test_oneof" in this case) cannot be used in
+ paths.
+
+ ## Field Mask Verification
+
+ The implementation of any API method which has a FieldMask type field in the
+ request should verify the included field paths, and return an
+ `INVALID_ARGUMENT` error if any path is unmappable.
- name: allowMissing
in: query
description: |-
@@ -7751,15 +10707,211 @@ paths:
required: true
schema:
type: string
- - name: updateMask.paths
+ - name: updateMask
in: query
- description: The set of field mask paths.
+ description: The list of fields to be updated.
schema:
- type: array
- items:
- type: string
- title: paths
- description: The set of field mask paths.
+ type: string
+ description: |-
+ `FieldMask` represents a set of symbolic field paths, for example:
+
+ paths: "f.a"
+ paths: "f.b.d"
+
+ Here `f` represents a field in some root message, `a` and `b`
+ fields in the message found in `f`, and `d` a field found in the
+ message in `f.b`.
+
+ Field masks are used to specify a subset of fields that should be
+ returned by a get operation or modified by an update operation.
+ Field masks also have a custom JSON encoding (see below).
+
+ # Field Masks in Projections
+
+ When used in the context of a projection, a response message or
+ sub-message is filtered by the API to only contain those fields as
+ specified in the mask. For example, if the mask in the previous
+ example is applied to a response message as follows:
+
+ f {
+ a : 22
+ b {
+ d : 1
+ x : 2
+ }
+ y : 13
+ }
+ z: 8
+
+ The result will not contain specific values for fields x,y and z
+ (their value will be set to the default, and omitted in proto text
+ output):
+
+
+ f {
+ a : 22
+ b {
+ d : 1
+ }
+ }
+
+ A repeated field is not allowed except at the last position of a
+ paths string.
+
+ If a FieldMask object is not present in a get operation, the
+ operation applies to all fields (as if a FieldMask of all fields
+ had been specified).
+
+ Note that a field mask does not necessarily apply to the
+ top-level response message. In case of a REST get operation, the
+ field mask applies directly to the response, but in case of a REST
+ list operation, the mask instead applies to each individual message
+ in the returned resource list. In case of a REST custom method,
+ other definitions may be used. Where the mask applies will be
+ clearly documented together with its declaration in the API. In
+ any case, the effect on the returned resource/resources is required
+ behavior for APIs.
+
+ # Field Masks in Update Operations
+
+ A field mask in update operations specifies which fields of the
+ targeted resource are going to be updated. The API is required
+ to only change the values of the fields as specified in the mask
+ and leave the others untouched. If a resource is passed in to
+ describe the updated values, the API ignores the values of all
+ fields not covered by the mask.
+
+ If a repeated field is specified for an update operation, new values will
+ be appended to the existing repeated field in the target resource. Note that
+ a repeated field is only allowed in the last position of a `paths` string.
+
+ If a sub-message is specified in the last position of the field mask for an
+ update operation, then new value will be merged into the existing sub-message
+ in the target resource.
+
+ For example, given the target message:
+
+ f {
+ b {
+ d: 1
+ x: 2
+ }
+ c: [1]
+ }
+
+ And an update message:
+
+ f {
+ b {
+ d: 10
+ }
+ c: [2]
+ }
+
+ then if the field mask is:
+
+ paths: ["f.b", "f.c"]
+
+ then the result will be:
+
+ f {
+ b {
+ d: 10
+ x: 2
+ }
+ c: [1, 2]
+ }
+
+ An implementation may provide options to override this default behavior for
+ repeated and message fields.
+
+ In order to reset a field's value to the default, the field must
+ be in the mask and set to the default value in the provided resource.
+ Hence, in order to reset all fields of a resource, provide a default
+ instance of the resource and set all fields in the mask, or do
+ not provide a mask as described below.
+
+ If a field mask is not present on update, the operation applies to
+ all fields (as if a field mask of all fields has been specified).
+ Note that in the presence of schema evolution, this may mean that
+ fields the client does not know and has therefore not filled into
+ the request will be reset to their default. If this is unwanted
+ behavior, a specific service may require a client to always specify
+ a field mask, producing an error if not.
+
+ As with get operations, the location of the resource which
+ describes the updated values in the request message depends on the
+ operation kind. In any case, the effect of the field mask is
+ required to be honored by the API.
+
+ ## Considerations for HTTP REST
+
+ The HTTP kind of an update operation which uses a field mask must
+ be set to PATCH instead of PUT in order to satisfy HTTP semantics
+ (PUT must only be used for full updates).
+
+ # JSON Encoding of Field Masks
+
+ In JSON, a field mask is encoded as a single string where paths are
+ separated by a comma. Fields name in each path are converted
+ to/from lower-camel naming conventions.
+
+ As an example, consider the following message declarations:
+
+ message Profile {
+ User user = 1;
+ Photo photo = 2;
+ }
+ message User {
+ string display_name = 1;
+ string address = 2;
+ }
+
+ In proto a field mask for `Profile` may look as such:
+
+ mask {
+ paths: "user.display_name"
+ paths: "photo"
+ }
+
+ In JSON, the same mask is represented as below:
+
+ {
+ mask: "user.displayName,photo"
+ }
+
+ # Field Masks and Oneof Fields
+
+ Field masks treat fields in oneofs just as regular fields. Consider the
+ following message:
+
+ message SampleMessage {
+ oneof test_oneof {
+ string name = 4;
+ SubMessage sub_message = 9;
+ }
+ }
+
+ The field mask can be:
+
+ mask {
+ paths: "name"
+ }
+
+ Or:
+
+ mask {
+ paths: "sub_message"
+ }
+
+ Note that oneof type names ("test_oneof" in this case) cannot be used in
+ paths.
+
+ ## Field Mask Verification
+
+ The implementation of any API method which has a FieldMask type field in the
+ request should verify the included field paths, and return an
+ `INVALID_ARGUMENT` error if any path is unmappable.
requestBody:
description: The release to update.
content:
@@ -8283,15 +11435,211 @@ paths:
required: true
schema:
type: string
- - name: updateMask.paths
+ - name: updateMask
in: query
- description: The set of field mask paths.
+ description: The list of fields to update.
schema:
- type: array
- items:
- type: string
- title: paths
- description: The set of field mask paths.
+ type: string
+ description: |-
+ `FieldMask` represents a set of symbolic field paths, for example:
+
+ paths: "f.a"
+ paths: "f.b.d"
+
+ Here `f` represents a field in some root message, `a` and `b`
+ fields in the message found in `f`, and `d` a field found in the
+ message in `f.b`.
+
+ Field masks are used to specify a subset of fields that should be
+ returned by a get operation or modified by an update operation.
+ Field masks also have a custom JSON encoding (see below).
+
+ # Field Masks in Projections
+
+ When used in the context of a projection, a response message or
+ sub-message is filtered by the API to only contain those fields as
+ specified in the mask. For example, if the mask in the previous
+ example is applied to a response message as follows:
+
+ f {
+ a : 22
+ b {
+ d : 1
+ x : 2
+ }
+ y : 13
+ }
+ z: 8
+
+ The result will not contain specific values for fields x,y and z
+ (their value will be set to the default, and omitted in proto text
+ output):
+
+
+ f {
+ a : 22
+ b {
+ d : 1
+ }
+ }
+
+ A repeated field is not allowed except at the last position of a
+ paths string.
+
+ If a FieldMask object is not present in a get operation, the
+ operation applies to all fields (as if a FieldMask of all fields
+ had been specified).
+
+ Note that a field mask does not necessarily apply to the
+ top-level response message. In case of a REST get operation, the
+ field mask applies directly to the response, but in case of a REST
+ list operation, the mask instead applies to each individual message
+ in the returned resource list. In case of a REST custom method,
+ other definitions may be used. Where the mask applies will be
+ clearly documented together with its declaration in the API. In
+ any case, the effect on the returned resource/resources is required
+ behavior for APIs.
+
+ # Field Masks in Update Operations
+
+ A field mask in update operations specifies which fields of the
+ targeted resource are going to be updated. The API is required
+ to only change the values of the fields as specified in the mask
+ and leave the others untouched. If a resource is passed in to
+ describe the updated values, the API ignores the values of all
+ fields not covered by the mask.
+
+ If a repeated field is specified for an update operation, new values will
+ be appended to the existing repeated field in the target resource. Note that
+ a repeated field is only allowed in the last position of a `paths` string.
+
+ If a sub-message is specified in the last position of the field mask for an
+ update operation, then new value will be merged into the existing sub-message
+ in the target resource.
+
+ For example, given the target message:
+
+ f {
+ b {
+ d: 1
+ x: 2
+ }
+ c: [1]
+ }
+
+ And an update message:
+
+ f {
+ b {
+ d: 10
+ }
+ c: [2]
+ }
+
+ then if the field mask is:
+
+ paths: ["f.b", "f.c"]
+
+ then the result will be:
+
+ f {
+ b {
+ d: 10
+ x: 2
+ }
+ c: [1, 2]
+ }
+
+ An implementation may provide options to override this default behavior for
+ repeated and message fields.
+
+ In order to reset a field's value to the default, the field must
+ be in the mask and set to the default value in the provided resource.
+ Hence, in order to reset all fields of a resource, provide a default
+ instance of the resource and set all fields in the mask, or do
+ not provide a mask as described below.
+
+ If a field mask is not present on update, the operation applies to
+ all fields (as if a field mask of all fields has been specified).
+ Note that in the presence of schema evolution, this may mean that
+ fields the client does not know and has therefore not filled into
+ the request will be reset to their default. If this is unwanted
+ behavior, a specific service may require a client to always specify
+ a field mask, producing an error if not.
+
+ As with get operations, the location of the resource which
+ describes the updated values in the request message depends on the
+ operation kind. In any case, the effect of the field mask is
+ required to be honored by the API.
+
+ ## Considerations for HTTP REST
+
+ The HTTP kind of an update operation which uses a field mask must
+ be set to PATCH instead of PUT in order to satisfy HTTP semantics
+ (PUT must only be used for full updates).
+
+ # JSON Encoding of Field Masks
+
+ In JSON, a field mask is encoded as a single string where paths are
+ separated by a comma. Fields name in each path are converted
+ to/from lower-camel naming conventions.
+
+ As an example, consider the following message declarations:
+
+ message Profile {
+ User user = 1;
+ Photo photo = 2;
+ }
+ message User {
+ string display_name = 1;
+ string address = 2;
+ }
+
+ In proto a field mask for `Profile` may look as such:
+
+ mask {
+ paths: "user.display_name"
+ paths: "photo"
+ }
+
+ In JSON, the same mask is represented as below:
+
+ {
+ mask: "user.displayName,photo"
+ }
+
+ # Field Masks and Oneof Fields
+
+ Field masks treat fields in oneofs just as regular fields. Consider the
+ following message:
+
+ message SampleMessage {
+ oneof test_oneof {
+ string name = 4;
+ SubMessage sub_message = 9;
+ }
+ }
+
+ The field mask can be:
+
+ mask {
+ paths: "name"
+ }
+
+ Or:
+
+ mask {
+ paths: "sub_message"
+ }
+
+ Note that oneof type names ("test_oneof" in this case) cannot be used in
+ paths.
+
+ ## Field Mask Verification
+
+ The implementation of any API method which has a FieldMask type field in the
+ request should verify the included field paths, and return an
+ `INVALID_ARGUMENT` error if any path is unmappable.
- name: allowMissing
in: query
description: |-
@@ -8823,15 +12171,211 @@ paths:
required: true
schema:
type: string
- - name: updateMask.paths
+ - name: updateMask
in: query
- description: The set of field mask paths.
+ description: The list of fields to update.
schema:
- type: array
- items:
- type: string
- title: paths
- description: The set of field mask paths.
+ type: string
+ description: |-
+ `FieldMask` represents a set of symbolic field paths, for example:
+
+ paths: "f.a"
+ paths: "f.b.d"
+
+ Here `f` represents a field in some root message, `a` and `b`
+ fields in the message found in `f`, and `d` a field found in the
+ message in `f.b`.
+
+ Field masks are used to specify a subset of fields that should be
+ returned by a get operation or modified by an update operation.
+ Field masks also have a custom JSON encoding (see below).
+
+ # Field Masks in Projections
+
+ When used in the context of a projection, a response message or
+ sub-message is filtered by the API to only contain those fields as
+ specified in the mask. For example, if the mask in the previous
+ example is applied to a response message as follows:
+
+ f {
+ a : 22
+ b {
+ d : 1
+ x : 2
+ }
+ y : 13
+ }
+ z: 8
+
+ The result will not contain specific values for fields x,y and z
+ (their value will be set to the default, and omitted in proto text
+ output):
+
+
+ f {
+ a : 22
+ b {
+ d : 1
+ }
+ }
+
+ A repeated field is not allowed except at the last position of a
+ paths string.
+
+ If a FieldMask object is not present in a get operation, the
+ operation applies to all fields (as if a FieldMask of all fields
+ had been specified).
+
+ Note that a field mask does not necessarily apply to the
+ top-level response message. In case of a REST get operation, the
+ field mask applies directly to the response, but in case of a REST
+ list operation, the mask instead applies to each individual message
+ in the returned resource list. In case of a REST custom method,
+ other definitions may be used. Where the mask applies will be
+ clearly documented together with its declaration in the API. In
+ any case, the effect on the returned resource/resources is required
+ behavior for APIs.
+
+ # Field Masks in Update Operations
+
+ A field mask in update operations specifies which fields of the
+ targeted resource are going to be updated. The API is required
+ to only change the values of the fields as specified in the mask
+ and leave the others untouched. If a resource is passed in to
+ describe the updated values, the API ignores the values of all
+ fields not covered by the mask.
+
+ If a repeated field is specified for an update operation, new values will
+ be appended to the existing repeated field in the target resource. Note that
+ a repeated field is only allowed in the last position of a `paths` string.
+
+ If a sub-message is specified in the last position of the field mask for an
+ update operation, then new value will be merged into the existing sub-message
+ in the target resource.
+
+ For example, given the target message:
+
+ f {
+ b {
+ d: 1
+ x: 2
+ }
+ c: [1]
+ }
+
+ And an update message:
+
+ f {
+ b {
+ d: 10
+ }
+ c: [2]
+ }
+
+ then if the field mask is:
+
+ paths: ["f.b", "f.c"]
+
+ then the result will be:
+
+ f {
+ b {
+ d: 10
+ x: 2
+ }
+ c: [1, 2]
+ }
+
+ An implementation may provide options to override this default behavior for
+ repeated and message fields.
+
+ In order to reset a field's value to the default, the field must
+ be in the mask and set to the default value in the provided resource.
+ Hence, in order to reset all fields of a resource, provide a default
+ instance of the resource and set all fields in the mask, or do
+ not provide a mask as described below.
+
+ If a field mask is not present on update, the operation applies to
+ all fields (as if a field mask of all fields has been specified).
+ Note that in the presence of schema evolution, this may mean that
+ fields the client does not know and has therefore not filled into
+ the request will be reset to their default. If this is unwanted
+ behavior, a specific service may require a client to always specify
+ a field mask, producing an error if not.
+
+ As with get operations, the location of the resource which
+ describes the updated values in the request message depends on the
+ operation kind. In any case, the effect of the field mask is
+ required to be honored by the API.
+
+ ## Considerations for HTTP REST
+
+ The HTTP kind of an update operation which uses a field mask must
+ be set to PATCH instead of PUT in order to satisfy HTTP semantics
+ (PUT must only be used for full updates).
+
+ # JSON Encoding of Field Masks
+
+ In JSON, a field mask is encoded as a single string where paths are
+ separated by a comma. Fields name in each path are converted
+ to/from lower-camel naming conventions.
+
+ As an example, consider the following message declarations:
+
+ message Profile {
+ User user = 1;
+ Photo photo = 2;
+ }
+ message User {
+ string display_name = 1;
+ string address = 2;
+ }
+
+ In proto a field mask for `Profile` may look as such:
+
+ mask {
+ paths: "user.display_name"
+ paths: "photo"
+ }
+
+ In JSON, the same mask is represented as below:
+
+ {
+ mask: "user.displayName,photo"
+ }
+
+ # Field Masks and Oneof Fields
+
+ Field masks treat fields in oneofs just as regular fields. Consider the
+ following message:
+
+ message SampleMessage {
+ oneof test_oneof {
+ string name = 4;
+ SubMessage sub_message = 9;
+ }
+ }
+
+ The field mask can be:
+
+ mask {
+ paths: "name"
+ }
+
+ Or:
+
+ mask {
+ paths: "sub_message"
+ }
+
+ Note that oneof type names ("test_oneof" in this case) cannot be used in
+ paths.
+
+ ## Field Mask Verification
+
+ The implementation of any API method which has a FieldMask type field in the
+ request should verify the included field paths, and return an
+ `INVALID_ARGUMENT` error if any path is unmappable.
- name: allowMissing
in: query
description: |-
@@ -8983,15 +12527,211 @@ paths:
required: true
schema:
type: string
- - name: updateMask.paths
+ - name: updateMask
in: query
- description: The set of field mask paths.
+ description: The list of fields to update.
schema:
- type: array
- items:
- type: string
- title: paths
- description: The set of field mask paths.
+ type: string
+ description: |-
+ `FieldMask` represents a set of symbolic field paths, for example:
+
+ paths: "f.a"
+ paths: "f.b.d"
+
+ Here `f` represents a field in some root message, `a` and `b`
+ fields in the message found in `f`, and `d` a field found in the
+ message in `f.b`.
+
+ Field masks are used to specify a subset of fields that should be
+ returned by a get operation or modified by an update operation.
+ Field masks also have a custom JSON encoding (see below).
+
+ # Field Masks in Projections
+
+ When used in the context of a projection, a response message or
+ sub-message is filtered by the API to only contain those fields as
+ specified in the mask. For example, if the mask in the previous
+ example is applied to a response message as follows:
+
+ f {
+ a : 22
+ b {
+ d : 1
+ x : 2
+ }
+ y : 13
+ }
+ z: 8
+
+ The result will not contain specific values for fields x,y and z
+ (their value will be set to the default, and omitted in proto text
+ output):
+
+
+ f {
+ a : 22
+ b {
+ d : 1
+ }
+ }
+
+ A repeated field is not allowed except at the last position of a
+ paths string.
+
+ If a FieldMask object is not present in a get operation, the
+ operation applies to all fields (as if a FieldMask of all fields
+ had been specified).
+
+ Note that a field mask does not necessarily apply to the
+ top-level response message. In case of a REST get operation, the
+ field mask applies directly to the response, but in case of a REST
+ list operation, the mask instead applies to each individual message
+ in the returned resource list. In case of a REST custom method,
+ other definitions may be used. Where the mask applies will be
+ clearly documented together with its declaration in the API. In
+ any case, the effect on the returned resource/resources is required
+ behavior for APIs.
+
+ # Field Masks in Update Operations
+
+ A field mask in update operations specifies which fields of the
+ targeted resource are going to be updated. The API is required
+ to only change the values of the fields as specified in the mask
+ and leave the others untouched. If a resource is passed in to
+ describe the updated values, the API ignores the values of all
+ fields not covered by the mask.
+
+ If a repeated field is specified for an update operation, new values will
+ be appended to the existing repeated field in the target resource. Note that
+ a repeated field is only allowed in the last position of a `paths` string.
+
+ If a sub-message is specified in the last position of the field mask for an
+ update operation, then new value will be merged into the existing sub-message
+ in the target resource.
+
+ For example, given the target message:
+
+ f {
+ b {
+ d: 1
+ x: 2
+ }
+ c: [1]
+ }
+
+ And an update message:
+
+ f {
+ b {
+ d: 10
+ }
+ c: [2]
+ }
+
+ then if the field mask is:
+
+ paths: ["f.b", "f.c"]
+
+ then the result will be:
+
+ f {
+ b {
+ d: 10
+ x: 2
+ }
+ c: [1, 2]
+ }
+
+ An implementation may provide options to override this default behavior for
+ repeated and message fields.
+
+ In order to reset a field's value to the default, the field must
+ be in the mask and set to the default value in the provided resource.
+ Hence, in order to reset all fields of a resource, provide a default
+ instance of the resource and set all fields in the mask, or do
+ not provide a mask as described below.
+
+ If a field mask is not present on update, the operation applies to
+ all fields (as if a field mask of all fields has been specified).
+ Note that in the presence of schema evolution, this may mean that
+ fields the client does not know and has therefore not filled into
+ the request will be reset to their default. If this is unwanted
+ behavior, a specific service may require a client to always specify
+ a field mask, producing an error if not.
+
+ As with get operations, the location of the resource which
+ describes the updated values in the request message depends on the
+ operation kind. In any case, the effect of the field mask is
+ required to be honored by the API.
+
+ ## Considerations for HTTP REST
+
+ The HTTP kind of an update operation which uses a field mask must
+ be set to PATCH instead of PUT in order to satisfy HTTP semantics
+ (PUT must only be used for full updates).
+
+ # JSON Encoding of Field Masks
+
+ In JSON, a field mask is encoded as a single string where paths are
+ separated by a comma. Fields name in each path are converted
+ to/from lower-camel naming conventions.
+
+ As an example, consider the following message declarations:
+
+ message Profile {
+ User user = 1;
+ Photo photo = 2;
+ }
+ message User {
+ string display_name = 1;
+ string address = 2;
+ }
+
+ In proto a field mask for `Profile` may look as such:
+
+ mask {
+ paths: "user.display_name"
+ paths: "photo"
+ }
+
+ In JSON, the same mask is represented as below:
+
+ {
+ mask: "user.displayName,photo"
+ }
+
+ # Field Masks and Oneof Fields
+
+ Field masks treat fields in oneofs just as regular fields. Consider the
+ following message:
+
+ message SampleMessage {
+ oneof test_oneof {
+ string name = 4;
+ SubMessage sub_message = 9;
+ }
+ }
+
+ The field mask can be:
+
+ mask {
+ paths: "name"
+ }
+
+ Or:
+
+ mask {
+ paths: "sub_message"
+ }
+
+ Note that oneof type names ("test_oneof" in this case) cannot be used in
+ paths.
+
+ ## Field Mask Verification
+
+ The implementation of any API method which has a FieldMask type field in the
+ request should verify the included field paths, and return an
+ `INVALID_ARGUMENT` error if any path is unmappable.
- name: allowMissing
in: query
description: |-
@@ -9100,15 +12840,213 @@ paths:
required: true
schema:
type: string
- - name: updateMask.paths
+ - name: updateMask
in: query
- description: The set of field mask paths.
+ description: |-
+ The list of fields to update.
+ Supported fields: title, service_key (triggers key rotation)
schema:
- type: array
- items:
- type: string
- title: paths
- description: The set of field mask paths.
+ type: string
+ description: |-
+ `FieldMask` represents a set of symbolic field paths, for example:
+
+ paths: "f.a"
+ paths: "f.b.d"
+
+ Here `f` represents a field in some root message, `a` and `b`
+ fields in the message found in `f`, and `d` a field found in the
+ message in `f.b`.
+
+ Field masks are used to specify a subset of fields that should be
+ returned by a get operation or modified by an update operation.
+ Field masks also have a custom JSON encoding (see below).
+
+ # Field Masks in Projections
+
+ When used in the context of a projection, a response message or
+ sub-message is filtered by the API to only contain those fields as
+ specified in the mask. For example, if the mask in the previous
+ example is applied to a response message as follows:
+
+ f {
+ a : 22
+ b {
+ d : 1
+ x : 2
+ }
+ y : 13
+ }
+ z: 8
+
+ The result will not contain specific values for fields x,y and z
+ (their value will be set to the default, and omitted in proto text
+ output):
+
+
+ f {
+ a : 22
+ b {
+ d : 1
+ }
+ }
+
+ A repeated field is not allowed except at the last position of a
+ paths string.
+
+ If a FieldMask object is not present in a get operation, the
+ operation applies to all fields (as if a FieldMask of all fields
+ had been specified).
+
+ Note that a field mask does not necessarily apply to the
+ top-level response message. In case of a REST get operation, the
+ field mask applies directly to the response, but in case of a REST
+ list operation, the mask instead applies to each individual message
+ in the returned resource list. In case of a REST custom method,
+ other definitions may be used. Where the mask applies will be
+ clearly documented together with its declaration in the API. In
+ any case, the effect on the returned resource/resources is required
+ behavior for APIs.
+
+ # Field Masks in Update Operations
+
+ A field mask in update operations specifies which fields of the
+ targeted resource are going to be updated. The API is required
+ to only change the values of the fields as specified in the mask
+ and leave the others untouched. If a resource is passed in to
+ describe the updated values, the API ignores the values of all
+ fields not covered by the mask.
+
+ If a repeated field is specified for an update operation, new values will
+ be appended to the existing repeated field in the target resource. Note that
+ a repeated field is only allowed in the last position of a `paths` string.
+
+ If a sub-message is specified in the last position of the field mask for an
+ update operation, then new value will be merged into the existing sub-message
+ in the target resource.
+
+ For example, given the target message:
+
+ f {
+ b {
+ d: 1
+ x: 2
+ }
+ c: [1]
+ }
+
+ And an update message:
+
+ f {
+ b {
+ d: 10
+ }
+ c: [2]
+ }
+
+ then if the field mask is:
+
+ paths: ["f.b", "f.c"]
+
+ then the result will be:
+
+ f {
+ b {
+ d: 10
+ x: 2
+ }
+ c: [1, 2]
+ }
+
+ An implementation may provide options to override this default behavior for
+ repeated and message fields.
+
+ In order to reset a field's value to the default, the field must
+ be in the mask and set to the default value in the provided resource.
+ Hence, in order to reset all fields of a resource, provide a default
+ instance of the resource and set all fields in the mask, or do
+ not provide a mask as described below.
+
+ If a field mask is not present on update, the operation applies to
+ all fields (as if a field mask of all fields has been specified).
+ Note that in the presence of schema evolution, this may mean that
+ fields the client does not know and has therefore not filled into
+ the request will be reset to their default. If this is unwanted
+ behavior, a specific service may require a client to always specify
+ a field mask, producing an error if not.
+
+ As with get operations, the location of the resource which
+ describes the updated values in the request message depends on the
+ operation kind. In any case, the effect of the field mask is
+ required to be honored by the API.
+
+ ## Considerations for HTTP REST
+
+ The HTTP kind of an update operation which uses a field mask must
+ be set to PATCH instead of PUT in order to satisfy HTTP semantics
+ (PUT must only be used for full updates).
+
+ # JSON Encoding of Field Masks
+
+ In JSON, a field mask is encoded as a single string where paths are
+ separated by a comma. Fields name in each path are converted
+ to/from lower-camel naming conventions.
+
+ As an example, consider the following message declarations:
+
+ message Profile {
+ User user = 1;
+ Photo photo = 2;
+ }
+ message User {
+ string display_name = 1;
+ string address = 2;
+ }
+
+ In proto a field mask for `Profile` may look as such:
+
+ mask {
+ paths: "user.display_name"
+ paths: "photo"
+ }
+
+ In JSON, the same mask is represented as below:
+
+ {
+ mask: "user.displayName,photo"
+ }
+
+ # Field Masks and Oneof Fields
+
+ Field masks treat fields in oneofs just as regular fields. Consider the
+ following message:
+
+ message SampleMessage {
+ oneof test_oneof {
+ string name = 4;
+ SubMessage sub_message = 9;
+ }
+ }
+
+ The field mask can be:
+
+ mask {
+ paths: "name"
+ }
+
+ Or:
+
+ mask {
+ paths: "sub_message"
+ }
+
+ Note that oneof type names ("test_oneof" in this case) cannot be used in
+ paths.
+
+ ## Field Mask Verification
+
+ The implementation of any API method which has a FieldMask type field in the
+ request should verify the included field paths, and return an
+ `INVALID_ARGUMENT` error if any path is unmappable.
requestBody:
description: |-
The service account to update.
@@ -9225,15 +13163,210 @@ paths:
schema:
type: boolean
title: allow_missing
- - name: updateMask.paths
+ - name: updateMask
in: query
- description: The set of field mask paths.
schema:
- type: array
- items:
- type: string
- title: paths
- description: The set of field mask paths.
+ type: string
+ description: |-
+ `FieldMask` represents a set of symbolic field paths, for example:
+
+ paths: "f.a"
+ paths: "f.b.d"
+
+ Here `f` represents a field in some root message, `a` and `b`
+ fields in the message found in `f`, and `d` a field found in the
+ message in `f.b`.
+
+ Field masks are used to specify a subset of fields that should be
+ returned by a get operation or modified by an update operation.
+ Field masks also have a custom JSON encoding (see below).
+
+ # Field Masks in Projections
+
+ When used in the context of a projection, a response message or
+ sub-message is filtered by the API to only contain those fields as
+ specified in the mask. For example, if the mask in the previous
+ example is applied to a response message as follows:
+
+ f {
+ a : 22
+ b {
+ d : 1
+ x : 2
+ }
+ y : 13
+ }
+ z: 8
+
+ The result will not contain specific values for fields x,y and z
+ (their value will be set to the default, and omitted in proto text
+ output):
+
+
+ f {
+ a : 22
+ b {
+ d : 1
+ }
+ }
+
+ A repeated field is not allowed except at the last position of a
+ paths string.
+
+ If a FieldMask object is not present in a get operation, the
+ operation applies to all fields (as if a FieldMask of all fields
+ had been specified).
+
+ Note that a field mask does not necessarily apply to the
+ top-level response message. In case of a REST get operation, the
+ field mask applies directly to the response, but in case of a REST
+ list operation, the mask instead applies to each individual message
+ in the returned resource list. In case of a REST custom method,
+ other definitions may be used. Where the mask applies will be
+ clearly documented together with its declaration in the API. In
+ any case, the effect on the returned resource/resources is required
+ behavior for APIs.
+
+ # Field Masks in Update Operations
+
+ A field mask in update operations specifies which fields of the
+ targeted resource are going to be updated. The API is required
+ to only change the values of the fields as specified in the mask
+ and leave the others untouched. If a resource is passed in to
+ describe the updated values, the API ignores the values of all
+ fields not covered by the mask.
+
+ If a repeated field is specified for an update operation, new values will
+ be appended to the existing repeated field in the target resource. Note that
+ a repeated field is only allowed in the last position of a `paths` string.
+
+ If a sub-message is specified in the last position of the field mask for an
+ update operation, then new value will be merged into the existing sub-message
+ in the target resource.
+
+ For example, given the target message:
+
+ f {
+ b {
+ d: 1
+ x: 2
+ }
+ c: [1]
+ }
+
+ And an update message:
+
+ f {
+ b {
+ d: 10
+ }
+ c: [2]
+ }
+
+ then if the field mask is:
+
+ paths: ["f.b", "f.c"]
+
+ then the result will be:
+
+ f {
+ b {
+ d: 10
+ x: 2
+ }
+ c: [1, 2]
+ }
+
+ An implementation may provide options to override this default behavior for
+ repeated and message fields.
+
+ In order to reset a field's value to the default, the field must
+ be in the mask and set to the default value in the provided resource.
+ Hence, in order to reset all fields of a resource, provide a default
+ instance of the resource and set all fields in the mask, or do
+ not provide a mask as described below.
+
+ If a field mask is not present on update, the operation applies to
+ all fields (as if a field mask of all fields has been specified).
+ Note that in the presence of schema evolution, this may mean that
+ fields the client does not know and has therefore not filled into
+ the request will be reset to their default. If this is unwanted
+ behavior, a specific service may require a client to always specify
+ a field mask, producing an error if not.
+
+ As with get operations, the location of the resource which
+ describes the updated values in the request message depends on the
+ operation kind. In any case, the effect of the field mask is
+ required to be honored by the API.
+
+ ## Considerations for HTTP REST
+
+ The HTTP kind of an update operation which uses a field mask must
+ be set to PATCH instead of PUT in order to satisfy HTTP semantics
+ (PUT must only be used for full updates).
+
+ # JSON Encoding of Field Masks
+
+ In JSON, a field mask is encoded as a single string where paths are
+ separated by a comma. Fields name in each path are converted
+ to/from lower-camel naming conventions.
+
+ As an example, consider the following message declarations:
+
+ message Profile {
+ User user = 1;
+ Photo photo = 2;
+ }
+ message User {
+ string display_name = 1;
+ string address = 2;
+ }
+
+ In proto a field mask for `Profile` may look as such:
+
+ mask {
+ paths: "user.display_name"
+ paths: "photo"
+ }
+
+ In JSON, the same mask is represented as below:
+
+ {
+ mask: "user.displayName,photo"
+ }
+
+ # Field Masks and Oneof Fields
+
+ Field masks treat fields in oneofs just as regular fields. Consider the
+ following message:
+
+ message SampleMessage {
+ oneof test_oneof {
+ string name = 4;
+ SubMessage sub_message = 9;
+ }
+ }
+
+ The field mask can be:
+
+ mask {
+ paths: "name"
+ }
+
+ Or:
+
+ mask {
+ paths: "sub_message"
+ }
+
+ Note that oneof type names ("test_oneof" in this case) cannot be used in
+ paths.
+
+ ## Field Mask Verification
+
+ The implementation of any API method which has a FieldMask type field in the
+ request should verify the included field paths, and return an
+ `INVALID_ARGUMENT` error if any path is unmappable.
requestBody:
description: The setting to update.
content:
@@ -9532,15 +13665,211 @@ paths:
required: true
schema:
type: string
- - name: updateMask.paths
+ - name: updateMask
in: query
- description: The set of field mask paths.
+ description: The list of fields to update.
schema:
- type: array
- items:
- type: string
- title: paths
- description: The set of field mask paths.
+ type: string
+ description: |-
+ `FieldMask` represents a set of symbolic field paths, for example:
+
+ paths: "f.a"
+ paths: "f.b.d"
+
+ Here `f` represents a field in some root message, `a` and `b`
+ fields in the message found in `f`, and `d` a field found in the
+ message in `f.b`.
+
+ Field masks are used to specify a subset of fields that should be
+ returned by a get operation or modified by an update operation.
+ Field masks also have a custom JSON encoding (see below).
+
+ # Field Masks in Projections
+
+ When used in the context of a projection, a response message or
+ sub-message is filtered by the API to only contain those fields as
+ specified in the mask. For example, if the mask in the previous
+ example is applied to a response message as follows:
+
+ f {
+ a : 22
+ b {
+ d : 1
+ x : 2
+ }
+ y : 13
+ }
+ z: 8
+
+ The result will not contain specific values for fields x,y and z
+ (their value will be set to the default, and omitted in proto text
+ output):
+
+
+ f {
+ a : 22
+ b {
+ d : 1
+ }
+ }
+
+ A repeated field is not allowed except at the last position of a
+ paths string.
+
+ If a FieldMask object is not present in a get operation, the
+ operation applies to all fields (as if a FieldMask of all fields
+ had been specified).
+
+ Note that a field mask does not necessarily apply to the
+ top-level response message. In case of a REST get operation, the
+ field mask applies directly to the response, but in case of a REST
+ list operation, the mask instead applies to each individual message
+ in the returned resource list. In case of a REST custom method,
+ other definitions may be used. Where the mask applies will be
+ clearly documented together with its declaration in the API. In
+ any case, the effect on the returned resource/resources is required
+ behavior for APIs.
+
+ # Field Masks in Update Operations
+
+ A field mask in update operations specifies which fields of the
+ targeted resource are going to be updated. The API is required
+ to only change the values of the fields as specified in the mask
+ and leave the others untouched. If a resource is passed in to
+ describe the updated values, the API ignores the values of all
+ fields not covered by the mask.
+
+ If a repeated field is specified for an update operation, new values will
+ be appended to the existing repeated field in the target resource. Note that
+ a repeated field is only allowed in the last position of a `paths` string.
+
+ If a sub-message is specified in the last position of the field mask for an
+ update operation, then new value will be merged into the existing sub-message
+ in the target resource.
+
+ For example, given the target message:
+
+ f {
+ b {
+ d: 1
+ x: 2
+ }
+ c: [1]
+ }
+
+ And an update message:
+
+ f {
+ b {
+ d: 10
+ }
+ c: [2]
+ }
+
+ then if the field mask is:
+
+ paths: ["f.b", "f.c"]
+
+ then the result will be:
+
+ f {
+ b {
+ d: 10
+ x: 2
+ }
+ c: [1, 2]
+ }
+
+ An implementation may provide options to override this default behavior for
+ repeated and message fields.
+
+ In order to reset a field's value to the default, the field must
+ be in the mask and set to the default value in the provided resource.
+ Hence, in order to reset all fields of a resource, provide a default
+ instance of the resource and set all fields in the mask, or do
+ not provide a mask as described below.
+
+ If a field mask is not present on update, the operation applies to
+ all fields (as if a field mask of all fields has been specified).
+ Note that in the presence of schema evolution, this may mean that
+ fields the client does not know and has therefore not filled into
+ the request will be reset to their default. If this is unwanted
+ behavior, a specific service may require a client to always specify
+ a field mask, producing an error if not.
+
+ As with get operations, the location of the resource which
+ describes the updated values in the request message depends on the
+ operation kind. In any case, the effect of the field mask is
+ required to be honored by the API.
+
+ ## Considerations for HTTP REST
+
+ The HTTP kind of an update operation which uses a field mask must
+ be set to PATCH instead of PUT in order to satisfy HTTP semantics
+ (PUT must only be used for full updates).
+
+ # JSON Encoding of Field Masks
+
+ In JSON, a field mask is encoded as a single string where paths are
+ separated by a comma. Fields name in each path are converted
+ to/from lower-camel naming conventions.
+
+ As an example, consider the following message declarations:
+
+ message Profile {
+ User user = 1;
+ Photo photo = 2;
+ }
+ message User {
+ string display_name = 1;
+ string address = 2;
+ }
+
+ In proto a field mask for `Profile` may look as such:
+
+ mask {
+ paths: "user.display_name"
+ paths: "photo"
+ }
+
+ In JSON, the same mask is represented as below:
+
+ {
+ mask: "user.displayName,photo"
+ }
+
+ # Field Masks and Oneof Fields
+
+ Field masks treat fields in oneofs just as regular fields. Consider the
+ following message:
+
+ message SampleMessage {
+ oneof test_oneof {
+ string name = 4;
+ SubMessage sub_message = 9;
+ }
+ }
+
+ The field mask can be:
+
+ mask {
+ paths: "name"
+ }
+
+ Or:
+
+ mask {
+ paths: "sub_message"
+ }
+
+ Note that oneof type names ("test_oneof" in this case) cannot be used in
+ paths.
+
+ ## Field Mask Verification
+
+ The implementation of any API method which has a FieldMask type field in the
+ request should verify the included field paths, and return an
+ `INVALID_ARGUMENT` error if any path is unmappable.
- name: otpCode
in: query
description: The otp_code is used to verify the user's identity by MFA.
@@ -9753,15 +14082,213 @@ paths:
required: true
schema:
type: string
- - name: updateMask.paths
+ - name: updateMask
in: query
- description: The set of field mask paths.
+ description: |-
+ The list of fields to update.
+ Supported fields: title, workload_identity_config
schema:
- type: array
- items:
- type: string
- title: paths
- description: The set of field mask paths.
+ type: string
+ description: |-
+ `FieldMask` represents a set of symbolic field paths, for example:
+
+ paths: "f.a"
+ paths: "f.b.d"
+
+ Here `f` represents a field in some root message, `a` and `b`
+ fields in the message found in `f`, and `d` a field found in the
+ message in `f.b`.
+
+ Field masks are used to specify a subset of fields that should be
+ returned by a get operation or modified by an update operation.
+ Field masks also have a custom JSON encoding (see below).
+
+ # Field Masks in Projections
+
+ When used in the context of a projection, a response message or
+ sub-message is filtered by the API to only contain those fields as
+ specified in the mask. For example, if the mask in the previous
+ example is applied to a response message as follows:
+
+ f {
+ a : 22
+ b {
+ d : 1
+ x : 2
+ }
+ y : 13
+ }
+ z: 8
+
+ The result will not contain specific values for fields x,y and z
+ (their value will be set to the default, and omitted in proto text
+ output):
+
+
+ f {
+ a : 22
+ b {
+ d : 1
+ }
+ }
+
+ A repeated field is not allowed except at the last position of a
+ paths string.
+
+ If a FieldMask object is not present in a get operation, the
+ operation applies to all fields (as if a FieldMask of all fields
+ had been specified).
+
+ Note that a field mask does not necessarily apply to the
+ top-level response message. In case of a REST get operation, the
+ field mask applies directly to the response, but in case of a REST
+ list operation, the mask instead applies to each individual message
+ in the returned resource list. In case of a REST custom method,
+ other definitions may be used. Where the mask applies will be
+ clearly documented together with its declaration in the API. In
+ any case, the effect on the returned resource/resources is required
+ behavior for APIs.
+
+ # Field Masks in Update Operations
+
+ A field mask in update operations specifies which fields of the
+ targeted resource are going to be updated. The API is required
+ to only change the values of the fields as specified in the mask
+ and leave the others untouched. If a resource is passed in to
+ describe the updated values, the API ignores the values of all
+ fields not covered by the mask.
+
+ If a repeated field is specified for an update operation, new values will
+ be appended to the existing repeated field in the target resource. Note that
+ a repeated field is only allowed in the last position of a `paths` string.
+
+ If a sub-message is specified in the last position of the field mask for an
+ update operation, then new value will be merged into the existing sub-message
+ in the target resource.
+
+ For example, given the target message:
+
+ f {
+ b {
+ d: 1
+ x: 2
+ }
+ c: [1]
+ }
+
+ And an update message:
+
+ f {
+ b {
+ d: 10
+ }
+ c: [2]
+ }
+
+ then if the field mask is:
+
+ paths: ["f.b", "f.c"]
+
+ then the result will be:
+
+ f {
+ b {
+ d: 10
+ x: 2
+ }
+ c: [1, 2]
+ }
+
+ An implementation may provide options to override this default behavior for
+ repeated and message fields.
+
+ In order to reset a field's value to the default, the field must
+ be in the mask and set to the default value in the provided resource.
+ Hence, in order to reset all fields of a resource, provide a default
+ instance of the resource and set all fields in the mask, or do
+ not provide a mask as described below.
+
+ If a field mask is not present on update, the operation applies to
+ all fields (as if a field mask of all fields has been specified).
+ Note that in the presence of schema evolution, this may mean that
+ fields the client does not know and has therefore not filled into
+ the request will be reset to their default. If this is unwanted
+ behavior, a specific service may require a client to always specify
+ a field mask, producing an error if not.
+
+ As with get operations, the location of the resource which
+ describes the updated values in the request message depends on the
+ operation kind. In any case, the effect of the field mask is
+ required to be honored by the API.
+
+ ## Considerations for HTTP REST
+
+ The HTTP kind of an update operation which uses a field mask must
+ be set to PATCH instead of PUT in order to satisfy HTTP semantics
+ (PUT must only be used for full updates).
+
+ # JSON Encoding of Field Masks
+
+ In JSON, a field mask is encoded as a single string where paths are
+ separated by a comma. Fields name in each path are converted
+ to/from lower-camel naming conventions.
+
+ As an example, consider the following message declarations:
+
+ message Profile {
+ User user = 1;
+ Photo photo = 2;
+ }
+ message User {
+ string display_name = 1;
+ string address = 2;
+ }
+
+ In proto a field mask for `Profile` may look as such:
+
+ mask {
+ paths: "user.display_name"
+ paths: "photo"
+ }
+
+ In JSON, the same mask is represented as below:
+
+ {
+ mask: "user.displayName,photo"
+ }
+
+ # Field Masks and Oneof Fields
+
+ Field masks treat fields in oneofs just as regular fields. Consider the
+ following message:
+
+ message SampleMessage {
+ oneof test_oneof {
+ string name = 4;
+ SubMessage sub_message = 9;
+ }
+ }
+
+ The field mask can be:
+
+ mask {
+ paths: "name"
+ }
+
+ Or:
+
+ mask {
+ paths: "sub_message"
+ }
+
+ Note that oneof type names ("test_oneof" in this case) cannot be used in
+ paths.
+
+ ## Field Mask Verification
+
+ The implementation of any API method which has a FieldMask type field in the
+ request should verify the included field paths, and return an
+ `INVALID_ARGUMENT` error if any path is unmappable.
requestBody:
description: |-
The workload identity to update.
@@ -9924,15 +14451,219 @@ paths:
required: true
schema:
type: string
- - name: updateMask.paths
+ - name: updateMask
in: query
- description: The set of field mask paths.
+ description: |-
+ The list of fields to be updated.
+ Fields are specified relative to the worksheet.
+ (e.g., `title`, `statement`; *not* `worksheet.title` or `worksheet.statement`)
+ Only support update the following fields for now:
+ - `title`
+ - `statement`
+ - `starred`
+ - `visibility`
schema:
- type: array
- items:
- type: string
- title: paths
- description: The set of field mask paths.
+ type: string
+ description: |-
+ `FieldMask` represents a set of symbolic field paths, for example:
+
+ paths: "f.a"
+ paths: "f.b.d"
+
+ Here `f` represents a field in some root message, `a` and `b`
+ fields in the message found in `f`, and `d` a field found in the
+ message in `f.b`.
+
+ Field masks are used to specify a subset of fields that should be
+ returned by a get operation or modified by an update operation.
+ Field masks also have a custom JSON encoding (see below).
+
+ # Field Masks in Projections
+
+ When used in the context of a projection, a response message or
+ sub-message is filtered by the API to only contain those fields as
+ specified in the mask. For example, if the mask in the previous
+ example is applied to a response message as follows:
+
+ f {
+ a : 22
+ b {
+ d : 1
+ x : 2
+ }
+ y : 13
+ }
+ z: 8
+
+ The result will not contain specific values for fields x,y and z
+ (their value will be set to the default, and omitted in proto text
+ output):
+
+
+ f {
+ a : 22
+ b {
+ d : 1
+ }
+ }
+
+ A repeated field is not allowed except at the last position of a
+ paths string.
+
+ If a FieldMask object is not present in a get operation, the
+ operation applies to all fields (as if a FieldMask of all fields
+ had been specified).
+
+ Note that a field mask does not necessarily apply to the
+ top-level response message. In case of a REST get operation, the
+ field mask applies directly to the response, but in case of a REST
+ list operation, the mask instead applies to each individual message
+ in the returned resource list. In case of a REST custom method,
+ other definitions may be used. Where the mask applies will be
+ clearly documented together with its declaration in the API. In
+ any case, the effect on the returned resource/resources is required
+ behavior for APIs.
+
+ # Field Masks in Update Operations
+
+ A field mask in update operations specifies which fields of the
+ targeted resource are going to be updated. The API is required
+ to only change the values of the fields as specified in the mask
+ and leave the others untouched. If a resource is passed in to
+ describe the updated values, the API ignores the values of all
+ fields not covered by the mask.
+
+ If a repeated field is specified for an update operation, new values will
+ be appended to the existing repeated field in the target resource. Note that
+ a repeated field is only allowed in the last position of a `paths` string.
+
+ If a sub-message is specified in the last position of the field mask for an
+ update operation, then new value will be merged into the existing sub-message
+ in the target resource.
+
+ For example, given the target message:
+
+ f {
+ b {
+ d: 1
+ x: 2
+ }
+ c: [1]
+ }
+
+ And an update message:
+
+ f {
+ b {
+ d: 10
+ }
+ c: [2]
+ }
+
+ then if the field mask is:
+
+ paths: ["f.b", "f.c"]
+
+ then the result will be:
+
+ f {
+ b {
+ d: 10
+ x: 2
+ }
+ c: [1, 2]
+ }
+
+ An implementation may provide options to override this default behavior for
+ repeated and message fields.
+
+ In order to reset a field's value to the default, the field must
+ be in the mask and set to the default value in the provided resource.
+ Hence, in order to reset all fields of a resource, provide a default
+ instance of the resource and set all fields in the mask, or do
+ not provide a mask as described below.
+
+ If a field mask is not present on update, the operation applies to
+ all fields (as if a field mask of all fields has been specified).
+ Note that in the presence of schema evolution, this may mean that
+ fields the client does not know and has therefore not filled into
+ the request will be reset to their default. If this is unwanted
+ behavior, a specific service may require a client to always specify
+ a field mask, producing an error if not.
+
+ As with get operations, the location of the resource which
+ describes the updated values in the request message depends on the
+ operation kind. In any case, the effect of the field mask is
+ required to be honored by the API.
+
+ ## Considerations for HTTP REST
+
+ The HTTP kind of an update operation which uses a field mask must
+ be set to PATCH instead of PUT in order to satisfy HTTP semantics
+ (PUT must only be used for full updates).
+
+ # JSON Encoding of Field Masks
+
+ In JSON, a field mask is encoded as a single string where paths are
+ separated by a comma. Fields name in each path are converted
+ to/from lower-camel naming conventions.
+
+ As an example, consider the following message declarations:
+
+ message Profile {
+ User user = 1;
+ Photo photo = 2;
+ }
+ message User {
+ string display_name = 1;
+ string address = 2;
+ }
+
+ In proto a field mask for `Profile` may look as such:
+
+ mask {
+ paths: "user.display_name"
+ paths: "photo"
+ }
+
+ In JSON, the same mask is represented as below:
+
+ {
+ mask: "user.displayName,photo"
+ }
+
+ # Field Masks and Oneof Fields
+
+ Field masks treat fields in oneofs just as regular fields. Consider the
+ following message:
+
+ message SampleMessage {
+ oneof test_oneof {
+ string name = 4;
+ SubMessage sub_message = 9;
+ }
+ }
+
+ The field mask can be:
+
+ mask {
+ paths: "name"
+ }
+
+ Or:
+
+ mask {
+ paths: "sub_message"
+ }
+
+ Note that oneof type names ("test_oneof" in this case) cannot be used in
+ paths.
+
+ ## Field Mask Verification
+
+ The implementation of any API method which has a FieldMask type field in the
+ request should verify the included field paths, and return an
+ `INVALID_ARGUMENT` error if any path is unmappable.
requestBody:
description: |-
The worksheet to update.
@@ -9973,15 +14704,215 @@ paths:
required: true
schema:
type: string
- - name: updateMask.paths
+ - name: updateMask
in: query
- description: The set of field mask paths.
+ description: |-
+ The list of fields to be updated.
+ Fields are specified relative to the worksheet organizer.
+ Only support update the following fields for now:
+ - `starred`
schema:
- type: array
- items:
- type: string
- title: paths
- description: The set of field mask paths.
+ type: string
+ description: |-
+ `FieldMask` represents a set of symbolic field paths, for example:
+
+ paths: "f.a"
+ paths: "f.b.d"
+
+ Here `f` represents a field in some root message, `a` and `b`
+ fields in the message found in `f`, and `d` a field found in the
+ message in `f.b`.
+
+ Field masks are used to specify a subset of fields that should be
+ returned by a get operation or modified by an update operation.
+ Field masks also have a custom JSON encoding (see below).
+
+ # Field Masks in Projections
+
+ When used in the context of a projection, a response message or
+ sub-message is filtered by the API to only contain those fields as
+ specified in the mask. For example, if the mask in the previous
+ example is applied to a response message as follows:
+
+ f {
+ a : 22
+ b {
+ d : 1
+ x : 2
+ }
+ y : 13
+ }
+ z: 8
+
+ The result will not contain specific values for fields x,y and z
+ (their value will be set to the default, and omitted in proto text
+ output):
+
+
+ f {
+ a : 22
+ b {
+ d : 1
+ }
+ }
+
+ A repeated field is not allowed except at the last position of a
+ paths string.
+
+ If a FieldMask object is not present in a get operation, the
+ operation applies to all fields (as if a FieldMask of all fields
+ had been specified).
+
+ Note that a field mask does not necessarily apply to the
+ top-level response message. In case of a REST get operation, the
+ field mask applies directly to the response, but in case of a REST
+ list operation, the mask instead applies to each individual message
+ in the returned resource list. In case of a REST custom method,
+ other definitions may be used. Where the mask applies will be
+ clearly documented together with its declaration in the API. In
+ any case, the effect on the returned resource/resources is required
+ behavior for APIs.
+
+ # Field Masks in Update Operations
+
+ A field mask in update operations specifies which fields of the
+ targeted resource are going to be updated. The API is required
+ to only change the values of the fields as specified in the mask
+ and leave the others untouched. If a resource is passed in to
+ describe the updated values, the API ignores the values of all
+ fields not covered by the mask.
+
+ If a repeated field is specified for an update operation, new values will
+ be appended to the existing repeated field in the target resource. Note that
+ a repeated field is only allowed in the last position of a `paths` string.
+
+ If a sub-message is specified in the last position of the field mask for an
+ update operation, then new value will be merged into the existing sub-message
+ in the target resource.
+
+ For example, given the target message:
+
+ f {
+ b {
+ d: 1
+ x: 2
+ }
+ c: [1]
+ }
+
+ And an update message:
+
+ f {
+ b {
+ d: 10
+ }
+ c: [2]
+ }
+
+ then if the field mask is:
+
+ paths: ["f.b", "f.c"]
+
+ then the result will be:
+
+ f {
+ b {
+ d: 10
+ x: 2
+ }
+ c: [1, 2]
+ }
+
+ An implementation may provide options to override this default behavior for
+ repeated and message fields.
+
+ In order to reset a field's value to the default, the field must
+ be in the mask and set to the default value in the provided resource.
+ Hence, in order to reset all fields of a resource, provide a default
+ instance of the resource and set all fields in the mask, or do
+ not provide a mask as described below.
+
+ If a field mask is not present on update, the operation applies to
+ all fields (as if a field mask of all fields has been specified).
+ Note that in the presence of schema evolution, this may mean that
+ fields the client does not know and has therefore not filled into
+ the request will be reset to their default. If this is unwanted
+ behavior, a specific service may require a client to always specify
+ a field mask, producing an error if not.
+
+ As with get operations, the location of the resource which
+ describes the updated values in the request message depends on the
+ operation kind. In any case, the effect of the field mask is
+ required to be honored by the API.
+
+ ## Considerations for HTTP REST
+
+ The HTTP kind of an update operation which uses a field mask must
+ be set to PATCH instead of PUT in order to satisfy HTTP semantics
+ (PUT must only be used for full updates).
+
+ # JSON Encoding of Field Masks
+
+ In JSON, a field mask is encoded as a single string where paths are
+ separated by a comma. Fields name in each path are converted
+ to/from lower-camel naming conventions.
+
+ As an example, consider the following message declarations:
+
+ message Profile {
+ User user = 1;
+ Photo photo = 2;
+ }
+ message User {
+ string display_name = 1;
+ string address = 2;
+ }
+
+ In proto a field mask for `Profile` may look as such:
+
+ mask {
+ paths: "user.display_name"
+ paths: "photo"
+ }
+
+ In JSON, the same mask is represented as below:
+
+ {
+ mask: "user.displayName,photo"
+ }
+
+ # Field Masks and Oneof Fields
+
+ Field masks treat fields in oneofs just as regular fields. Consider the
+ following message:
+
+ message SampleMessage {
+ oneof test_oneof {
+ string name = 4;
+ SubMessage sub_message = 9;
+ }
+ }
+
+ The field mask can be:
+
+ mask {
+ paths: "name"
+ }
+
+ Or:
+
+ mask {
+ paths: "sub_message"
+ }
+
+ Note that oneof type names ("test_oneof" in this case) cannot be used in
+ paths.
+
+ ## Field Mask Verification
+
+ The implementation of any API method which has a FieldMask type field in the
+ request should verify the included field paths, and return an
+ `INVALID_ARGUMENT` error if any path is unmappable.
- name: allowMissing
in: query
description: |-
@@ -11726,9 +16657,11 @@ components:
The tasks to run.
Format: projects/{project}/plans/{plan}/rollout/stages/{stage}/tasks/{task}
runTime:
+ oneOf:
+ - $ref: '#/components/schemas/google.protobuf.Timestamp'
+ - type: "null"
title: run_time
description: The task run should run after run_time.
- $ref: '#/components/schemas/google.protobuf.Timestamp'
title: BatchRunTasksRequest
required:
- parent
@@ -12223,9 +17156,11 @@ components:
title: classification
description: The data classification level for this column.
objectSchema:
+ oneOf:
+ - $ref: '#/components/schemas/bytebase.v1.ObjectSchema'
+ - type: "null"
title: object_schema
description: Object schema for complex column types like JSON.
- $ref: '#/components/schemas/bytebase.v1.ObjectSchema'
title: ColumnCatalog
additionalProperties: false
description: Column metadata within a table.
@@ -15589,11 +20524,15 @@ components:
- "null"
title: to_description
fromStatus:
+ oneOf:
+ - $ref: '#/components/schemas/bytebase.v1.IssueStatus'
+ - type: "null"
title: from_status
- $ref: '#/components/schemas/bytebase.v1.IssueStatus'
toStatus:
+ oneOf:
+ - $ref: '#/components/schemas/bytebase.v1.IssueStatus'
+ - type: "null"
title: to_status
- $ref: '#/components/schemas/bytebase.v1.IssueStatus'
fromLabels:
type: array
items:
@@ -16037,9 +20976,11 @@ components:
The name of the instance.
Format: instances/{instance}
instance:
+ oneOf:
+ - $ref: '#/components/schemas/bytebase.v1.Instance'
+ - type: "null"
title: instance
description: The target instance. We need to set this field if the target instance is not created yet.
- $ref: '#/components/schemas/bytebase.v1.Instance'
title: ListInstanceDatabaseRequest
required:
- name
@@ -16404,9 +21345,11 @@ components:
The parent, which owns this collection of policies.
Format: {resource type}/{resource id}
policyType:
+ oneOf:
+ - $ref: '#/components/schemas/bytebase.v1.PolicyType'
+ - type: "null"
title: policy_type
description: Filter by specific policy type.
- $ref: '#/components/schemas/bytebase.v1.PolicyType'
showDeleted:
type: boolean
title: show_deleted
@@ -20856,19 +25799,23 @@ components:
Format: instances/{instance} if the task is DatabaseCreate.
Format: instances/{instance}/databases/{database}
updateTime:
+ oneOf:
+ - $ref: '#/components/schemas/google.protobuf.Timestamp'
+ - type: "null"
title: update_time
description: |-
The update_time is the update time of latest task run.
If there are no task runs, it will be empty.
readOnly: true
- $ref: '#/components/schemas/google.protobuf.Timestamp'
runTime:
+ oneOf:
+ - $ref: '#/components/schemas/google.protobuf.Timestamp'
+ - type: "null"
title: run_time
description: |-
The run_time is the scheduled run time of latest task run.
If there are no task runs or the task run is not scheduled, it will be empty.
readOnly: true
- $ref: '#/components/schemas/google.protobuf.Timestamp'
- oneOf:
- properties:
databaseCreate:
@@ -21065,12 +26012,14 @@ components:
readOnly: true
$ref: '#/components/schemas/bytebase.v1.TaskRun.SchedulerInfo'
runTime:
+ oneOf:
+ - $ref: '#/components/schemas/google.protobuf.Timestamp'
+ - type: "null"
title: run_time
description: |-
The task run should run after run_time.
This can only be set when creating the task run calling BatchRunTasks.
readOnly: true
- $ref: '#/components/schemas/google.protobuf.Timestamp'
title: TaskRun
additionalProperties: false
bytebase.v1.TaskRun.ExportArchiveStatus:
@@ -21550,13 +26499,17 @@ components:
description: When the backend process started.
$ref: '#/components/schemas/google.protobuf.Timestamp'
xactStart:
+ oneOf:
+ - $ref: '#/components/schemas/google.protobuf.Timestamp'
+ - type: "null"
title: xact_start
description: When the current transaction started.
- $ref: '#/components/schemas/google.protobuf.Timestamp'
queryStart:
+ oneOf:
+ - $ref: '#/components/schemas/google.protobuf.Timestamp'
+ - type: "null"
title: query_start
description: When the current query started.
- $ref: '#/components/schemas/google.protobuf.Timestamp'
title: Session
additionalProperties: false
description: PostgreSQL session information read from `pg_stat_activity`.
diff --git a/proto/gen/grpc-doc/v1/README.md b/proto/gen/grpc-doc/v1/README.md
index b3df65db78..7b86f490e1 100644
--- a/proto/gen/grpc-doc/v1/README.md
+++ b/proto/gen/grpc-doc/v1/README.md
@@ -6054,8 +6054,8 @@ GroupService manages user groups for organizing users and permissions.
| Method Name | Request Type | Response Type | Description |
| ----------- | ------------ | ------------- | ------------|
-| GetGroup | [GetGroupRequest](#bytebase-v1-GetGroupRequest) | [Group](#bytebase-v1-Group) | Gets a group by name. Permissions required: bb.groups.get |
-| BatchGetGroups | [BatchGetGroupsRequest](#bytebase-v1-BatchGetGroupsRequest) | [BatchGetGroupsResponse](#bytebase-v1-BatchGetGroupsResponse) | Gets multiple groups in a single request. Permissions required: bb.groups.get |
+| GetGroup | [GetGroupRequest](#bytebase-v1-GetGroupRequest) | [Group](#bytebase-v1-Group) | Gets a group by name. Group members or users with bb.groups.get permission can get the group. Permissions required: bb.groups.get OR caller is the group member |
+| BatchGetGroups | [BatchGetGroupsRequest](#bytebase-v1-BatchGetGroupsRequest) | [BatchGetGroupsResponse](#bytebase-v1-BatchGetGroupsResponse) | Gets multiple groups in a single request. Group members or users with bb.groups.get permission can get the group. Permissions required: bb.groups.get OR caller is the group member |
| ListGroups | [ListGroupsRequest](#bytebase-v1-ListGroupsRequest) | [ListGroupsResponse](#bytebase-v1-ListGroupsResponse) | Lists all groups in the workspace. Permissions required: bb.groups.list |
| CreateGroup | [CreateGroupRequest](#bytebase-v1-CreateGroupRequest) | [Group](#bytebase-v1-Group) | Creates a new group. Permissions required: bb.groups.create |
| UpdateGroup | [UpdateGroupRequest](#bytebase-v1-UpdateGroupRequest) | [Group](#bytebase-v1-Group) | Updates a group. Group owners or users with bb.groups.update permission can update. Permissions required: bb.groups.update OR caller is group owner When allow_missing=true, also requires: bb.groups.create |
diff --git a/proto/gen/grpc-doc/v1/index.html b/proto/gen/grpc-doc/v1/index.html
index 1729333119..240421e04d 100644
--- a/proto/gen/grpc-doc/v1/index.html
+++ b/proto/gen/grpc-doc/v1/index.html
@@ -17288,7 +17288,8 @@ In this situation, `update_mask` is ignored. </p></td>
<td><a href="#bytebase.v1.GetGroupRequest">GetGroupRequest</a></td>
<td><a href="#bytebase.v1.Group">Group</a></td>
<td><p>Gets a group by name.
-Permissions required: bb.groups.get</p></td>
+Group members or users with bb.groups.get permission can get the group.
+Permissions required: bb.groups.get OR caller is the group member</p></td>
</tr>
<tr>
@@ -17296,7 +17297,8 @@ Permissions required: bb.groups.get</p></td>
<td><a href="#bytebase.v1.BatchGetGroupsRequest">BatchGetGroupsRequest</a></td>
<td><a href="#bytebase.v1.BatchGetGroupsResponse">BatchGetGroupsResponse</a></td>
<td><p>Gets multiple groups in a single request.
-Permissions required: bb.groups.get</p></td>
+Group members or users with bb.groups.get permission can get the group.
+Permissions required: bb.groups.get OR caller is the group member</p></td>
</tr>
<tr>
diff --git a/proto/v1/v1/group_service.proto b/proto/v1/v1/group_service.proto
index d282986d2a..d7d6abacb7 100644
--- a/proto/v1/v1/group_service.proto
+++ b/proto/v1/v1/group_service.proto
@@ -16,20 +16,22 @@ option go_package = "github.com/bytebase/bytebase/backend/generated-go/v1";
// GroupService manages user groups for organizing users and permissions.
service GroupService {
// Gets a group by name.
- // Permissions required: bb.groups.get
+ // Group members or users with bb.groups.get permission can get the group.
+ // Permissions required: bb.groups.get OR caller is the group member
rpc GetGroup(GetGroupRequest) returns (Group) {
option (google.api.http) = {get: "/v1/{name=groups/*}"};
option (google.api.method_signature) = "name";
option (bytebase.v1.permission) = "bb.groups.get";
- option (bytebase.v1.auth_method) = IAM;
+ option (bytebase.v1.auth_method) = CUSTOM;
}
// Gets multiple groups in a single request.
- // Permissions required: bb.groups.get
+ // Group members or users with bb.groups.get permission can get the group.
+ // Permissions required: bb.groups.get OR caller is the group member
rpc BatchGetGroups(BatchGetGroupsRequest) returns (BatchGetGroupsResponse) {
option (google.api.http) = {get: "/v1/groups:batchGet"};
option (bytebase.v1.permission) = "bb.groups.get";
- option (bytebase.v1.auth_method) = IAM;
+ option (bytebase.v1.auth_method) = CUSTOM;
}
// Lists all groups in the workspace.