Oracle Hospitality · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Oracle Hospitality Authentication API

3 actions 3 updates phrasing extends openapi/oracle-hospitality-authentication-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/token'].post

$.paths['/tokens'].post

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 Hospitality Authentication API
  version: 1.0.0
extends: openapi/oracle-hospitality-authentication-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: 2
- target: $.paths['/token'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a token for the OPERA Cloud Distribution APIs
      effect: write
      questions:
      - How do I get an access token for the OPERA Cloud Distribution REST APIs with my username and password?
      - What credentials does the Distribution token endpoint expect in the body?
      instructions:
      - text: Get a Distribution API token for user {username} with password {password}.
        slots:
          username: requestBody.username
          password: requestBody.password
      - text: Sign in to OPERA Cloud Distribution as {username} using {password} and return the token.
        slots:
          username: requestBody.username
          password: requestBody.password
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tokens'].post
  update:
    x-apievangelist-phrasing:
      intent: Get an OAuth token for OPERA Cloud REST APIs
      effect: write
      questions:
      - How do I obtain an OAuth access token for the Oracle Hospitality OPERA Cloud REST APIs?
      - Which grant type and scope do I send to get an OPERA Cloud token with my client ID and secret?
      - Can I request an OPERA Cloud token for a specific enterprise ID?
      instructions:
      - text: Request an OPERA Cloud OAuth token using grant type {grant_type} with scope {scope}.
        slots:
          grant_type: requestBody.grant_type
          scope: requestBody.scope
      - text: Get an OPERA Cloud REST token for enterprise {enterprise} with the {grant_type} grant.
        slots:
          enterprise: header.enterpriseId
          grant_type: requestBody.grant_type
      method: generated
      generated: '2026-09-26'