Bytebase

Bytebase Review Config Service API

ReviewConfigService manages approval flow configurations.

Documentation GitHub OpenAPI

Operations 5

GET /v1/reviewConfigs ListReviewConfigs #

POST /v1/reviewConfigs CreateReviewConfig #

GET /v1/reviewConfigs/{reviewConfig} GetReviewConfig #

DELETE /v1/reviewConfigs/{reviewConfig} DeleteReviewConfig #

PATCH /v1/reviewConfigs/{reviewConfig} UpdateReviewConfig #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/bytebase:bytebase-reviewconfigservice-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Bytebase API Reference Review Config Service API
  description: API reference for Bytebase. Every endpoint is served by your own Bytebase instance.
  version: 1.0.0
security: []
tags:
- name: ReviewConfigService
  description: ReviewConfigService manages approval flow configurations.
paths:
  /v1/reviewConfigs:
    get:
      tags:
      - ReviewConfigService
      summary: ListReviewConfigs
      description: 'Lists all SQL review configurations.

        Permissions required: bb.reviewConfigs.list'
      operationId: ReviewConfigService_ListReviewConfigs
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bytebase.v1.ListReviewConfigsResponse'
    post:
      tags:
      - ReviewConfigService
      summary: CreateReviewConfig
      description: 'Creates a new SQL review configuration.

        Permissions required: bb.reviewConfigs.create'
      operationId: ReviewConfigService_CreateReviewConfig
      requestBody:
        description: The SQL review config to create.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/bytebase.v1.ReviewConfig'
              title: review_config
              description: The SQL review config to create.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bytebase.v1.ReviewConfig'
  /v1/reviewConfigs/{reviewConfig}:
    get:
      tags:
      - ReviewConfigService
      summary: GetReviewConfig
      description: 'Retrieves a SQL review configuration by name.

        Permissions required: bb.reviewConfigs.get'
      operationId: ReviewConfigService_GetReviewConfig
      parameters:
      - name: reviewConfig
        in: path
        description: The reviewConfig id.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bytebase.v1.ReviewConfig'
    delete:
      tags:
      - ReviewConfigService
      summary: DeleteReviewConfig
      description: 'Deletes a SQL review configuration.

        Permissions required: bb.reviewConfigs.delete'
      operationId: ReviewConfigService_DeleteReviewConfig
      parameters:
      - name: reviewConfig
        in: path
        description: The reviewConfig id.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.protobuf.Empty'
    patch:
      tags:
      - ReviewConfigService
      summary: UpdateReviewConfig
      description: 'Updates a SQL review configuration.

        Permissions required: bb.reviewConfigs.update

        When allow_missing=true, also requires: bb.reviewConfigs.create'
      operationId: ReviewConfigService_UpdateReviewConfig
      parameters:
      - name: reviewConfig
        in: path
        description: The reviewConfig id.
        required: true
        schema:
          type: string
      - name: updateMask
        in: query
        description: The list of fields to update.
        schema:
          type: string
      - name: allowMissing
        in: query
        description: "If set to true, and the config is not found, a new config will be created.\n In this situation, `update_mask` is ignored."
        schema:
          type: boolean
          title: allow_missing
      requestBody:
        description: "The SQL review config to update.\n\n The name field is used to identify the SQL review config to update."
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/bytebase.v1.ReviewConfig'
              title: review_config
              description: "The SQL review config to update.\n\n The name field is used to identify the SQL review config to update."
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bytebase.v1.ReviewConfig'
components:
  schemas:
    bytebase.v1.SQLReviewRule.CommentConventionRulePayload:
      type: object
      properties:
        required:
          type: boolean
          title: required
        maxLength:
          type: integer
          title: max_length
          format: int32
      title: CommentConventionRulePayload
      additionalProperties: false
    bytebase.v1.SQLReviewRule:
      type: object
      anyOf:
      - type: object
        properties:
          commentConventionPayload:
            allOf:
            - $ref: '#/components/schemas/bytebase.v1.SQLReviewRule.CommentConventionRulePayload'
            title: comment_convention_payload
        title: comment_convention_payload
      - type: object
        properties:
          namingCasePayload:
            allOf:
            - $ref: '#/components/schemas/bytebase.v1.SQLReviewRule.NamingCaseRulePayload'
            title: naming_case_payload
        title: naming_case_payload
      - type: object
        properties:
          namingPayload:
            allOf:
            - $ref: '#/components/schemas/bytebase.v1.SQLReviewRule.NamingRulePayload'
            title: naming_payload
        title: naming_payload
      - type: object
        properties:
          numberPayload:
            allOf:
            - $ref: '#/components/schemas/bytebase.v1.SQLReviewRule.NumberRulePayload'
            title: number_payload
        title: number_payload
      - type: object
        properties:
          stringArrayPayload:
            allOf:
            - $ref: '#/components/schemas/bytebase.v1.SQLReviewRule.StringArrayRulePayload'
            title: string_array_payload
        title: string_array_payload
      - type: object
        properties:
          stringPayload:
            allOf:
            - $ref: '#/components/schemas/bytebase.v1.SQLReviewRule.StringRulePayload'
            title: string_payload
        title: string_payload
      unevaluatedProperties: false
      not:
        allOf:
        - anyOf:
          - required:
            - commentConventionPayload
          - required:
            - namingCasePayload
          - required:
            - namingPayload
          - required:
            - numberPayload
          - required:
            - stringArrayPayload
          - required:
            - stringPayload
        - not:
            oneOf:
            - required:
              - commentConventionPayload
            - required:
              - namingCasePayload
            - required:
              - namingPayload
            - required:
              - numberPayload
            - required:
              - stringArrayPayload
            - required:
              - stringPayload
      properties:
        type:
          allOf:
          - $ref: '#/components/schemas/bytebase.v1.SQLReviewRule.Type'
          title: type
          description: The type of SQL review rule.
        level:
          allOf:
          - $ref: '#/components/schemas/bytebase.v1.SQLReviewRule.Level'
          title: level
          description: The severity level of the rule.
        engine:
          allOf:
          - $ref: '#/components/schemas/bytebase.v1.Engine'
          title: engine
          description: The database engine this rule applies to.
      title: SQLReviewRule
      description: SQL review rule configuration. Check the SQL_REVIEW_RULES_DOCUMENTATION.md for details.
    bytebase.v1.SQLReviewRule.NumberRulePayload:
      type: object
      properties:
        number:
          type: integer
          title: number
          format: int32
      title: NumberRulePayload
      additionalProperties: false
    bytebase.v1.SQLReviewRule.StringArrayRulePayload:
      type: object
      properties:
        list:
          type: array
          items:
            type: string
          title: list
      title: StringArrayRulePayload
      additionalProperties: false
    bytebase.v1.SQLReviewRule.Level:
      type: string
      title: Level
      enum:
      - LEVEL_UNSPECIFIED
      - ERROR
      - WARNING
      description: The severity level for SQL review rules.
    bytebase.v1.ListReviewConfigsResponse:
      type: object
      properties:
        reviewConfigs:
          type: array
          items:
            $ref: '#/components/schemas/bytebase.v1.ReviewConfig'
          title: review_configs
          description: The SQL review configs from the specified request.
      title: ListReviewConfigsResponse
      additionalProperties: false
    bytebase.v1.SQLReviewRule.NamingCaseRulePayload:
      type: object
      properties:
        upper:
          type: boolean
          title: upper
      title: NamingCaseRulePayload
      additionalProperties: false
    bytebase.v1.ReviewConfig:
      type: object
      properties:
        name:
          type: string
          title: name
          description: "The name of the SQL review config.\n Format: reviewConfigs/{reviewConfig}"
          readOnly: true
        title:
          type: string
          title: title
          maxLength: 200
          description: The title of the review configuration.
        enabled:
          type: boolean
          title: enabled
          description: Whether the review configuration is enabled.
        rules:
          type: array
          items:
            $ref: '#/components/schemas/bytebase.v1.SQLReviewRule'
          title: rules
          description: The SQL review rules to enforce.
        resources:
          type: array
          items:
            type: string
          title: resources
          description: "Resources using the config.\n Format: {resource}/{resource id}, e.g., environments/test."
      title: ReviewConfig
      additionalProperties: false
    bytebase.v1.SQLReviewRule.Type:
      type: string
      title: Type
      enum:
      - TYPE_UNSPECIFIED
      - ENGINE_MYSQL_USE_INNODB
      - NAMING_FULLY_QUALIFIED
      - NAMING_TABLE
      - NAMING_COLUMN
      - NAMING_INDEX_PK
      - NAMING_INDEX_UK
      - NAMING_INDEX_FK
      - NAMING_INDEX_IDX
      - NAMING_COLUMN_AUTO_INCREMENT
      - NAMING_TABLE_NO_KEYWORD
      - NAMING_IDENTIFIER_NO_KEYWORD
      - NAMING_IDENTIFIER_CASE
      - STATEMENT_SELECT_NO_SELECT_ALL
      - STATEMENT_WHERE_REQUIRE_SELECT
      - STATEMENT_WHERE_REQUIRE_UPDATE_DELETE
      - STATEMENT_WHERE_NO_LEADING_WILDCARD_LIKE
      - STATEMENT_DISALLOW_ON_DEL_CASCADE
      - STATEMENT_DISALLOW_RM_TBL_CASCADE
      - STATEMENT_DISALLOW_COMMIT
      - STATEMENT_DISALLOW_LIMIT
      - STATEMENT_DISALLOW_ORDER_BY
      - STATEMENT_MERGE_ALTER_TABLE
      - STATEMENT_INSERT_ROW_LIMIT
      - STATEMENT_INSERT_MUST_SPECIFY_COLUMN
      - STATEMENT_INSERT_DISALLOW_ORDER_BY_RAND
      - STATEMENT_AFFECTED_ROW_LIMIT
      - STATEMENT_DML_DRY_RUN
      - STATEMENT_DISALLOW_ADD_COLUMN_WITH_DEFAULT
      - STATEMENT_ADD_CHECK_NOT_VALID
      - STATEMENT_ADD_FOREIGN_KEY_NOT_VALID
      - STATEMENT_DISALLOW_ADD_NOT_NULL
      - STATEMENT_CREATE_SPECIFY_SCHEMA
      - STATEMENT_CHECK_SET_ROLE_VARIABLE
      - STATEMENT_WHERE_NO_EQUAL_NULL
      - STATEMENT_WHERE_DISALLOW_FUNCTIONS_AND_CALCULATIONS
      - STATEMENT_WHERE_MAXIMUM_LOGICAL_OPERATOR_COUNT
      - STATEMENT_MAXIMUM_STATEMENTS_IN_TRANSACTION
      - STATEMENT_NON_TRANSACTIONAL
      - STATEMENT_ADD_COLUMN_WITHOUT_POSITION
      - STATEMENT_DISALLOW_OFFLINE_DDL
      - STATEMENT_DISALLOW_CROSS_DB_QUERIES
      - STATEMENT_MAX_EXECUTION_TIME
      - STATEMENT_REQUIRE_ALGORITHM_OPTION
      - STATEMENT_REQUIRE_LOCK_OPTION
      - STATEMENT_OBJECT_OWNER_CHECK
      - TABLE_REQUIRE_PK
      - TABLE_NO_FOREIGN_KEY
      - TABLE_DROP_NAMING_CONVENTION
      - TABLE_COMMENT
      - TABLE_DISALLOW_PARTITION
      - TABLE_DISALLOW_TRIGGER
      - TABLE_NO_DUPLICATE_INDEX
      - TABLE_TEXT_FIELDS_TOTAL_LENGTH
      - TABLE_DISALLOW_SET_CHARSET
      - TABLE_DISALLOW_DDL
      - TABLE_DISALLOW_DML
      - TABLE_LIMIT_SIZE
      - TABLE_REQUIRE_CHARSET
      - TABLE_REQUIRE_COLLATION
      - COLUMN_REQUIRED
      - COLUMN_NO_NULL
      - COLUMN_DISALLOW_CHANGE_TYPE
      - COLUMN_SET_DEFAULT_FOR_NOT_NULL
      - COLUMN_DISALLOW_CHANGE
      - COLUMN_DISALLOW_CHANGING_ORDER
      - COLUMN_DISALLOW_DROP
      - COLUMN_DISALLOW_DROP_IN_INDEX
      - COLUMN_COMMENT
      - COLUMN_AUTO_INCREMENT_MUST_INTEGER
      - COLUMN_TYPE_DISALLOW_LIST
      - COLUMN_DISALLOW_SET_CHARSET
      - COLUMN_MAXIMUM_CHARACTER_LENGTH
      - COLUMN_MAXIMUM_VARCHAR_LENGTH
      - COLUMN_AUTO_INCREMENT_INITIAL_VALUE
      - COLUMN_AUTO_INCREMENT_MUST_UNSIGNED
      - COLUMN_CURRENT_TIME_COUNT_LIMIT
      - COLUMN_REQUIRE_DEFAULT
      - COLUMN_DEFAULT_DISALLOW_VOLATILE
      - COLUMN_ADD_NOT_NULL_REQUIRE_DEFAULT
      - COLUMN_REQUIRE_CHARSET
      - COLUMN_REQUIRE_COLLATION
      - SCHEMA_BACKWARD_COMPATIBILITY
      - DATABASE_DROP_EMPTY_DATABASE
      - INDEX_NO_DUPLICATE_COLUMN
      - INDEX_KEY_NUMBER_LIMIT
      - INDEX_PK_TYPE_LIMIT
      - INDEX_TYPE_NO_BLOB
      - INDEX_TOTAL_NUMBER_LIMIT
      - INDEX_PRIMARY_KEY_TYPE_ALLOWLIST
      - INDEX_CREATE_CONCURRENTLY
      - INDEX_TYPE_ALLOW_LIST
      - INDEX_NOT_REDUNDANT
      - SYSTEM_CHARSET_ALLOWLIST
      - SYSTEM_COLLATION_ALLOWLIST
      - SYSTEM_COMMENT_LENGTH
      - SYSTEM_PROCEDURE_DISALLOW_CREATE
      - SYSTEM_EVENT_DISALLOW_CREATE
      - SYSTEM_VIEW_DISALLOW_CREATE
      - SYSTEM_FUNCTION_DISALLOW_CREATE
      - SYSTEM_FUNCTION_DISALLOWED_LIST
      - ADVICE_ONLINE_MIGRATION
      - BUILTIN_PRIOR_BACKUP_CHECK
      - BUILTIN_WALK_THROUGH_CHECK
      - STATEMENT_DISALLOW_TRUNCATE
      - BUILTIN_STATEMENT_MAXIMUM_SQL_SIZE
    bytebase.v1.SQLReviewRule.NamingRulePayload:
      type: object
      properties:
        maxLength:
          type: integer
          title: max_length
          format: int32
        format:
          type: string
          title: format
      title: NamingRulePayload
      additionalProperties: false
      description: Payload message types for SQL review rules
    bytebase.v1.Engine:
      type: string
      title: Engine
      enum:
      - ENGINE_UNSPECIFIED
      - CLICKHOUSE
      - MYSQL
      - POSTGRES
      - SNOWFLAKE
      - TIDB
      - MONGODB
      - REDIS
      - ORACLE
      - SPANNER
      - MSSQL
      - REDSHIFT
      - MARIADB
      - OCEANBASE
      - STARROCKS
      - DORIS
      - HIVE
      - ELASTICSEARCH
      - BIGQUERY
      - DYNAMODB
      - DATABRICKS
      - COCKROACHDB
      - COSMOSDB
      - TRINO
      - CASSANDRA
      description: Database engine type.
    google.protobuf.Empty:
      type: object
      description: An empty JSON object.
    bytebase.v1.SQLReviewRule.StringRulePayload:
      type: object
      properties:
        value:
          type: string
          title: value
      title: StringRulePayload
      additionalProperties: false
x-provenance:
  method: harvested
  publisher: Bytebase
  source: https://api.bytebase.com/openapi.yaml
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)