Oracle Database Oracle REST Data Services (ORDS) API — REST Services

naftiko: 1.0.0-alpha2
info:
  label: Oracle Database Oracle REST Data Services (ORDS) API — REST Services
  description: 'Oracle Database Oracle REST Data Services (ORDS) API — REST Services. 15 operations. Lead operation: Oracle
    Database Get ORDS properties. Self-contained Naftiko capability covering one Oracle Database business surface.'
  tags:
  - Oracle Database
  - REST Services
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ORACLE_DATABASE_API_KEY: ORACLE_DATABASE_API_KEY
capability:
  consumes:
  - type: http
    namespace: ords-rest-services
    baseUri: https://{host}:{port}/ords
    description: Oracle Database Oracle REST Data Services (ORDS) API — REST Services business capability. Self-contained,
      no shared references.
    resources:
    - name: ords-properties
      path: /ords/properties/
      operations:
      - name: getordsproperties
        method: GET
        description: Oracle Database Get ORDS properties
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: ords-properties-key
      path: /ords/properties/{key}
      operations:
      - name: setordsproperty
        method: PUT
        description: Oracle Database Set an ORDS property
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: key
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: unsetordsproperty
        method: DELETE
        description: Oracle Database Unset an ORDS property
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: key
          in: path
          type: string
          required: true
    - name: ords-rest-autorest
      path: /ords/rest/autorest/
      operations:
      - name: autorestenableobject
        method: POST
        description: Oracle Database REST enable a database object
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: ords-rest-clients
      path: /ords/rest/clients/
      operations:
      - name: getoauthclients
        method: GET
        description: Oracle Database Get all OAuth clients
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createoauthclient
        method: POST
        description: Oracle Database Create an OAuth client
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: ords-rest-clients-id
      path: /ords/rest/clients/{id}
      operations:
      - name: updateoauthclient
        method: PUT
        description: Oracle Database Update an OAuth client
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: ords-rest-handlers
      path: /ords/rest/handlers/
      operations:
      - name: getresthandlers
        method: GET
        description: Oracle Database Get all REST handlers
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createresthandler
        method: POST
        description: Oracle Database Create a REST handler
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: ords-rest-handlers-id
      path: /ords/rest/handlers/{id}
      operations:
      - name: deleteresthandler
        method: DELETE
        description: Oracle Database Delete a REST handler
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
    - name: ords-rest-modules
      path: /ords/rest/modules/
      operations:
      - name: getrestmodules
        method: GET
        description: Oracle Database Get all REST modules
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createrestmodule
        method: POST
        description: Oracle Database Create a REST module
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: ords-rest-modules-id
      path: /ords/rest/modules/{id}
      operations:
      - name: updaterestmodule
        method: PUT
        description: Oracle Database Update a REST module
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: ords-rest-privileges
      path: /ords/rest/privileges/
      operations:
      - name: createprivilege
        method: POST
        description: Oracle Database Create a REST privilege
        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
      path: /ords/rest/roles/
      operations:
      - name: createrole
        method: POST
        description: Oracle Database Create a REST role
        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_DATABASE_API_KEY}}'
  exposes:
  - type: rest
    namespace: ords-rest-services-rest
    port: 8080
    description: REST adapter for Oracle Database Oracle REST Data Services (ORDS) API — REST Services. One Spectral-compliant
      resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/ords/properties
      name: ords-properties
      description: REST surface for ords-properties.
      operations:
      - method: GET
        name: getordsproperties
        description: Oracle Database Get ORDS properties
        call: ords-rest-services.getordsproperties
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/ords/properties/{key}
      name: ords-properties-key
      description: REST surface for ords-properties-key.
      operations:
      - method: PUT
        name: setordsproperty
        description: Oracle Database Set an ORDS property
        call: ords-rest-services.setordsproperty
        with:
          key: rest.key
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: unsetordsproperty
        description: Oracle Database Unset an ORDS property
        call: ords-rest-services.unsetordsproperty
        with:
          key: rest.key
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/ords/rest/autorest
      name: ords-rest-autorest
      description: REST surface for ords-rest-autorest.
      operations:
      - method: POST
        name: autorestenableobject
        description: Oracle Database REST enable a database object
        call: ords-rest-services.autorestenableobject
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/ords/rest/clients
      name: ords-rest-clients
      description: REST surface for ords-rest-clients.
      operations:
      - method: GET
        name: getoauthclients
        description: Oracle Database Get all OAuth clients
        call: ords-rest-services.getoauthclients
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createoauthclient
        description: Oracle Database Create an OAuth client
        call: ords-rest-services.createoauthclient
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/ords/rest/clients/{id}
      name: ords-rest-clients-id
      description: REST surface for ords-rest-clients-id.
      operations:
      - method: PUT
        name: updateoauthclient
        description: Oracle Database Update an OAuth client
        call: ords-rest-services.updateoauthclient
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/ords/rest/handlers
      name: ords-rest-handlers
      description: REST surface for ords-rest-handlers.
      operations:
      - method: GET
        name: getresthandlers
        description: Oracle Database Get all REST handlers
        call: ords-rest-services.getresthandlers
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createresthandler
        description: Oracle Database Create a REST handler
        call: ords-rest-services.createresthandler
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/ords/rest/handlers/{id}
      name: ords-rest-handlers-id
      description: REST surface for ords-rest-handlers-id.
      operations:
      - method: DELETE
        name: deleteresthandler
        description: Oracle Database Delete a REST handler
        call: ords-rest-services.deleteresthandler
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/ords/rest/modules
      name: ords-rest-modules
      description: REST surface for ords-rest-modules.
      operations:
      - method: GET
        name: getrestmodules
        description: Oracle Database Get all REST modules
        call: ords-rest-services.getrestmodules
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createrestmodule
        description: Oracle Database Create a REST module
        call: ords-rest-services.createrestmodule
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/ords/rest/modules/{id}
      name: ords-rest-modules-id
      description: REST surface for ords-rest-modules-id.
      operations:
      - method: PUT
        name: updaterestmodule
        description: Oracle Database Update a REST module
        call: ords-rest-services.updaterestmodule
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/ords/rest/privileges
      name: ords-rest-privileges
      description: REST surface for ords-rest-privileges.
      operations:
      - method: POST
        name: createprivilege
        description: Oracle Database Create a REST privilege
        call: ords-rest-services.createprivilege
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/ords/rest/roles
      name: ords-rest-roles
      description: REST surface for ords-rest-roles.
      operations:
      - method: POST
        name: createrole
        description: Oracle Database Create a REST role
        call: ords-rest-services.createrole
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: ords-rest-services-mcp
    port: 9090
    transport: http
    description: MCP adapter for Oracle Database Oracle REST Data Services (ORDS) API — REST Services. One tool per consumed
      operation, routed inline through this capability's consumes block.
    tools:
    - name: oracle-database-get-ords-properties
      description: Oracle Database Get ORDS properties
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: ords-rest-services.getordsproperties
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-database-set-ords-property
      description: Oracle Database Set an ORDS property
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: ords-rest-services.setordsproperty
      with:
        key: tools.key
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-database-unset-ords-property
      description: Oracle Database Unset an ORDS property
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: ords-rest-services.unsetordsproperty
      with:
        key: tools.key
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-database-rest-enable-database
      description: Oracle Database REST enable a database object
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: ords-rest-services.autorestenableobject
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-database-get-all-oauth
      description: Oracle Database Get all OAuth clients
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: ords-rest-services.getoauthclients
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-database-create-oauth-client
      description: Oracle Database Create an OAuth client
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: ords-rest-services.createoauthclient
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-database-update-oauth-client
      description: Oracle Database Update an OAuth client
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: ords-rest-services.updateoauthclient
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-database-get-all-rest
      description: Oracle Database Get all REST handlers
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: ords-rest-services.getresthandlers
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-database-create-rest-handler
      description: Oracle Database Create a REST handler
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: ords-rest-services.createresthandler
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-database-delete-rest-handler
      description: Oracle Database Delete a REST handler
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: ords-rest-services.deleteresthandler
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-database-get-all-rest-2
      description: Oracle Database Get all REST modules
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: ords-rest-services.getrestmodules
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-database-create-rest-module
      description: Oracle Database Create a REST module
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: ords-rest-services.createrestmodule
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-database-update-rest-module
      description: Oracle Database Update a REST module
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: ords-rest-services.updaterestmodule
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-database-create-rest-privilege
      description: Oracle Database Create a REST privilege
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: ords-rest-services.createprivilege
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-database-create-rest-role
      description: Oracle Database Create a REST role
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: ords-rest-services.createrole
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.