Oracle Cloud Infrastructure · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Oracle Cloud Identity and Access Management Users API

6 actions 6 updates phrasing extends openapi/oracle-cloud-users-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Oracle Cloud Infrastructure's API. It is a proposal applied on top of the contract, not a document Oracle Cloud Infrastructure publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/users'].get
$.paths['/users'].post
$.paths['/users/{userId}'].get
$.paths['/users/{userId}'].put
$.paths['/users/{userId}'].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 Cloud Identity and Access Management Users API
  version: 1.0.0
extends: openapi/oracle-cloud-users-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: 5
- target: $.paths['/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List users in the tenancy
      effect: read
      questions:
      - Who are the IAM users in my Oracle Cloud tenancy?
      - Can I get a list of every user account in my tenancy?
      instructions:
      - text: List the users in tenancy {compartmentId}.
        slots:
          compartmentId: query.compartmentId
      - text: Show every IAM user under {compartmentId}.
        slots:
          compartmentId: query.compartmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an IAM user
      effect: write
      questions:
      - How do I add a new user to my tenancy?
      - Is an email address required when creating a user?
      instructions:
      - text: Create user {name} described as {description} in tenancy {compartmentId}.
        slots:
          name: requestBody.name
          description: requestBody.description
          compartmentId: requestBody.compartmentId
      - text: Add user {name} with email {email} and description {description} to tenancy {compartmentId}.
        slots:
          name: requestBody.name
          email: requestBody.email
          description: requestBody.description
          compartmentId: requestBody.compartmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{userId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an IAM user
      effect: read
      questions:
      - What details are stored for a specific user?
      - Can I look up one user's email and state by their OCID?
      instructions:
      - text: Show user {userId}.
        slots:
          userId: path.userId
      - text: Get the profile details of user {userId}.
        slots:
          userId: path.userId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{userId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a user's email or description
      effect: write
      questions:
      - How do I change the email address on a user account?
      - Can I edit a user's description after creating them?
      instructions:
      - text: Change the email of user {userId} to {email}.
        slots:
          userId: path.userId
          email: requestBody.email
      - text: Set the description of user {userId} to {description}.
        slots:
          userId: path.userId
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{userId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an IAM user
      effect: destructive
      questions:
      - How do I remove a user who has left the organization?
      - Can I permanently delete a user account from the tenancy?
      instructions:
      - text: Delete user {userId}.
        slots:
          userId: path.userId
      - text: Remove user {userId} from the tenancy.
        slots:
          userId: path.userId
      method: generated
      generated: '2026-09-26'