Oracle Essbase REST API — Server

naftiko: 1.0.0-alpha2
info:
  label: Oracle Essbase REST API — Server
  description: 'Oracle Essbase REST API — Server. 4 operations. Lead operation: Oracle Essbase Get About Essbase. Self-contained
    Naftiko capability covering one Oracle Essbase business surface.'
  tags:
  - Oracle Essbase
  - Server
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ORACLE_ESSBASE_API_KEY: ORACLE_ESSBASE_API_KEY
capability:
  consumes:
  - type: http
    namespace: rest-server
    baseUri: https://{host}:{port}/essbase/rest/v1
    description: Oracle Essbase REST API — Server business capability. Self-contained, no shared references.
    resources:
    - name: about
      path: /about
      operations:
      - name: getaboutessbase
        method: GET
        description: Oracle Essbase Get About Essbase
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: about-instance
      path: /about/instance
      operations:
      - name: getaboutessbaseinstance
        method: GET
        description: Oracle Essbase Get About Essbase Instance
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: properties
      path: /properties
      operations:
      - name: listserverproperties
        method: GET
        description: Oracle Essbase List Server Properties
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateserverproperties
        method: PUT
        description: Oracle Essbase Update Server Properties
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: bearer
      token: '{{env.ORACLE_ESSBASE_API_KEY}}'
  exposes:
  - type: rest
    namespace: rest-server-rest
    port: 8080
    description: REST adapter for Oracle Essbase REST API — Server. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/about
      name: about
      description: REST surface for about.
      operations:
      - method: GET
        name: getaboutessbase
        description: Oracle Essbase Get About Essbase
        call: rest-server.getaboutessbase
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/about/instance
      name: about-instance
      description: REST surface for about-instance.
      operations:
      - method: GET
        name: getaboutessbaseinstance
        description: Oracle Essbase Get About Essbase Instance
        call: rest-server.getaboutessbaseinstance
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/properties
      name: properties
      description: REST surface for properties.
      operations:
      - method: GET
        name: listserverproperties
        description: Oracle Essbase List Server Properties
        call: rest-server.listserverproperties
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateserverproperties
        description: Oracle Essbase Update Server Properties
        call: rest-server.updateserverproperties
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: rest-server-mcp
    port: 9090
    transport: http
    description: MCP adapter for Oracle Essbase REST API — Server. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: oracle-essbase-get-about-essbase
      description: Oracle Essbase Get About Essbase
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-server.getaboutessbase
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-essbase-get-about-essbase-2
      description: Oracle Essbase Get About Essbase Instance
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-server.getaboutessbaseinstance
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-essbase-list-server-properties
      description: Oracle Essbase List Server Properties
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-server.listserverproperties
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-essbase-update-server-properties
      description: Oracle Essbase Update Server Properties
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: rest-server.updateserverproperties
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.