IBM WebSphere Repositories API

openapi: 3.2.0
info:
  title: WebSphere Liberty Collective Controller REST Repositories API
  description: API for managing Liberty collective environments, including member management, scaling, centralized administration, and cluster operations. Supports subscription-based notifications for API changes across collective members. The collective controller coordinates multiple Liberty servers for centralized management and workload distribution.
  version: 24.0.0
  license:
    name: IBM International License Agreement
    url: https://www.ibm.com/legal/terms
  contact:
    name: IBM Support
    url: https://www.ibm.com/mysupport
servers:
- url: https://localhost:9443/ibm/api/collective
  description: Default Liberty Collective Controller
security:
- basicAuth: []
tags:
- name: Repositories
  description: Shared configuration repository management
paths:
  /repository/config:
    get:
      operationId: listSharedConfigs
      summary: List Shared Configurations
      description: Returns a list of shared configurations in the collective repository.
      tags:
      - Repositories
      responses:
        '200':
          description: List of shared configurations
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SharedConfig'
              examples:
                Listsharedconfigs200Example:
                  summary: Default listSharedConfigs 200 response
                  x-microcks-default: true
                  value:
                  - name: Example Title
                    description: A sample description.
                    content: example_value
                    lastModified: '2026-01-15T10:30:00Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createSharedConfig
      summary: Create a Shared Configuration
      description: Creates a new shared configuration in the repository.
      tags:
      - Repositories
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SharedConfig'
            examples:
              CreatesharedconfigRequestExample:
                summary: Default createSharedConfig request
                x-microcks-default: true
                value:
                  name: Example Title
                  description: A sample description.
                  content: example_value
                  lastModified: '2026-01-15T10:30:00Z'
      responses:
        '201':
          description: Shared configuration created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SharedConfig'
              examples:
                Createsharedconfig201Example:
                  summary: Default createSharedConfig 201 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    description: A sample description.
                    content: example_value
                    lastModified: '2026-01-15T10:30:00Z'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  responses:
    Unauthorized:
      description: Authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    BadRequest:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      properties:
        code:
          type: string
          example: example_value
        message:
          type: string
          example: example_value
      required:
      - code
      - message
    SharedConfig:
      type: object
      properties:
        name:
          type: string
          description: Configuration name
          example: Example Title
        description:
          type: string
          example: A sample description.
        content:
          type: string
          description: Configuration XML content
          example: example_value
        lastModified:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication with administrator role
externalDocs:
  description: Liberty Collective REST API Documentation
  url: https://www.ibm.com/docs/en/was-liberty/base?topic=liberty-collective-rest-api