Oracle Siebel · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Oracle Siebel REST Opportunities API

7 actions 7 updates phrasing extends openapi/oracle-siebel-opportunities-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 7

$.info
$.paths['/data/Account/Account/{AccountId}/Opportunity'].get
$.paths['/data/Opportunity/Opportunity'].get
$.paths['/data/Opportunity/Opportunity'].post
$.paths['/data/Opportunity/Opportunity/{OpportunityId}'].get
$.paths['/data/Opportunity/Opportunity/{OpportunityId}'].put
$.paths['/data/Opportunity/Opportunity/{OpportunityId}'].delete

OpenAPI Overlay

Raw ↑
# 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 Opportunities API
  version: 1.0.0
extends: openapi/oracle-siebel-opportunities-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: 6
- target: $.paths['/data/Account/Account/{AccountId}/Opportunity'].get
  update:
    x-apievangelist-phrasing:
      intent: List the opportunities under an account
      effect: read
      questions:
      - What deals are open for a specific customer account?
      - Can I see the sales stage and close date of each opportunity tied to one account?
      - Is there a way to filter just one account's opportunities by search spec?
      instructions:
      - text: List the opportunities for account {account_id}.
        slots:
          account_id: path.AccountId
      - text: Show opportunities on account {account_id} matching {searchspec}.
        slots:
          account_id: path.AccountId
          searchspec: query.searchspec
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/Opportunity/Opportunity'].get
  update:
    x-apievangelist-phrasing:
      intent: List opportunities
      effect: read
      questions:
      - How can I see every sales opportunity in the pipeline, across all accounts?
      - Can I filter opportunities by sales stage using a search spec?
      - Which opportunities are mine under sales rep view mode?
      instructions:
      - text: List all opportunities.
      - text: List opportunities across all accounts matching {searchspec}.
        slots:
          searchspec: query.searchspec
      - text: Show opportunities in {view_mode} view.
        slots:
          view_mode: query.ViewMode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/Opportunity/Opportunity'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new opportunity
      effect: write
      questions:
      - How do I open a new sales opportunity in the CRM?
      - Can I set expected revenue and win probability on a new deal?
      instructions:
      - text: Create an opportunity named {name}.
        slots:
          name: requestBody.Name
      - text: Create opportunity {name} for account {account} worth {revenue}, closing {close_date}.
        slots:
          name: requestBody.Name
          account: requestBody.Account
          revenue: requestBody.Revenue
          close_date: requestBody.Close Date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/Opportunity/Opportunity/{OpportunityId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one opportunity by its ID
      effect: read
      questions:
      - How do I look up a single deal by its row ID?
      - Can I retrieve only the sales stage and revenue of one opportunity?
      instructions:
      - text: Get opportunity {opportunity_id}.
        slots:
          opportunity_id: path.OpportunityId
      - text: Show the {fields} of opportunity {opportunity_id}.
        slots:
          fields: query.fields
          opportunity_id: path.OpportunityId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/Opportunity/Opportunity/{OpportunityId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update or insert an opportunity by ID
      effect: write
      questions:
      - How do I move an existing deal to the next sales stage?
      - Can I update an opportunity's win probability and close date together?
      instructions:
      - text: Move opportunity {opportunity_id} ({name}) to sales stage {sales_stage}.
        slots:
          opportunity_id: path.OpportunityId
          name: requestBody.Name
          sales_stage: requestBody.Sales Stage
      - text: Set win probability of opportunity {opportunity_id} ({name}) to {probability}.
        slots:
          opportunity_id: path.OpportunityId
          name: requestBody.Name
          probability: requestBody.Win Probability
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/Opportunity/Opportunity/{OpportunityId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an opportunity
      effect: destructive
      questions:
      - How do I remove a dead deal from the pipeline permanently?
      - Can I delete an opportunity record by its row ID?
      instructions:
      - text: Delete opportunity {opportunity_id}.
        slots:
          opportunity_id: path.OpportunityId
      - text: Permanently remove opportunity record {opportunity_id}.
        slots:
          opportunity_id: path.OpportunityId
      method: generated
      generated: '2026-09-26'