Clarity Feature Flags API

openapi: 3.2.0
info:
  title: Fast Feature Flags API
  version: 0.1.0
tags:
- name: Feature Flags
paths:
  /api/v1/feature-flags:
    get:
      tags:
      - Feature Flags
      summary: Get Feature Flags
      description: Every registered flag for the project the caller is viewing, with stored and effective values.
      operationId: get_feature_flags_api_v1_feature_flags_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeatureFlagsResponse'
      security:
      - HTTPBearer: []
    put:
      tags:
      - Feature Flags
      summary: Update Feature Flags
      description: 'Apply a partial flag patch as a NEW active config version; answers like GET afterwards.


        Keys absent from the body are left as they are. Unknown keys are rejected as a whole

        (422) so a typo never silently writes a dead key into the config. A patch that changes

        nothing is a no-op: no new version is created.'
      operationId: update_feature_flags_api_v1_feature_flags_put
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FeatureFlagsPatch'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeatureFlagsResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
components:
  schemas:
    FeatureFlagsProject:
      properties:
        id:
          type: integer
          title: Id
        name:
          type: string
          title: Name
      type: object
      required:
      - id
      - name
      title: FeatureFlagsProject
    FeatureFlagsResponse:
      properties:
        project:
          $ref: '#/components/schemas/FeatureFlagsProject'
        config_id:
          type: integer
          title: Config Id
          description: Id of the active config version the flags were read from
        flags:
          items:
            $ref: '#/components/schemas/FeatureFlagState'
          type: array
          title: Flags
      type: object
      required:
      - project
      - config_id
      - flags
      title: FeatureFlagsResponse
    FeatureFlagsPatch:
      properties:
        flags:
          additionalProperties:
            anyOf:
            - type: boolean
            - type: 'null'
          type: object
          title: Flags
          description: Registered flag keys to change. true/false store an explicit value; null unsets the key.
      type: object
      required:
      - flags
      title: FeatureFlagsPatch
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    FeatureFlagState:
      properties:
        key:
          type: string
          title: Key
        label:
          type: string
          title: Label
        description:
          type: string
          title: Description
        group:
          type: string
          title: Group
        default:
          type: boolean
          title: Default
          description: Value the app uses when the config leaves the key unset
        value:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Value
          description: Value stored in the active config; null when unset
        effective:
          type: boolean
          title: Effective
          description: 'What the app actually sees: value, or default when unset'
      type: object
      required:
      - key
      - label
      - description
      - group
      - default
      - effective
      title: FeatureFlagState
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
    HTTPBasic:
      type: http
      scheme: basic