Oracle REST Data Services (ORDS) REST API — Roles

naftiko: 1.0.0-alpha2
info:
  label: Oracle REST Data Services (ORDS) REST API — Roles
  description: 'Oracle REST Data Services (ORDS) REST API — Roles. 6 operations. Lead operation: Get all ORDS roles. Self-contained
    Naftiko capability covering one Oracle Apex business surface.'
  tags:
  - Oracle Apex
  - Roles
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ORACLE_APEX_API_KEY: ORACLE_APEX_API_KEY
capability:
  consumes:
  - type: http
    namespace: ords-rest-roles
    baseUri: https://{host}:{port}/ords/_/db-api/stable
    description: Oracle REST Data Services (ORDS) REST API — Roles business capability. Self-contained, no shared references.
    resources:
    - name: ords-rest-roles
      path: /ords/rest/roles/
      operations:
      - name: listroles
        method: GET
        description: Get all ORDS roles
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createrole
        method: POST
        description: Create an ORDS role
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: ords-rest-roles-id
      path: /ords/rest/roles/{id}
      operations:
      - name: getrole
        method: GET
        description: Get an ORDS role
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updaterole
        method: PUT
        description: Update an ORDS role
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleterole
        method: DELETE
        description: Delete an ORDS role
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: ords-rest-roles-id-privileges
      path: /ords/rest/roles/{id}/privileges/
      operations:
      - name: listroleprivileges
        method: GET
        description: Get all ORDS privileges for a specific role
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.ORACLE_APEX_API_KEY}}'
  exposes:
  - type: rest
    namespace: ords-rest-roles-rest
    port: 8080
    description: REST adapter for Oracle REST Data Services (ORDS) REST API — Roles. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/ords/rest/roles
      name: ords-rest-roles
      description: REST surface for ords-rest-roles.
      operations:
      - method: GET
        name: listroles
        description: Get all ORDS roles
        call: ords-rest-roles.listroles
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createrole
        description: Create an ORDS role
        call: ords-rest-roles.createrole
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/ords/rest/roles/{id}
      name: ords-rest-roles-id
      description: REST surface for ords-rest-roles-id.
      operations:
      - method: GET
        name: getrole
        description: Get an ORDS role
        call: ords-rest-roles.getrole
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updaterole
        description: Update an ORDS role
        call: ords-rest-roles.updaterole
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleterole
        description: Delete an ORDS role
        call: ords-rest-roles.deleterole
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/ords/rest/roles/{id}/privileges
      name: ords-rest-roles-id-privileges
      description: REST surface for ords-rest-roles-id-privileges.
      operations:
      - method: GET
        name: listroleprivileges
        description: Get all ORDS privileges for a specific role
        call: ords-rest-roles.listroleprivileges
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: ords-rest-roles-mcp
    port: 9090
    transport: http
    description: MCP adapter for Oracle REST Data Services (ORDS) REST API — Roles. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: get-all-ords-roles
      description: Get all ORDS roles
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: ords-rest-roles.listroles
      outputParameters:
      - type: object
        mapping: $.
    - name: create-ords-role
      description: Create an ORDS role
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: ords-rest-roles.createrole
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-ords-role
      description: Get an ORDS role
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: ords-rest-roles.getrole
      outputParameters:
      - type: object
        mapping: $.
    - name: update-ords-role
      description: Update an ORDS role
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: ords-rest-roles.updaterole
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-ords-role
      description: Delete an ORDS role
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: ords-rest-roles.deleterole
      outputParameters:
      - type: object
        mapping: $.
    - name: get-all-ords-privileges-specific
      description: Get all ORDS privileges for a specific role
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: ords-rest-roles.listroleprivileges
      outputParameters:
      - type: object
        mapping: $.