schema.yml

openapi: 3.0.3
info:
  title: Firewall Rule Center API
  version: 1.0.3
  description: Documents your firewall rules
paths:
  /api/auth/:
    post:
      operationId: auth_create
      tags:
      - auth
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/AuthTokenRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/AuthTokenRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/AuthTokenRequest'
        required: true
      security:
      - jwtAuth: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthToken'
          description: ''
  /api/firewalls/:
    get:
      operationId: firewalls_list
      tags:
      - firewalls
      security:
      - jwtAuth: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FirewallObject'
          description: ''
  /api/firewalls/{hostname}/:
    get:
      operationId: firewalls_retrieve
      parameters:
      - in: path
        name: hostname
        schema:
          type: string
        description: A unique value identifying this firewall object.
        required: true
      tags:
      - firewalls
      security:
      - jwtAuth: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FirewallObject'
          description: ''
  /api/rules/:
    get:
      operationId: rules_list
      tags:
      - rules
      security:
      - jwtAuth: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Rule'
          description: ''
    post:
      operationId: rules_create
      tags:
      - rules
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RuleRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/RuleRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/RuleRequest'
        required: true
      security:
      - jwtAuth: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Rule'
          description: ''
  /api/rules/{id}/:
    get:
      operationId: rules_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - rules
      security:
      - jwtAuth: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Rule'
          description: ''
  /api/rules/{id}/delete/:
    delete:
      operationId: rules_delete_destroy
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - rules
      security:
      - jwtAuth: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '204':
          description: No response body
  /api/rules/{id}/update/:
    put:
      operationId: rules_update_update
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - rules
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RuleRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/RuleRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/RuleRequest'
        required: true
      security:
      - jwtAuth: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Rule'
          description: ''
    patch:
      operationId: rules_update_partial_update
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - rules
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedRuleRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedRuleRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedRuleRequest'
      security:
      - jwtAuth: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Rule'
          description: ''
  /api/rules/import/:
    post:
      operationId: rules_import_create
      tags:
      - rules
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/RuleRequest'
        required: true
      security:
      - jwtAuth: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Rule'
          description: ''
  /api/rules/requests/:
    get:
      operationId: rules_requests_list
      tags:
      - rules
      security:
      - jwtAuth: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RuleSetRequest'
          description: ''
    post:
      operationId: rules_requests_create
      tags:
      - rules
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RuleSetRequestRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/RuleSetRequestRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/RuleSetRequestRequest'
        required: true
      security:
      - jwtAuth: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RuleSetRequest'
          description: ''
  /api/rules/requests/{id}/:
    get:
      operationId: rules_requests_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - rules
      security:
      - jwtAuth: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RuleSetRequest'
          description: ''
  /api/rules/requests/{id}/approve/:
    get:
      operationId: rules_requests_approve_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - rules
      security:
      - jwtAuth: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RuleSetRequest'
          description: ''
  /api/rules/requests/{id}/refuse/:
    get:
      operationId: rules_requests_refuse_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - rules
      security:
      - jwtAuth: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RuleSetRequest'
          description: ''
  /api/token/:
    post:
      operationId: token_create
      description: |-
        Takes a set of user credentials and returns an access and refresh JSON web
        token pair to prove the authentication of those credentials.
      tags:
      - token
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TokenObtainPairRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/TokenObtainPairRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/TokenObtainPairRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TokenObtainPair'
          description: ''
  /api/token/refresh/:
    post:
      operationId: token_refresh_create
      description: |-
        Takes a refresh type JSON web token and returns an access type JSON web
        token if the refresh token is valid.
      tags:
      - token
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TokenRefreshRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/TokenRefreshRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/TokenRefreshRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TokenRefresh'
          description: ''
  /api/token/verify/:
    post:
      operationId: token_verify_create
      description: |-
        Takes a token and indicates if it is valid.  This view provides no
        information about a token's fitness for a particular use.
      tags:
      - token
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TokenVerifyRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/TokenVerifyRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/TokenVerifyRequest'
        required: true
      responses:
        '200':
          description: No response body
  /api/users/:
    get:
      operationId: users_list
      tags:
      - users
      security:
      - jwtAuth: []
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UserPublic'
          description: ''
components:
  schemas:
    ActionEnum:
      enum:
      - PER
      - DEN
      type: string
      description: |-
        * `PER` - Permit
        * `DEN` - Deny
    AuthToken:
      type: object
      properties:
        token:
          type: string
          readOnly: true
      required:
      - token
    AuthTokenRequest:
      type: object
      properties:
        username:
          type: string
          writeOnly: true
          minLength: 1
        password:
          type: string
          writeOnly: true
          minLength: 1
      required:
      - password
      - username
    FirewallObject:
      type: object
      properties:
        hostname:
          type: string
          maxLength: 50
        vendor:
          type: string
          maxLength: 50
        detail_url:
          type: string
          format: uri
          readOnly: true
        history:
          type: array
          items:
            type: object
            additionalProperties: {}
          readOnly: true
      required:
      - detail_url
      - history
      - hostname
      - vendor
    FirewallObjectShort:
      type: object
      properties:
        hostname:
          type: string
          maxLength: 50
      required:
      - hostname
    FirewallObjectShortRequest:
      type: object
      properties:
        hostname:
          type: string
          minLength: 1
          maxLength: 50
      required:
      - hostname
    PatchedRuleRequest:
      type: object
      properties:
        action:
          $ref: '#/components/schemas/ActionEnum'
        protocol:
          $ref: '#/components/schemas/ProtocolEnum'
        source_name:
          type: string
          minLength: 1
          maxLength: 100
        source_ip_orig:
          type: string
        source_ip_nat:
          type: string
        source_port:
          type: integer
          maximum: 4294967295
          minimum: 0
          format: int64
          nullable: true
        destination_name:
          type: string
          minLength: 1
          maxLength: 100
        destination_ip_orig:
          type: string
        destination_ip_nat:
          type: string
        destination_port:
          type: integer
          maximum: 4294967295
          minimum: 0
          format: int64
          nullable: true
        requester:
          type: string
          minLength: 1
          maxLength: 70
        ticket:
          type: string
          maxLength: 20
        rule_set_request:
          type: integer
          nullable: true
        notes:
          type: string
          maxLength: 200
        firewalls:
          type: array
          items:
            $ref: '#/components/schemas/FirewallObjectShortRequest'
        status:
          $ref: '#/components/schemas/RuleStatusEnum'
        is_deleted:
          type: boolean
    ProtocolEnum:
      enum:
      - TCP
      - UDP
      - TCPUDP
      - ICMP
      - IP
      type: string
      description: |-
        * `TCP` - TCP
        * `UDP` - UDP
        * `TCPUDP` - TCP and UDP
        * `ICMP` - ICMP
        * `IP` - IP
    Rule:
      type: object
      properties:
        pk:
          type: integer
          readOnly: true
          title: ID
        action:
          $ref: '#/components/schemas/ActionEnum'
        protocol:
          $ref: '#/components/schemas/ProtocolEnum'
        source_name:
          type: string
          maxLength: 100
        source_ip_orig:
          type: string
        source_ip_nat:
          type: string
        source_port:
          type: integer
          maximum: 4294967295
          minimum: 0
          format: int64
          nullable: true
        destination_name:
          type: string
          maxLength: 100
        destination_ip_orig:
          type: string
        destination_ip_nat:
          type: string
        destination_port:
          type: integer
          maximum: 4294967295
          minimum: 0
          format: int64
          nullable: true
        requester:
          type: string
          maxLength: 70
        ticket:
          type: string
          maxLength: 20
        rule_set_request:
          type: integer
          nullable: true
        notes:
          type: string
          maxLength: 200
        firewalls:
          type: array
          items:
            $ref: '#/components/schemas/FirewallObjectShort'
        status:
          $ref: '#/components/schemas/RuleStatusEnum'
        created_on:
          type: string
          format: date-time
          readOnly: true
        created_by:
          allOf:
          - $ref: '#/components/schemas/UserPublic'
          readOnly: true
        last_updated_on:
          type: string
          format: date-time
          readOnly: true
        last_updated_by:
          allOf:
          - $ref: '#/components/schemas/UserPublic'
          readOnly: true
        is_deleted:
          type: boolean
        detail_url:
          type: string
          format: uri
          readOnly: true
        edit_url:
          type: string
          format: uri
          readOnly: true
        delete_url:
          type: string
          format: uri
          readOnly: true
        history:
          type: array
          items:
            type: object
            additionalProperties: {}
          readOnly: true
      required:
      - action
      - created_by
      - created_on
      - delete_url
      - destination_name
      - detail_url
      - edit_url
      - history
      - last_updated_by
      - last_updated_on
      - pk
      - protocol
      - requester
      - source_name
      - status
    RuleRequest:
      type: object
      properties:
        action:
          $ref: '#/components/schemas/ActionEnum'
        protocol:
          $ref: '#/components/schemas/ProtocolEnum'
        source_name:
          type: string
          minLength: 1
          maxLength: 100
        source_ip_orig:
          type: string
        source_ip_nat:
          type: string
        source_port:
          type: integer
          maximum: 4294967295
          minimum: 0
          format: int64
          nullable: true
        destination_name:
          type: string
          minLength: 1
          maxLength: 100
        destination_ip_orig:
          type: string
        destination_ip_nat:
          type: string
        destination_port:
          type: integer
          maximum: 4294967295
          minimum: 0
          format: int64
          nullable: true
        requester:
          type: string
          minLength: 1
          maxLength: 70
        ticket:
          type: string
          maxLength: 20
        rule_set_request:
          type: integer
          nullable: true
        notes:
          type: string
          maxLength: 200
        firewalls:
          type: array
          items:
            $ref: '#/components/schemas/FirewallObjectShortRequest'
        status:
          $ref: '#/components/schemas/RuleStatusEnum'
        is_deleted:
          type: boolean
      required:
      - action
      - destination_name
      - protocol
      - requester
      - source_name
      - status
    RuleSetRequest:
      type: object
      properties:
        pk:
          type: integer
          readOnly: true
          title: ID
        related_rules:
          type: array
          items:
            $ref: '#/components/schemas/Rule'
          readOnly: true
        status:
          allOf:
          - $ref: '#/components/schemas/RuleSetStatusEnum'
          readOnly: true
        approver:
          $ref: '#/components/schemas/UserPublic'
        created_on:
          type: string
          format: date-time
          readOnly: true
        created_by:
          allOf:
          - $ref: '#/components/schemas/UserPublic'
          readOnly: true
        last_updated_on:
          type: string
          format: date-time
          readOnly: true
        last_updated_by:
          allOf:
          - $ref: '#/components/schemas/UserPublic'
          readOnly: true
        detail_url:
          type: string
          format: uri
          readOnly: true
        approve_url:
          type: string
          format: uri
          readOnly: true
        refuse_url:
          type: string
          format: uri
          readOnly: true
        history:
          type: array
          items:
            type: object
            additionalProperties: {}
          readOnly: true
      required:
      - approve_url
      - approver
      - created_by
      - created_on
      - detail_url
      - history
      - last_updated_by
      - last_updated_on
      - pk
      - refuse_url
      - related_rules
      - status
    RuleSetRequestRequest:
      type: object
      properties:
        approver:
          $ref: '#/components/schemas/UserPublicRequest'
      required:
      - approver
    RuleSetStatusEnum:
      enum:
      - REQ
      - REF
      - APR
      - CON
      type: string
      description: |-
        * `REQ` - RuleSetRequest requested
        * `REF` - RuleSetRequest refused
        * `APR` - RuleSetRequest approved
        * `CON` - All rules in this RuleSetRequest configured
    RuleStatusEnum:
      enum:
      - REQ
      - REF
      - APR
      - CON
      - TES
      - DEL
      type: string
      description: |-
        * `REQ` - Rule requested
        * `REF` - Rule refused
        * `APR` - Rule approved
        * `CON` - Rule configured
        * `TES` - Rule tested
        * `DEL` - Rule deleted
    TokenObtainPair:
      type: object
      properties:
        access:
          type: string
          readOnly: true
        refresh:
          type: string
          readOnly: true
      required:
      - access
      - refresh
    TokenObtainPairRequest:
      type: object
      properties:
        username:
          type: string
          writeOnly: true
          minLength: 1
        password:
          type: string
          writeOnly: true
          minLength: 1
      required:
      - password
      - username
    TokenRefresh:
      type: object
      properties:
        access:
          type: string
          readOnly: true
        refresh:
          type: string
      required:
      - access
      - refresh
    TokenRefreshRequest:
      type: object
      properties:
        refresh:
          type: string
          minLength: 1
      required:
      - refresh
    TokenVerifyRequest:
      type: object
      properties:
        token:
          type: string
          writeOnly: true
          minLength: 1
      required:
      - token
    UserPublic:
      type: object
      properties:
        id:
          type: integer
        username:
          type: string
      required:
      - id
      - username
    UserPublicRequest:
      type: object
      properties:
        id:
          type: integer
        username:
          type: string
          minLength: 1
      required:
      - id
      - username
  securitySchemes:
    cookieAuth:
      type: apiKey
      in: cookie
      name: sessionid
    jwtAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    tokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Token-based authentication with required prefix "Token"