WebSphere Liberty Admin REST API — Configuration

naftiko: 1.0.0-alpha2
info:
  label: WebSphere Liberty Admin REST API — Configuration
  description: 'WebSphere Liberty Admin REST API — Configuration. 7 operations. Lead operation: Get Server Configuration.
    Self-contained Naftiko capability covering one Websphere business surface.'
  tags:
  - Websphere
  - Configuration
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    WEBSPHERE_API_KEY: WEBSPHERE_API_KEY
capability:
  consumes:
  - type: http
    namespace: liberty-admin-rest-configuration
    baseUri: https://localhost:9443/ibm/api
    description: WebSphere Liberty Admin REST API — Configuration business capability. Self-contained, no shared references.
    resources:
    - name: config
      path: /config
      operations:
      - name: getserverconfig
        method: GET
        description: Get Server Configuration
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: depth
          in: query
          type: integer
          description: Depth of nested configuration elements to include
      - name: updateserverconfig
        method: PUT
        description: Update Server Configuration
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: config-elementName
      path: /config/{elementName}
      operations:
      - name: getconfigelement
        method: GET
        description: Get a Specific Configuration Element
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: elementName
          in: path
          type: string
          description: Configuration element name (e.g., httpEndpoint, dataSource, application)
          required: true
      - name: createconfigelement
        method: POST
        description: Create a Configuration Element
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: elementName
          in: path
          type: string
          description: Configuration element name
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: config-elementName-uid
      path: /config/{elementName}/{uid}
      operations:
      - name: getconfigelementbyid
        method: GET
        description: Get a Specific Configuration Element Instance
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: elementName
          in: path
          type: string
          required: true
        - name: uid
          in: path
          type: string
          description: Unique identifier of the configuration element
          required: true
      - name: updateconfigelement
        method: PUT
        description: Update a Configuration Element Instance
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: elementName
          in: path
          type: string
          required: true
        - name: uid
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteconfigelement
        method: DELETE
        description: Delete a Configuration Element Instance
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: elementName
          in: path
          type: string
          required: true
        - name: uid
          in: path
          type: string
          required: true
    authentication:
      type: apikey
      key: LtpaToken2
      value: '{{env.WEBSPHERE_API_KEY}}'
      placement: cookie
  exposes:
  - type: rest
    namespace: liberty-admin-rest-configuration-rest
    port: 8080
    description: REST adapter for WebSphere Liberty Admin REST API — Configuration. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/config
      name: config
      description: REST surface for config.
      operations:
      - method: GET
        name: getserverconfig
        description: Get Server Configuration
        call: liberty-admin-rest-configuration.getserverconfig
        with:
          depth: rest.depth
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateserverconfig
        description: Update Server Configuration
        call: liberty-admin-rest-configuration.updateserverconfig
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/config/{elementname}
      name: config-elementname
      description: REST surface for config-elementName.
      operations:
      - method: GET
        name: getconfigelement
        description: Get a Specific Configuration Element
        call: liberty-admin-rest-configuration.getconfigelement
        with:
          elementName: rest.elementName
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createconfigelement
        description: Create a Configuration Element
        call: liberty-admin-rest-configuration.createconfigelement
        with:
          elementName: rest.elementName
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/config/{elementname}/{uid}
      name: config-elementname-uid
      description: REST surface for config-elementName-uid.
      operations:
      - method: GET
        name: getconfigelementbyid
        description: Get a Specific Configuration Element Instance
        call: liberty-admin-rest-configuration.getconfigelementbyid
        with:
          elementName: rest.elementName
          uid: rest.uid
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateconfigelement
        description: Update a Configuration Element Instance
        call: liberty-admin-rest-configuration.updateconfigelement
        with:
          elementName: rest.elementName
          uid: rest.uid
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteconfigelement
        description: Delete a Configuration Element Instance
        call: liberty-admin-rest-configuration.deleteconfigelement
        with:
          elementName: rest.elementName
          uid: rest.uid
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: liberty-admin-rest-configuration-mcp
    port: 9090
    transport: http
    description: MCP adapter for WebSphere Liberty Admin REST API — Configuration. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: get-server-configuration
      description: Get Server Configuration
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: liberty-admin-rest-configuration.getserverconfig
      with:
        depth: tools.depth
      outputParameters:
      - type: object
        mapping: $.
    - name: update-server-configuration
      description: Update Server Configuration
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: liberty-admin-rest-configuration.updateserverconfig
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-specific-configuration-element
      description: Get a Specific Configuration Element
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: liberty-admin-rest-configuration.getconfigelement
      with:
        elementName: tools.elementName
      outputParameters:
      - type: object
        mapping: $.
    - name: create-configuration-element
      description: Create a Configuration Element
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: liberty-admin-rest-configuration.createconfigelement
      with:
        elementName: tools.elementName
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-specific-configuration-element-instance
      description: Get a Specific Configuration Element Instance
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: liberty-admin-rest-configuration.getconfigelementbyid
      with:
        elementName: tools.elementName
        uid: tools.uid
      outputParameters:
      - type: object
        mapping: $.
    - name: update-configuration-element-instance
      description: Update a Configuration Element Instance
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: liberty-admin-rest-configuration.updateconfigelement
      with:
        elementName: tools.elementName
        uid: tools.uid
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-configuration-element-instance
      description: Delete a Configuration Element Instance
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: liberty-admin-rest-configuration.deleteconfigelement
      with:
        elementName: tools.elementName
        uid: tools.uid
      outputParameters:
      - type: object
        mapping: $.