openapi: 3.0.1
info:
  title: IOM Cache Management REST API
  description: Cache operations to manage application caches.
  contact:
    name: Intershop Communications AG
    url: http://intershop.com
  version: "1.0"
servers:
- url: '{protocol}://{domain}:{port}/servlets/services/caches'
  variables:
    protocol:
      default: http
      enum:
      - http
      - https
    domain:
      default: localhost
    port:
      default: "8080"
security:
- basicAuth: []
- bearerAuth: []
paths:
  /caches/{cacheName}:
    get:
      tags:
      - Cache Management
      summary: Returns the statuses of the given cache name for all server nodes.
      description: Returns the statuses of the given cache name for all server nodes.
      operationId: getCacheStatus
      parameters:
      - name: cacheName
        in: path
        description: Name of the cache the action should be processed for.
        required: true
        schema:
          type: string
          enum:
          - bakery-cache-config
      responses:
        "200":
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HttpResponseImplListCacheStateDO'
        "401":
          description: Unauthorized or Forbidden.
        "500":
          description: Internal server error.
    delete:
      tags:
      - Cache Management
      summary: 'Requests to clear a given cache on all server nodes. '
      description: Requests to clear a given cache on all server nodes. The cache
        clear will be processed asynchronously from all server nodes.
      operationId: deleteCache
      parameters:
      - name: cacheName
        in: path
        description: Name of the cache the action should be processed for.
        required: true
        schema:
          type: string
          enum:
          - bakery-cache-config
      responses:
        "200":
          description: The request has succeeded.
        "401":
          description: Unauthorized or Forbidden
        "500":
          description: Internal server error.
  /caches:
    get:
      tags:
      - Cache Management
      summary: Returns the statuses for all cache for all server nodes.
      description: Returns the statuses for all cache for all server nodes.
      operationId: getCacheStates
      responses:
        "200":
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HttpResponseImplListCacheStateDO'
        "401":
          description: Unauthorized or Forbidden.
        "500":
          description: Internal server error.
components:
  schemas:
    CacheStateDO:
      type: object
      properties:
        id:
          type: integer
          format: int64
        cacheName:
          type: string
          description: Name of the cache
          example: bakery-cache-config
        clearDate:
          type: string
          description: Timestamp of the last cache clear for the cache and the server
          format: date-time
        action:
          type: string
          description: Specifies under which circumstances the cache was cleared.
            A server startup as a clean cache after server startup or requested as
            the cache was cleared by a request
          example: server startup
          enum:
          - server startup
          - requested
        serverId:
          type: string
          description: Unique identifier for a server
          example: BACKEND_0.0.0.0
      description: Represents the current status of a cache on a server.
    CodedException:
      type: object
      properties:
        message:
          type: string
        code:
          type: string
    FieldError:
      type: object
      properties:
        message:
          type: string
        sourceField:
          type: string
    HttpResponseImplListCacheStateDO:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/CacheStateDO'
        statusCode:
          type: integer
          format: int32
        errors:
          type: array
          items:
            $ref: '#/components/schemas/FieldError'
        exceptions:
          type: array
          items:
            $ref: '#/components/schemas/CodedException'
  securitySchemes:
    basicAuth:
      type: http
      description: Basic Authentication
      scheme: basic