Oracle Siebel · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Oracle Siebel REST Metadata API

5 actions 5 updates phrasing extends openapi/oracle-siebel-metadata-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Oracle Siebel's API. It is a proposal applied on top of the contract, not a document Oracle Siebel publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/service/describe'].get

$.paths['/service/{ServiceName}/describe'].get

$.paths['/workspace/{WorkspaceName}/describe'].get

$.paths['/data/{BusinessObject}/{BusinessComponent}/describe'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Oracle Siebel REST Metadata API
  version: 1.0.0
extends: openapi/oracle-siebel-metadata-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/service/describe'].get
  update:
    x-apievangelist-phrasing:
      intent: List all business services and their methods
      effect: read
      questions:
      - Which business services can I call on this Siebel server?
      - Is there a catalog of every service and the methods each one exposes?
      instructions:
      - text: Show the full business service catalog.
      - text: List every business service and its methods.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/service/{ServiceName}/describe'].get
  update:
    x-apievangelist-phrasing:
      intent: Describe one business service
      effect: read
      questions:
      - What input and output arguments does a particular business service method expect?
      - Can I see the data types for one service's methods before calling it?
      instructions:
      - text: Describe business service {service}.
        slots:
          service: path.ServiceName
      - text: Show the methods and arguments of service {service}.
        slots:
          service: path.ServiceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workspace/{WorkspaceName}/describe'].get
  update:
    x-apievangelist-phrasing:
      intent: List repository objects in a workspace
      effect: read
      questions:
      - Which applets, views and other repository objects exist in a workspace?
      - Can I get an OpenAPI-style catalog of everything in a Siebel workspace?
      instructions:
      - text: Describe workspace {workspace}.
        slots:
          workspace: path.WorkspaceName
      - text: List the repository objects available in workspace {workspace}.
        slots:
          workspace: path.WorkspaceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/{BusinessObject}/{BusinessComponent}/describe'].get
  update:
    x-apievangelist-phrasing:
      intent: Describe a business component's fields
      effect: read
      questions:
      - What fields and data types does a business component have?
      - Can I see the picklist values for a business component before writing to it?
      instructions:
      - text: Describe business component {component} in business object {object}.
        slots:
          component: path.BusinessComponent
          object: path.BusinessObject
      - text: Show the field list and picklists of {object}/{component}.
        slots:
          object: path.BusinessObject
          component: path.BusinessComponent
      method: generated
      generated: '2026-09-26'