openapi: 3.2.0
info:
  contact:
    email: lxd@lists.canonical.com
    name: LXD upstream
    url: https://github.com/canonical/lxd
  description: 'This is the REST API used by all LXD clients.

    Internal endpoints aren''t included in this documentation.


    The LXD API is available over both a local unix+http and remote https API.

    Authentication for local users relies on group membership and access to the unix socket.

    For remote users, the default authentication method is TLS client.'
  license:
    name: AGPL-3.0-only
    url: https://www.gnu.org/licenses/agpl-3.0.en.html
  title: LXD external REST Warnings API
  version: '1.0'
tags:
- name: Warnings
paths:
  /1.0/warnings:
    get:
      description: Returns a list of warnings.
      operationId: warnings_get
      parameters:
      - description: Project name
        example: default
        in: query
        name: project
        schema:
          type: string
      responses:
        '200':
          description: Sync response
          content:
            application/json:
              schema:
                description: Sync response
                properties:
                  metadata:
                    description: List of endpoints
                    example: "[\n  \"/1.0/warnings/39c61a48-cc17-40ae-8248-4f7b4cadedf4\",\n  \"/1.0/warnings/951779a5-2820-4d96-b01e-88fe820e5310\"\n]"
                    items:
                      type: string
                    type: array
                  status:
                    description: Status description
                    example: Success
                    type: string
                  status_code:
                    description: Status code
                    example: 200
                    type: integer
                  type:
                    description: Response type
                    example: sync
                    type: string
                type: object
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: List the warnings
      tags:
      - Warnings
  /1.0/warnings/{uuid}:
    delete:
      description: Removes the warning.
      operationId: warning_delete
      responses:
        '200':
          $ref: '#/components/responses/EmptySyncResponse'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Delete the warning
      tags:
      - Warnings
    get:
      description: Gets a specific warning.
      operationId: warning_get
      responses:
        '200':
          description: Warning
          content:
            application/json:
              schema:
                description: Sync response
                properties:
                  metadata:
                    $ref: '#/components/schemas/Warning'
                  status:
                    description: Status description
                    example: Success
                    type: string
                  status_code:
                    description: Status code
                    example: 200
                    type: integer
                  type:
                    description: Response type
                    example: sync
                    type: string
                type: object
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Get the warning
      tags:
      - Warnings
    patch:
      description: Updates a subset of the warning status.
      operationId: warning_patch
      responses:
        '200':
          $ref: '#/components/responses/EmptySyncResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Partially update the warning
      tags:
      - Warnings
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WarningPut'
        description: Warning status
        required: true
    put:
      description: Updates the warning status.
      operationId: warning_put
      responses:
        '200':
          $ref: '#/components/responses/EmptySyncResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Update the warning
      tags:
      - Warnings
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WarningPut'
        description: Warning status
        required: true
  /1.0/warnings?recursion=1:
    get:
      description: Returns a list of warnings (structs).
      operationId: warnings_get_recursion1
      parameters:
      - description: Project name
        example: default
        in: query
        name: project
        schema:
          type: string
      responses:
        '200':
          description: API endpoints
          content:
            application/json:
              schema:
                description: Sync response
                properties:
                  metadata:
                    description: List of warnings
                    items:
                      $ref: '#/components/schemas/Warning'
                    type: array
                  status:
                    description: Status description
                    example: Success
                    type: string
                  status_code:
                    description: Status code
                    example: 200
                    type: integer
                  type:
                    description: Response type
                    example: sync
                    type: string
                type: object
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Get the warnings
      tags:
      - Warnings
components:
  responses:
    EmptySyncResponse:
      description: Empty sync response
      content:
        application/json:
          schema:
            properties:
              status:
                example: Success
                type: string
                x-go-name: Status
              status_code:
                example: 200
                format: int64
                type: integer
                x-go-name: StatusCode
              type:
                example: sync
                type: string
                x-go-name: Type
            type: object
    InternalServerError:
      description: Internal Server Error
      content:
        application/json:
          schema:
            properties:
              error:
                example: internal server error
                type: string
                x-go-name: Error
              error_code:
                example: 500
                format: int64
                type: integer
                x-go-name: ErrorCode
              type:
                example: error
                type: string
                x-go-name: Type
            type: object
    BadRequest:
      description: Bad Request
      content:
        application/json:
          schema:
            properties:
              error:
                example: bad request
                type: string
                x-go-name: Error
              error_code:
                example: 400
                format: int64
                type: integer
                x-go-name: ErrorCode
              type:
                example: error
                type: string
                x-go-name: Type
            type: object
    NotFound:
      description: Not found
      content:
        application/json:
          schema:
            properties:
              error:
                example: not found
                type: string
                x-go-name: Error
              error_code:
                example: 404
                format: int64
                type: integer
                x-go-name: ErrorCode
              type:
                example: error
                type: string
                x-go-name: Type
            type: object
    Forbidden:
      description: Forbidden
      content:
        application/json:
          schema:
            properties:
              error:
                example: not authorized
                type: string
                x-go-name: Error
              error_code:
                example: 403
                format: int64
                type: integer
                x-go-name: ErrorCode
              type:
                example: error
                type: string
                x-go-name: Type
            type: object
  schemas:
    WarningPut:
      properties:
        status:
          description: Status of the warning (new, acknowledged, or resolved)
          example: new
          type: string
          x-go-name: Status
      title: WarningPut represents the modifiable fields of a warning.
      type: object
      x-go-package: github.com/canonical/lxd/shared/api
    Warning:
      properties:
        count:
          description: The number of times this warning occurred
          example: 1
          format: int64
          type: integer
          x-go-name: Count
        entity_url:
          description: The entity affected by this warning
          example: /1.0/instances/c1?project=default
          type: string
          x-go-name: EntityURL
        first_seen_at:
          description: The first time this warning occurred
          example: '2021-03-23T17:38:37.753398689-04:00'
          format: date-time
          type: string
          x-go-name: FirstSeenAt
        last_message:
          description: The warning message
          example: Couldn't find the CGroup blkio.weight, disk priority will be ignored
          type: string
          x-go-name: LastMessage
        last_seen_at:
          description: The last time this warning occurred
          example: '2021-03-23T17:38:37.753398689-04:00'
          format: date-time
          type: string
          x-go-name: LastSeenAt
        location:
          description: What cluster member this warning occurred on
          example: node1
          type: string
          x-go-name: Location
        project:
          description: The project the warning occurred in
          example: default
          type: string
          x-go-name: Project
        severity:
          description: The severity of this warning
          example: low
          type: string
          x-go-name: Severity
        status:
          description: Status of the warning (new, acknowledged, or resolved)
          example: new
          type: string
          x-go-name: Status
        type:
          description: Type type of warning
          example: Couldn't find CGroup
          type: string
          x-go-name: Type
        uuid:
          description: UUID of the warning
          example: e9e9da0d-2538-4351-8047-46d4a8ae4dbb
          type: string
          x-go-name: UUID
      title: Warning represents a warning entry.
      type: object
      x-go-package: github.com/canonical/lxd/shared/api