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

naftiko: 1.0.0-alpha2
info:
  label: Oracle Database Oracle REST Data Services (ORDS) API — Data Guard
  description: 'Oracle Database Oracle REST Data Services (ORDS) API — Data Guard. 8 operations. Lead operation: Oracle Database
    Get Data Guard broker configuration. Self-contained Naftiko capability covering one Oracle Database business surface.'
  tags:
  - Oracle Database
  - Data Guard
  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-data-guard
    baseUri: https://{host}:{port}/ords
    description: Oracle Database Oracle REST Data Services (ORDS) API — Data Guard business capability. Self-contained, no
      shared references.
    resources:
    - name: database-dataguard-configuration
      path: /database/dataguard/configuration/
      operations:
      - name: getdataguardconfiguration
        method: GET
        description: Oracle Database Get Data Guard broker configuration
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: adddataguardconfiguration
        method: POST
        description: Oracle Database Add a Data Guard configuration
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: updatedataguardconfiguration
        method: PUT
        description: Oracle Database Enable or disable Data Guard configuration
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: removedataguardconfiguration
        method: DELETE
        description: Oracle Database Remove Data Guard configuration
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: database-dataguard-databases
      path: /database/dataguard/databases/
      operations:
      - name: getdataguarddatabases
        method: GET
        description: Oracle Database Get all Data Guard databases
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: adddataguarddatabase
        method: POST
        description: Oracle Database Add a database to Data Guard
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: database-dataguard-databases-database
      path: /database/dataguard/databases/{database}
      operations:
      - name: updatedataguarddatabase
        method: PUT
        description: Oracle Database Update Data Guard database role
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: database
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: removedataguarddatabase
        method: DELETE
        description: Oracle Database Remove database from Data Guard
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: database
          in: path
          type: string
          required: true
    authentication:
      type: bearer
      token: '{{env.ORACLE_DATABASE_API_KEY}}'
  exposes:
  - type: rest
    namespace: ords-data-guard-rest
    port: 8080
    description: REST adapter for Oracle Database Oracle REST Data Services (ORDS) API — Data Guard. One Spectral-compliant
      resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/database/dataguard/configuration
      name: database-dataguard-configuration
      description: REST surface for database-dataguard-configuration.
      operations:
      - method: GET
        name: getdataguardconfiguration
        description: Oracle Database Get Data Guard broker configuration
        call: ords-data-guard.getdataguardconfiguration
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: adddataguardconfiguration
        description: Oracle Database Add a Data Guard configuration
        call: ords-data-guard.adddataguardconfiguration
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatedataguardconfiguration
        description: Oracle Database Enable or disable Data Guard configuration
        call: ords-data-guard.updatedataguardconfiguration
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: removedataguardconfiguration
        description: Oracle Database Remove Data Guard configuration
        call: ords-data-guard.removedataguardconfiguration
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/database/dataguard/databases
      name: database-dataguard-databases
      description: REST surface for database-dataguard-databases.
      operations:
      - method: GET
        name: getdataguarddatabases
        description: Oracle Database Get all Data Guard databases
        call: ords-data-guard.getdataguarddatabases
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: adddataguarddatabase
        description: Oracle Database Add a database to Data Guard
        call: ords-data-guard.adddataguarddatabase
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/database/dataguard/databases/{database}
      name: database-dataguard-databases-database
      description: REST surface for database-dataguard-databases-database.
      operations:
      - method: PUT
        name: updatedataguarddatabase
        description: Oracle Database Update Data Guard database role
        call: ords-data-guard.updatedataguarddatabase
        with:
          database: rest.database
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: removedataguarddatabase
        description: Oracle Database Remove database from Data Guard
        call: ords-data-guard.removedataguarddatabase
        with:
          database: rest.database
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: ords-data-guard-mcp
    port: 9090
    transport: http
    description: MCP adapter for Oracle Database Oracle REST Data Services (ORDS) API — Data Guard. One tool per consumed
      operation, routed inline through this capability's consumes block.
    tools:
    - name: oracle-database-get-data-guard
      description: Oracle Database Get Data Guard broker configuration
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: ords-data-guard.getdataguardconfiguration
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-database-add-data-guard
      description: Oracle Database Add a Data Guard configuration
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: ords-data-guard.adddataguardconfiguration
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-database-enable-disable-data
      description: Oracle Database Enable or disable Data Guard configuration
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: ords-data-guard.updatedataguardconfiguration
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-database-remove-data-guard
      description: Oracle Database Remove Data Guard configuration
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: ords-data-guard.removedataguardconfiguration
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-database-get-all-data
      description: Oracle Database Get all Data Guard databases
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: ords-data-guard.getdataguarddatabases
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-database-add-database-data
      description: Oracle Database Add a database to Data Guard
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: ords-data-guard.adddataguarddatabase
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-database-update-data-guard
      description: Oracle Database Update Data Guard database role
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: ords-data-guard.updatedataguarddatabase
      with:
        database: tools.database
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-database-remove-database-data
      description: Oracle Database Remove database from Data Guard
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: ords-data-guard.removedataguarddatabase
      with:
        database: tools.database
      outputParameters:
      - type: object
        mapping: $.