Revyl Global Variables API

openapi: 3.2.0
info:
  description: Revyl API
  title: Revyl Global Variables API
  version: 1.0.0
servers:
- description: Production
  url: https://backend.revyl.ai
tags:
- name: Global Variables
paths:
  /api/v1/variables/global:
    get:
      description: List all global variables for the caller's organization.
      operationId: list_global_variables_api_v1_variables_global_get
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlobalVariablesResponse'
          description: Successful Response
      security:
      - HTTPBearer: []
      summary: List Global Variables
      tags:
      - Global Variables
    post:
      description: Create a new global variable for the caller's organization.
      operationId: add_global_variable_api_v1_variables_global_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GlobalVariableCreate'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlobalVariableResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
      - HTTPBearer: []
      summary: Add Global Variable
      tags:
      - Global Variables
  /api/v1/variables/global/{variable_id}:
    delete:
      description: Delete a global variable.
      operationId: delete_global_variable_api_v1_variables_global__variable_id__delete
      parameters:
      - in: path
        name: variable_id
        required: true
        schema:
          format: uuid
          title: Variable Id
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlobalVariableResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
      - HTTPBearer: []
      summary: Delete Global Variable
      tags:
      - Global Variables
    put:
      description: Update an existing global variable.
      operationId: update_global_variable_api_v1_variables_global__variable_id__put
      parameters:
      - in: path
        name: variable_id
        required: true
        schema:
          format: uuid
          title: Variable Id
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GlobalVariableUpdate'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlobalVariableResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
      - HTTPBearer: []
      summary: Update Global Variable
      tags:
      - Global Variables
components:
  schemas:
    GlobalVariablesResponse:
      description: Response model for global variable list operations.
      properties:
        message:
          description: Response message
          title: Message
          type: string
        result:
          description: List of global variable records
          items:
            $ref: '#/components/schemas/GlobalVariableRow'
          title: Result
          type: array
      required:
      - message
      - result
      title: GlobalVariablesResponse
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    GlobalVariableRow:
      description: Row model for a global variable.
      properties:
        created_at:
          description: Creation timestamp
          format: date-time
          title: Created At
          type: string
        created_by:
          anyOf:
          - format: uuid
            type: string
          - type: 'null'
          description: User who created it
          title: Created By
        description:
          anyOf:
          - type: string
          - type: 'null'
          description: Description
          title: Description
        has_secret_value:
          default: false
          description: Whether an encrypted value is stored for this variable
          title: Has Secret Value
          type: boolean
        id:
          description: Unique identifier
          format: uuid
          title: Id
          type: string
        is_secret:
          default: false
          description: Whether the value is encrypted and masked
          title: Is Secret
          type: boolean
        org_id:
          description: Organization ID
          format: uuid
          title: Org Id
          type: string
        updated_at:
          description: Last update timestamp
          format: date-time
          title: Updated At
          type: string
        variable_name:
          description: Name of the variable
          title: Variable Name
          type: string
        variable_value:
          anyOf:
          - type: string
          - type: 'null'
          description: Value
          title: Variable Value
      required:
      - id
      - org_id
      - variable_name
      - created_at
      - updated_at
      title: GlobalVariableRow
      type: object
    GlobalVariableCreate:
      description: Request model for creating a global variable.
      properties:
        description:
          anyOf:
          - type: string
          - type: 'null'
          description: Description of the variable
          title: Description
        is_secret:
          default: false
          description: Whether the value should be encrypted and masked
          title: Is Secret
          type: boolean
        variable_name:
          description: Name of the variable
          title: Variable Name
          type: string
        variable_value:
          anyOf:
          - type: string
          - type: 'null'
          description: Value of the variable
          title: Variable Value
      required:
      - variable_name
      title: GlobalVariableCreate
      type: object
    GlobalVariableResponse:
      description: Response model for single global variable operations.
      properties:
        message:
          description: Response message
          title: Message
          type: string
        result:
          $ref: '#/components/schemas/GlobalVariableRow'
          description: Global variable record
      required:
      - message
      - result
      title: GlobalVariableResponse
      type: object
    ValidationError:
      properties:
        ctx:
          title: Context
          type: object
        input:
          title: Input
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
      - loc
      - msg
      - type
      title: ValidationError
      type: object
    GlobalVariableUpdate:
      description: Request model for updating a global variable.
      properties:
        description:
          anyOf:
          - type: string
          - type: 'null'
          description: New description
          title: Description
        is_secret:
          anyOf:
          - type: boolean
          - type: 'null'
          description: New secret flag
          title: Is Secret
        variable_name:
          anyOf:
          - type: string
          - type: 'null'
          description: New name
          title: Variable Name
        variable_value:
          anyOf:
          - type: string
          - type: 'null'
          description: New value
          title: Variable Value
      title: GlobalVariableUpdate
      type: object
  securitySchemes:
    HTTPBearer:
      scheme: bearer
      type: http