openapi: 3.2.0
info:
  contact:
    name: https://docs.yugabyte.com
  description: ALPHA - NOT FOR EXTERNAL USE
  license:
    name: Polyform Free Trial License 1.0.0
    url: https://github.com/yugabyte/yugabyte-db/blob/master/licenses/POLYFORM-FREE-TRIAL-LICENSE-1.0.0.txt
  termsOfService: TODO(chirag)
  title: YugabyteDB Anywhere GFlags Validation APIs API
  version: v1
servers:
- url: /
tags:
- name: GFlags Validation APIs
paths:
  /api/v1/metadata/version/{version}/gflag:
    get:
      description: 'WARNING: This is a preview API that could change.'
      operationId: getGFlagMetadata
      parameters:
      - in: path
        name: version
        required: true
        schema:
          type: string
      - in: query
        name: name
        schema:
          type: string
      - in: query
        name: server
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GFlagDetails'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Get gflag metadata
      tags:
      - GFlags Validation APIs
  /api/v1/metadata/version/{version}/list_gflags:
    get:
      description: 'WARNING: This is a preview API that could change.'
      operationId: listGFlags
      parameters:
      - in: path
        name: version
        required: true
        schema:
          type: string
      - in: query
        name: name
        schema:
          type: string
      - in: query
        name: server
        schema:
          type: string
      - in: query
        name: mostUsedGFlags
        schema:
          default: false
          type: boolean
      - in: query
        name: showExperimental
        schema:
          default: false
          type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/GFlagDetails'
                type: array
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: List all gflags for a release
      tags:
      - GFlags Validation APIs
  /api/v1/metadata/version/{version}/validate_gflags:
    post:
      description: 'WARNING: This is a preview API that could change.'
      operationId: validateGFlags
      parameters:
      - in: path
        name: version
        required: true
        schema:
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GFlagsValidationFormData'
        description: GFlag validation form data
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/GFlagsValidationResponse'
                type: array
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Validate gflags
      tags:
      - GFlags Validation APIs
      x-codegen-request-body-name: gflag_validation_form_data
components:
  schemas:
    GFlagsValidationResponse:
      example:
        MASTER:
          exist: true
          error: error
        TSERVER:
          exist: true
          error: error
        Name: Name
      properties:
        MASTER:
          $ref: '#/components/schemas/GFlagValidationDetails'
        Name:
          description: 'WARNING: This is a preview API that could change. Name of the gflag'
          type: string
        TSERVER:
          $ref: '#/components/schemas/GFlagValidationDetails'
      type: object
    GFlagValidationDetails:
      example:
        exist: true
        error: error
      properties:
        error:
          description: 'WARNING: This is a preview API that could change. Error message if gflag is invalid'
          type: string
        exist:
          description: 'WARNING: This is a preview API that could change. Flag to indicate if gflag exists'
          type: boolean
      type: object
    GFlagDetails:
      example:
        current: current
        default: default
        file: file
        initial: initial
        meaning: meaning
        name: name
        type: type
        tags: tags
        target: target
      properties:
        current:
          description: 'WARNING: This is a preview API that could change. Current value of the gflag'
          type: string
        default:
          description: 'WARNING: This is a preview API that could change. Default value of the gflag'
          type: string
        file:
          description: 'WARNING: This is a preview API that could change. File where the gflag is defined'
          type: string
        initial:
          description: 'WARNING: This is a preview API that could change. Initial value of the gflag'
          type: string
        meaning:
          description: 'WARNING: This is a preview API that could change. Meaning of the gflag'
          type: string
        name:
          description: 'WARNING: This is a preview API that could change. Name of the gflag'
          type: string
        tags:
          description: 'WARNING: This is a preview API that could change. Tags of the gflag'
          type: string
        target:
          description: 'WARNING: This is a preview API that could change. Target of the gflag'
          type: string
        type:
          description: 'WARNING: This is a preview API that could change. Type of the gflag'
          type: string
      type: object
    GFlagsValidationFormData:
      example:
        gflags:
        - MASTER: MASTER
          TSERVER: TSERVER
          Name: Name
        - MASTER: MASTER
          TSERVER: TSERVER
          Name: Name
      properties:
        gflags:
          description: 'WARNING: This is a preview API that could change. List of gflags to validate'
          items:
            $ref: '#/components/schemas/GFlagsValidationRequest'
          type: array
      type: object
    GFlagsValidationRequest:
      example:
        MASTER: MASTER
        TSERVER: TSERVER
        Name: Name
      properties:
        MASTER:
          description: 'WARNING: This is a preview API that could change. Value of the gflag for master'
          type: string
        Name:
          description: 'WARNING: This is a preview API that could change. Name of the gflag'
          type: string
        TSERVER:
          description: 'WARNING: This is a preview API that could change. Value of the gflag for tserver'
          type: string
      type: object
  securitySchemes:
    apiKeyAuth:
      description: API token passed as header
      in: header
      name: X-AUTH-YW-API-TOKEN
      type: apiKey
externalDocs:
  description: About YugabyteDB Anywhere
  url: https://docs.yugabyte.com/latest/yugabyte-platform/
x-original-swagger-version: '2.0'