openapi: 3.2.0
info:
  title: Online Store IP Blacklist API
  version: '1.0'
  description: Online Store API
servers:
- url: https://www.yoursite.com/api/v1
  description: ''
security:
- X-AC-Auth-Token: []
tags:
- name: IP Blacklist
paths:
  /blacklisted_ips:
    get:
      summary: Get IP Blacklist
      tags:
      - IP Blacklist
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  blacklisted_ips:
                    type: array
                    items:
                      $ref: '#/components/schemas/blacklisted_ips'
      operationId: get-blacklisted_ips
      description: Gets an array of IP blacklist items.
    post:
      summary: Create an IP Blacklist Item
      operationId: post-blacklisted_ips
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/blacklisted_ips'
      tags:
      - IP Blacklist
      description: Creates an IP blacklist item.
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              properties:
                ip_address:
                  type: string
                description:
                  type: string
            examples:
              Example:
                value:
                  ip_address: 12.34.56.78
                  description: ''
  /blacklisted_ips/{id}:
    parameters:
    - schema:
        type: integer
      name: id
      in: path
      required: true
      description: The ID of the `blacklisted_ips`
    put:
      summary: Update an IP Blacklist Item
      operationId: put-blacklisted_ips-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/blacklisted_ips'
      tags:
      - IP Blacklist
      description: Updates an IP blacklist item.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/blacklisted_ips'
    delete:
      summary: Delete an IP Blacklist Item
      operationId: delete-blacklisted_ips-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      tags:
      - IP Blacklist
      description: Deletes an IP blacklist item.
components:
  responses:
    '404':
      description: Resource Not Found
      content:
        application/json:
          schema:
            description: Not Found
            type: object
            x-examples:
              example-1:
                status_code: 404
                message: Not Found
                details: No resource found
            properties:
              status_code:
                type: number
              message:
                type: string
              details:
                type: string
          examples: {}
      headers: {}
  schemas:
    blacklisted_ips:
      type: object
      properties:
        id:
          type: integer
        ip_address:
          type: string
        hit_count:
          type: integer
        last_hit_at:
          type: string
        user_agent:
          type: string
        description:
          type: string
  securitySchemes:
    X-AC-Auth-Token:
      name: X-AC-Auth-Token
      type: apiKey
      in: header