Netter api-keys API

openapi: 3.1.0
info:
  title: DMI Backend actions api-keys API
  version: 0.1.0
tags:
- name: api-keys
paths:
  /api/v1/api-keys/:
    get:
      tags:
      - api-keys
      summary: List Api Keys
      description: List the caller's API keys — summaries only.
      operationId: list_api_keys_api_v1_api_keys__get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiKeyRead'
                type: array
                title: Response List Api Keys Api V1 Api Keys  Get
    post:
      tags:
      - api-keys
      summary: Create Api Key
      description: Mint a new API key. The plaintext secret is returned ONCE.
      operationId: create_api_key_api_v1_api_keys__post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiKeyCreate'
        required: true
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiKeyCreated'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/api-keys/{key_id}:
    delete:
      tags:
      - api-keys
      summary: Revoke Api Key
      description: Soft-revoke an API key (is_active → False).
      operationId: revoke_api_key_api_v1_api_keys__key_id__delete
      parameters:
      - name: key_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Key Id
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    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
    ApiKeyRead:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        name:
          type: string
          title: Name
        key_prefix:
          type: string
          title: Key Prefix
        is_active:
          type: boolean
          title: Is Active
        last_used_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Last Used At
        created_at:
          type: string
          format: date-time
          title: Created At
      type: object
      required:
      - id
      - name
      - key_prefix
      - is_active
      - last_used_at
      - created_at
      title: ApiKeyRead
      description: Returned when listing keys — never exposes the full key.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ApiKeyCreated:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        name:
          type: string
          title: Name
        key_prefix:
          type: string
          title: Key Prefix
        is_active:
          type: boolean
          title: Is Active
        last_used_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Last Used At
        created_at:
          type: string
          format: date-time
          title: Created At
        key:
          type: string
          title: Key
      type: object
      required:
      - id
      - name
      - key_prefix
      - is_active
      - last_used_at
      - created_at
      - key
      title: ApiKeyCreated
      description: Returned only on creation — includes the full key (shown once).
    ApiKeyCreate:
      properties:
        name:
          type: string
          maxLength: 100
          minLength: 1
          title: Name
      type: object
      required:
      - name
      title: ApiKeyCreate