docs: update GitHub Actions data masking tutorials to latest API#1080
Open
adela-bytebase wants to merge 2 commits intomainfrom
Open
docs: update GitHub Actions data masking tutorials to latest API#1080adela-bytebase wants to merge 2 commits intomainfrom
adela-bytebase wants to merge 2 commits intomainfrom
Conversation
- Setting names: bb.workspace.semantic-types → SEMANTIC_TYPES, bb.workspace.data-classification → DATA_CLASSIFICATION - Policy URL: policies/masking_rule → workspaces/-/policies/masking_rule - Masking exception → exemption (API rename) - Fix classification file reference Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the GitHub Actions “data masking” tutorial series to align the curl examples and file references with the latest Bytebase API naming and routing conventions.
Changes:
- Update workspace setting endpoints to use enum-style setting names (e.g.,
SEMANTIC_TYPES,DATA_CLASSIFICATION). - Update policy endpoints to include the workspace prefix where required (e.g.,
workspaces/-/policies/masking_rule) and rename masking exception → exemption. - Fix the referenced classification file path (
masking/data-classification.json).
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| docs/tutorials/github-action-data-masking-part1.mdx | Updates semantic type setting endpoint and global masking rule policy path to the current API routes. |
| docs/tutorials/github-action-data-masking-part2.mdx | Renames masking exception → exemption in both wording and policy endpoint/file path references. |
| docs/tutorials/github-action-data-masking-part3.mdx | Updates classification file name reference and setting endpoint to DATA_CLASSIFICATION. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ### In GitHub Workflow | ||
|
|
||
| Find the step `Apply classification`, which will apply the classification to the database via API. All the classifications should be defined in one file in the root directory as `masking/classification.json`. The code it calls Bytebase API is as follows: | ||
| Find the step `Apply classification`, which will apply the classification to the database via API. All the classifications should be defined in one file in the root directory as `masking/data-classification.json`. The code it calls Bytebase API is as follows: |
There was a problem hiding this comment.
Grammar: “The code it calls Bytebase API…” is unidiomatic/unclear. Consider rephrasing to something like “The code to call the Bytebase API is as follows:” so the sentence reads naturally.
Suggested change
| Find the step `Apply classification`, which will apply the classification to the database via API. All the classifications should be defined in one file in the root directory as `masking/data-classification.json`. The code it calls Bytebase API is as follows: | |
| Find the step `Apply classification`, which will apply the classification to the database via API. All the classifications should be defined in one file in the root directory as `masking/data-classification.json`. The code to call the Bytebase API is as follows: |
| ### In GitHub Workflow | ||
|
|
||
| Find the step `Apply masking exception`, which will apply the masking exception to the database and the process is similar, the code it calls Bytebase API is as follows: | ||
| Find the step `Apply masking exemption`, which will apply the masking exemption to the database and the process is similar, the code it calls Bytebase API is as follows: |
There was a problem hiding this comment.
Grammar: “the code it calls Bytebase API…” is unidiomatic. Rephrase to “the code to call the Bytebase API is as follows:” (or similar) for readability.
Suggested change
| Find the step `Apply masking exemption`, which will apply the masking exemption to the database and the process is similar, the code it calls Bytebase API is as follows: | |
| Find the step `Apply masking exemption`, which applies the masking exemption to the database. The process is similar, and the code to call the Bytebase API is as follows: |
| ``` | ||
|
|
||
| By changing file `masking/projects/**/masking-exception.json`, create a PR and then merge, the change will be applied. | ||
| By changing file `masking/projects/**/masking-exemption.json`, create a PR and then merge, the change will be applied. |
There was a problem hiding this comment.
Minor grammar: “By changing file …, create a PR and then merge” reads awkwardly. Consider “By changing the file …, creating a PR, and merging it, the change will be applied.”
Suggested change
| By changing file `masking/projects/**/masking-exemption.json`, create a PR and then merge, the change will be applied. | |
| By changing the file `masking/projects/**/masking-exemption.json`, creating a PR, and merging it, the change will be applied. |
adela-bytebase
added a commit
to bytebase/example-database-security
that referenced
this pull request
Apr 17, 2026
Breaking API changes addressed: - Setting names: bb.workspace.semantic-types → SEMANTIC_TYPES, bb.workspace.data-classification → DATA_CLASSIFICATION (migrated in v3.7) - Policy URLs: policies/masking_rule → workspaces/-/policies/masking_rule (workspace prefix required by gRPC-gateway route) - Masking exception → exemption: renamed policy type, JSON fields, and data file (masking_exception → masking_exemption, maskingExceptionPolicy → maskingExemptionPolicy, maskingExceptions → exemptions) - CEL expressions: add resource. prefix (resource.environment_id, resource.classification_level) - Classification levels: id (string) → level (integer), levelId → level - JSON body fields: semanticTypeSettingValue → semanticType, data_classification_setting_value → dataClassification - Masking exemption: action field removed, member → members (array) Companion docs PR: bytebase/bytebase.com#1080 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
3 tasks
Query params allowMissing and updateMask use camelCase as documented in the Bytebase OpenAPI spec at api.bytebase.com. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
adela-bytebase
force-pushed
the
docs/github-action-masking-api-update
branch
from
a72f30c to
a3f8c30
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
bb.workspace.*to UPPERCASE enum names (SEMANTIC_TYPES,DATA_CLASSIFICATION)workspaces/-/policies/masking_rule)masking/classification.json→masking/data-classification.json)Companion PR for the example repo: bytebase/example-database-security#96
Test plan
🤖 Generated with Claude Code