Authz1 Limits API OpenAPI Spec (YAML)

openapi: 3.0.1
info:
  title: Authz1 Limits API
  description: Authz1 Limits API
  termsOfService: http://authz1.com/terms/
  contact:
    name: Authz1 Support
    url: http://www.authz1.com/contact
    email: support@authz1.com
  license:
    name: Authz1 Intellectual Property
    url: https://www.authz1.com
  version: 2.0.1
servers:
  - url: https://sandbox.authz1.com/v1
    description: Sandbox server
paths:
  /limits:
    get:
      description: >-
        Returns the limits which are effective for a transaction to be performed
        by the subject with the ID passed in the request
      operationId: checkLimits
      parameters:
        - name: subjectId
          in: query
          description: The ID of the subject
          required: true
          schema:
            type: string
        - name: actionId
          in: query
          description: The ID of the action to be performed
          required: true
          schema:
            type: string
        - name: resourceId
          in: query
          description: The ID of the resource the action is to be performed on
          required: true
          schema:
            type: string
        - name: trxDateTime
          in: query
          description: The date and time of the transaction
          required: true
          schema:
            type: string
        - name: trxId
          in: query
          description: The ID of the transaction
          required: true
          schema:
            type: string
        - name: trxAmount
          in: query
          description: The amount of the transaction
          required: true
          schema:
            type: string
        - name: unit
          in: query
          description: The unit of the transaction
          required: true
          schema:
            type: string
      responses:
        '200':
          description: List of limits and the overall result.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/limitsResponse'
        '400':
          description: Bad Request
          content:
            application/json: {}
        '404':
          description: Not Found
          content:
            application/json: {}
        '500':
          description: Internal Server Error
          content:
            application/json: {}
components:
  schemas:
    limitsResponse:
      type: object
      properties:
        userId:
          type: string
        transactionId:
          type: string
        transactionAmount:
          type: number
        unit:
          type: string
        actionId:
          type: string
        passLimits:
          type: array
          items:
            type: string
        result:
          type: boolean
        limits:
          type: array
          items:
            $ref: '#/components/schemas/limit'
    limit:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        type:
          type: string
        amount:
          type: number
        remainingAmount:
          type: number
        timePeriod:
          type: string
        actionId:
          type: string
        resourceId:
          type: string
        level:
          type: string
        subjectId:
          type: string
        subjectName:
          type: string
        withinLimit:
          type: boolean
        definedBy:
          type: string
        effective:
          type: boolean