AccountLimit.yaml

openapi: 3.0.3
info:
  title: I_AccountLimit_Service
  description:  The limits of a user account are queried via this interface
  version: 1.1.3
  ### 1.1.3
  # - removed operation setLimits for compatibility with KIM 1.5.2
  # - changed security to basic auth for compatibility with KIM 1.5.2
  # - changed dataTimeToLive maximum value for compatibility with KIM 1.5.2
  # - changed servers -url for compatibility with KIM 1.5.2
  ### 1.1.2
  # - changed servers -url
  # - adding new operation setLimits
  # - added object property AccountLimit.kasMailSizeThreshold
  # - added traceId to Error object
  ### 1.1.1
  # - changed minimum value for maxMailSize
  # - changed descriptions
  ### 1.1.0
  # - changed version number in server url
  # - removed quotation marks and added minimum value for maxMailSize
  ### 1.0.0
  # - initial Version of I_AccountLimit_Service

externalDocs:
  description: GitHub - documentation
  url: https://github.com/gematik/api-kim
servers:
- url: /AccountLimit/v1.1/
  # Die URL muss wie folgt gebildet werden:
  # https://<FQDN gemäß DNS-SD SRV RR>:<Port gemäß DNS-SD SRV RR><Base-path gemäß TXT RR><path gemäß yaml Datei>
  # Die SRV und TXT RR sind unter dem Resource Record Bezeichner <accmgr_service_name> zu finden.
tags:
- name: AccountLimit

paths:
  /limit:
    get:
      tags:
      - AccountLimit
      summary: Query the limits of an account
      description: Query the limits of an account
      operationId: getLimits

      responses:
        200:
          description: OK
             # Returning the metadata of a user account
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/AccountLimit'
        401:
          $ref: 'CommonSchemas.yaml#/components/responses/401'
        404:
          $ref: 'CommonSchemas.yaml#/components/responses/404'
        500:
          $ref: 'CommonSchemas.yaml#/components/responses/500'

components:
  schemas:
    AccountLimit:
      type: object
      properties:
        dataTimeToLive:
          type: integer
          minimum: 10
          maximum: 365
          default: 90
          example: 90
          description: Storage duration of emails on the mail server and attachments on the KAS backend service. Specified in days.
        maxMailSize:
          type: integer
          format: int64
          minimum: 734003200
          example: 734003200
          description: Sets the maximum size of a KIM email in bytes.
        quota:
          type: integer
          format: int64
          readOnly: true
          example: 160000000000
          description: Specifies the maximum storage volume for a user account.
        remainQuota:
          type: integer
          format: int64
          readOnly: true
          example: 112000000000
          description: Specifies the remaining storage volume for a user account.

  securitySchemes:
    KIMBasicAuth:
      $ref: 'CommonSchemas.yaml#/components/securitySchemes/KIMBasicAuth'