Oracle Siebel · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Oracle Siebel REST Contacts API

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

$.info
$.paths['/data/Account/Account/{AccountId}/Contact'].get
$.paths['/data/Account/Account/{AccountId}/Contact'].put
$.paths['/data/Contact/Contact'].get
$.paths['/data/Contact/Contact'].post
$.paths['/data/Contact/Contact/{ContactId}'].get
$.paths['/data/Contact/Contact/{ContactId}'].put
$.paths['/data/Contact/Contact/{ContactId}'].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 Contacts API
  version: 1.0.0
extends: openapi/oracle-siebel-contacts-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: 7
- target: $.paths['/data/Account/Account/{AccountId}/Contact'].get
  update:
    x-apievangelist-phrasing:
      intent: List the contacts under an account
      effect: read
      questions:
      - Who are the people linked to a particular customer account?
      - Can I get the email and job title of every contact at one account?
      - Is it possible to search only within one account's contacts?
      instructions:
      - text: List the contacts at account {account_id}.
        slots:
          account_id: path.AccountId
      - text: Find contacts under account {account_id} matching {searchspec}.
        slots:
          account_id: path.AccountId
          searchspec: query.searchspec
      - text: Show {page_size} contacts from account {account_id}.
        slots:
          page_size: query.PageSize
          account_id: path.AccountId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/Account/Account/{AccountId}/Contact'].put
  update:
    x-apievangelist-phrasing:
      intent: Add or update a contact under an account
      effect: write
      questions:
      - How do I attach a new person to an existing customer account?
      - Can I add several contacts to one account in a single batch?
      - What's required to insert a contact as a child of an account?
      instructions:
      - text: Add {first_name} {last_name} as a contact on account {account_id}.
        slots:
          first_name: requestBody.First Name
          last_name: requestBody.Last Name
          account_id: path.AccountId
      - text: Add {first_name} {last_name}, {job_title}, to account {account_id} with email {email}.
        slots:
          first_name: requestBody.First Name
          last_name: requestBody.Last Name
          job_title: requestBody.Job Title
          account_id: path.AccountId
          email: requestBody.Email Address
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/Contact/Contact'].get
  update:
    x-apievangelist-phrasing:
      intent: List contacts
      effect: read
      questions:
      - How can I export every contact across all accounts in the CRM?
      - Can I search all contacts by last name with a search spec?
      - Which contacts can I see under organization view mode?
      instructions:
      - text: List all contacts.
      - text: Search all contacts with {searchspec}.
        slots:
          searchspec: query.searchspec
      - text: Show contacts starting at row {start_row}, {page_size} at a time.
        slots:
          start_row: query.StartRowNum
          page_size: query.PageSize
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/Contact/Contact'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a standalone contact
      effect: write
      questions:
      - How do I add a new person to the contact list without picking an account first?
      - What fields are required when creating a contact record?
      - Can I store a mobile number and job title on a new contact?
      instructions:
      - text: Create a contact named {first_name} {last_name}.
        slots:
          first_name: requestBody.First Name
          last_name: requestBody.Last Name
      - text: Create contact {first_name} {last_name} with email {email} and mobile {mobile}.
        slots:
          first_name: requestBody.First Name
          last_name: requestBody.Last Name
          email: requestBody.Email Address
          mobile: 'requestBody.Cellular Phone #'
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/Contact/Contact/{ContactId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one contact by its ID
      effect: read
      questions:
      - How do I retrieve a single contact when I know its row ID?
      - Can I fetch just the email and phone fields of one contact?
      instructions:
      - text: Get contact {contact_id}.
        slots:
          contact_id: path.ContactId
      - text: Show the {fields} for contact {contact_id}.
        slots:
          fields: query.fields
          contact_id: path.ContactId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/Contact/Contact/{ContactId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update or insert a contact by ID
      effect: write
      questions:
      - How do I update a contact's job title after they get promoted?
      - Can I change a contact's email by its row ID, creating it if missing?
      instructions:
      - text: Update contact {contact_id} ({first_name} {last_name}) job title to {job_title}.
        slots:
          contact_id: path.ContactId
          first_name: requestBody.First Name
          last_name: requestBody.Last Name
          job_title: requestBody.Job Title
      - text: Upsert contact {contact_id} as {first_name} {last_name} with work phone {work_phone}.
        slots:
          contact_id: path.ContactId
          first_name: requestBody.First Name
          last_name: requestBody.Last Name
          work_phone: 'requestBody.Work Phone #'
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/Contact/Contact/{ContactId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a contact
      effect: destructive
      questions:
      - How do I delete a person from the contacts list entirely?
      - Can I remove a contact record by its row ID?
      instructions:
      - text: Delete contact {contact_id}.
        slots:
          contact_id: path.ContactId
      - text: Permanently remove contact record {contact_id}.
        slots:
          contact_id: path.ContactId
      method: generated
      generated: '2026-09-26'