Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin API V1 Application Logs API

10 actions 10 updates phrasing extends openapi/optimizely-application-logs-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Optimizely's API. It is a proposal applied on top of the contract, not a document Optimizely publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 10

$.info
$.paths['/api/v1/admin/ApplicationLogs'].get
$.paths['/api/v1/admin/ApplicationLogs'].post
$.paths['/api/v1/admin/ApplicationLogs({id})'].get
$.paths['/api/v1/admin/ApplicationLogs({id})'].put
$.paths['/api/v1/admin/ApplicationLogs({id})'].delete
$.paths['/api/v1/admin/ApplicationLogs({id})'].patch
$.paths['/api/v1/admin/ApplicationLogs/Default.Default()'].get
$.paths['/api/v1/admin/applicationlogs/delete'].delete
$.paths['/api/v1/admin/applicationlogs({key})/customproperties({custompropertyKey})'].get

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 Admin API V1 Application Logs API
  version: 1.0.0
extends: openapi/optimizely-application-logs-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: 9
- target: $.paths['/api/v1/admin/ApplicationLogs'].get
  update:
    x-apievangelist-phrasing:
      intent: List application log entries
      effect: read
      questions:
      - Where can I see recent application log messages from the commerce site?
      - Can I filter application logs to just errors from a certain source?
      instructions:
      - text: List application log entries.
      - text: Show the latest {top} application logs matching {filter}, sorted by {orderby}.
        slots:
          top: query.$top
          filter: query.$filter
          orderby: query.$orderby
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ApplicationLogs'].post
  update:
    x-apievangelist-phrasing:
      intent: Write an application log entry
      effect: write
      questions:
      - Can I record my own message in the application log?
      - What source, message and type does a new log entry need?
      instructions:
      - text: Write a {type} log entry from {source} saying {message}.
        slots:
          type: requestBody.type
          source: requestBody.source
          message: requestBody.message
      - text: Add an application log message {message} from source {source} as type {type} on host {host}.
        slots:
          message: requestBody.message
          source: requestBody.source
          type: requestBody.type
          host: requestBody.host
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ApplicationLogs({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an application log entry
      effect: read
      questions:
      - Can I open one application log entry by its id to read the full message?
      - Which host and ELMAH error id belong to a specific log entry?
      instructions:
      - text: Get application log {id}.
        slots:
          id: path.id
      - text: Show the full details of log entry {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ApplicationLogs({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an application log entry
      effect: write
      questions:
      - Is there a way to overwrite a whole application log record?
      - What fields must I resend to fully replace a log entry?
      instructions:
      - text: Replace log entry {id} with message {message} from {source} of type {type}.
        slots:
          id: path.id
          message: requestBody.message
          source: requestBody.source
          type: requestBody.type
      - text: Overwrite application log record {id} entirely.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ApplicationLogs({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an application log entry
      effect: destructive
      questions:
      - Can I delete one application log entry by id?
      - Does deleting a single log entry support an If-Match check?
      instructions:
      - text: Delete application log {id}.
        slots:
          id: path.id
      - text: Delete log entry {id} if its ETag is {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ApplicationLogs({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update fields on a log entry
      effect: write
      questions:
      - How do I correct just the message text on an existing log entry?
      - Can I change only the type of an application log record?
      instructions:
      - text: Change the message on log entry {id} to {message}.
        slots:
          id: path.id
          message: requestBody.message
      - text: Set log entry {id} type to {type}.
        slots:
          id: path.id
          type: requestBody.type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ApplicationLogs/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a blank application log template
      effect: read
      questions:
      - What default values does a new application log entry have?
      - Is there an empty log entry template I can start from?
      instructions:
      - text: Get the default application log template.
      - text: Show the starting values for a new log entry.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/applicationlogs/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete application log entries
      effect: destructive
      questions:
      - Can I purge many application log entries at once?
      - Is there a bulk delete for log entries that takes a list of ids?
      instructions:
      - text: Bulk delete application logs {ids}.
        slots:
          ids: query.ids
      - text: 'Purge these log entries in one call: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/applicationlogs({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a log entry
      effect: read
      questions:
      - How can I read a custom property attached to an application log entry?
      - Can extra metadata on a log record be fetched by property id?
      instructions:
      - text: Get custom property {custompropertyKey} on application log {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Read log entry {key}'s custom field {custompropertyKey}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'