IBM WebSphere Features API

openapi: 3.1.0
info:
  title: Open Liberty APIs Applications Features API
  description: Open Liberty provides application programming interfaces that extend and complement Jakarta EE and MicroProfile APIs. Includes APIs for security, admin connectors, batch processing, messaging, health checking, metrics, OpenAPI documentation, and more. Open Liberty is the open-source foundation for WebSphere Liberty.
  version: 24.0.0
  license:
    name: Eclipse Public License 1.0
    url: https://www.eclipse.org/legal/epl-v10.html
  contact:
    name: Open Liberty Community
    url: https://openliberty.io/
servers:
- url: https://localhost:9443
  description: Default Open Liberty Server
security:
- basicAuth: []
tags:
- name: Features
  description: Liberty feature management
paths:
  /features:
    get:
      operationId: listFeatures
      summary: List Installed Features
      description: Returns a list of all Liberty features installed on the server.
      tags:
      - Features
      responses:
        '200':
          description: List of installed features
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Feature'
              examples:
                Listfeatures200Example:
                  summary: Default listFeatures 200 response
                  x-microcks-default: true
                  value:
                  - name: Example Title
                    displayName: example_value
                    version: example_value
                    description: A sample description.
                    enabled: true
                    dependencies:
                    - example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /features/{featureName}:
    get:
      operationId: getFeature
      summary: Get Feature Details
      description: Returns details of a specific Liberty feature.
      tags:
      - Features
      parameters:
      - name: featureName
        in: path
        required: true
        description: Feature symbolic name
        schema:
          type: string
        example: example_value
      responses:
        '200':
          description: Feature details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Feature'
              examples:
                Getfeature200Example:
                  summary: Default getFeature 200 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    displayName: example_value
                    version: example_value
                    description: A sample description.
                    enabled: true
                    dependencies:
                    - example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  responses:
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Feature:
      type: object
      properties:
        name:
          type: string
          description: Feature symbolic name
          example: Example Title
        displayName:
          type: string
          description: Human-readable feature name
          example: example_value
        version:
          type: string
          description: Feature version
          example: example_value
        description:
          type: string
          description: Feature description
          example: A sample description.
        enabled:
          type: boolean
          description: Whether the feature is currently enabled
          example: true
        dependencies:
          type: array
          items:
            type: string
          description: List of dependent feature names
          example: []
    Error:
      type: object
      properties:
        code:
          type: string
          example: example_value
        message:
          type: string
          example: example_value
        details:
          type: string
          example: example_value
      required:
      - code
      - message
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication
    jwtAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: MicroProfile JWT authentication
externalDocs:
  description: Open Liberty API Reference
  url: https://openliberty.io/docs/latest/reference/api/open-liberty-apis.html