Apache Ranger REST API — Services

naftiko: 1.0.0-alpha2
info:
  label: Apache Ranger REST API — Services
  description: 'Apache Ranger REST API — Services. 4 operations. Lead operation: Apache Ranger List Services. Self-contained
    Naftiko capability covering one Apache Ranger business surface.'
  tags:
  - Apache Ranger
  - Services
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    APACHE_RANGER_API_KEY: APACHE_RANGER_API_KEY
capability:
  consumes:
  - type: http
    namespace: rest-services
    baseUri: https://ranger.example.com/service
    description: Apache Ranger REST API — Services business capability. Self-contained, no shared references.
    resources:
    - name: plugins-services
      path: /plugins/services
      operations:
      - name: listservices
        method: GET
        description: Apache Ranger List Services
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createservice
        method: POST
        description: Apache Ranger Create Service
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: plugins-services-id
      path: /plugins/services/{id}
      operations:
      - name: getservice
        method: GET
        description: Apache Ranger Get Service
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          required: true
      - name: deleteservice
        method: DELETE
        description: Apache Ranger Delete Service
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          required: true
    authentication:
      type: basic
      username: '{{env.APACHE_RANGER_USER}}'
      password: '{{env.APACHE_RANGER_PASS}}'
  exposes:
  - type: rest
    namespace: rest-services-rest
    port: 8080
    description: REST adapter for Apache Ranger REST API — Services. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/plugins/services
      name: plugins-services
      description: REST surface for plugins-services.
      operations:
      - method: GET
        name: listservices
        description: Apache Ranger List Services
        call: rest-services.listservices
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createservice
        description: Apache Ranger Create Service
        call: rest-services.createservice
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/plugins/services/{id}
      name: plugins-services-id
      description: REST surface for plugins-services-id.
      operations:
      - method: GET
        name: getservice
        description: Apache Ranger Get Service
        call: rest-services.getservice
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteservice
        description: Apache Ranger Delete Service
        call: rest-services.deleteservice
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: rest-services-mcp
    port: 9090
    transport: http
    description: MCP adapter for Apache Ranger REST API — Services. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: apache-ranger-list-services
      description: Apache Ranger List Services
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-services.listservices
      outputParameters:
      - type: object
        mapping: $.
    - name: apache-ranger-create-service
      description: Apache Ranger Create Service
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-services.createservice
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: apache-ranger-get-service
      description: Apache Ranger Get Service
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-services.getservice
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: apache-ranger-delete-service
      description: Apache Ranger Delete Service
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: rest-services.deleteservice
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.