Auth0 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Auth0 Management Log Streams API

6 actions 6 updates phrasing extends openapi/auth0-log-streams-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Auth0's API. It is a proposal applied on top of the contract, not a document Auth0 publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/log-streams'].get
$.paths['/log-streams'].post
$.paths['/log-streams/{id}'].get
$.paths['/log-streams/{id}'].delete
$.paths['/log-streams/{id}'].patch

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 Auth0 Management Log Streams API
  version: 1.0.0
extends: openapi/auth0-log-streams-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/log-streams'].get
  update:
    x-apievangelist-phrasing:
      intent: List log streams
      effect: read
      questions:
      - Which log streams are sending my tenant logs out?
      - Can I see whether my log streams are active, paused or suspended?
      instructions:
      - text: List my log streams.
      - text: Show all log streams and their status.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/log-streams'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a log stream
      effect: write
      questions:
      - How do I stream tenant logs to an HTTP endpoint or EventBridge?
      - What sink settings are needed when creating a log stream?
      instructions:
      - text: Create a new log stream.
      - text: Set up a log stream to my HTTP webhook.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/log-streams/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a log stream by ID
      effect: read
      questions:
      - Can I check the configuration and status of one log stream?
      - Why might a specific log stream be suspended?
      instructions:
      - text: Show log stream {id}.
        slots:
          id: path.id
      - text: Get the status of log stream {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/log-streams/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a log stream
      effect: destructive
      questions:
      - How do I delete a log stream?
      - Can I stop and remove a log stream permanently?
      instructions:
      - text: Delete log stream {id}.
        slots:
          id: path.id
      - text: Remove log stream {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/log-streams/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a log stream
      effect: write
      questions:
      - Can I pause a log stream or resume a suspended one?
      - How do I change the event filters on a log stream?
      instructions:
      - text: Set the status of log stream {id} to {status}.
        slots:
          id: path.id
          status: requestBody.status
      - text: Update filters on log stream {id} to {filters}.
        slots:
          id: path.id
          filters: requestBody.filters
      - text: Rename log stream {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-10-01'