Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin API V1 Integration Job Logs API

10 actions 10 updates phrasing extends openapi/optimizely-integration-job-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/IntegrationJobLogs'].get
$.paths['/api/v1/admin/IntegrationJobLogs'].post
$.paths['/api/v1/admin/IntegrationJobLogs({id})'].get
$.paths['/api/v1/admin/IntegrationJobLogs({id})'].put
$.paths['/api/v1/admin/IntegrationJobLogs({id})'].delete
$.paths['/api/v1/admin/IntegrationJobLogs({id})'].patch
$.paths['/api/v1/admin/IntegrationJobLogs/Default.Default()'].get
$.paths['/api/v1/admin/integrationjoblogs/delete'].delete
$.paths['/api/v1/admin/integrationjoblogs({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 Integration Job Logs API
  version: 1.0.0
extends: openapi/optimizely-integration-job-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/IntegrationJobLogs'].get
  update:
    x-apievangelist-phrasing:
      intent: List integration job log entries
      effect: read
      questions:
      - How do I see the log messages written by integration jobs?
      - Can I filter integration job logs to errors from one job?
      instructions:
      - text: List all integration job log entries.
      - text: List integration job logs matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/IntegrationJobLogs'].post
  update:
    x-apievangelist-phrasing:
      intent: Write a log entry for an integration job
      effect: write
      questions:
      - How do I add a log message to an integration job run?
      - What is required to write an integration job log entry?
      instructions:
      - text: Log message {message} of type {typeName} for integration job {integrationJobId}.
        slots:
          message: requestBody.message
          typeName: requestBody.typeName
          integrationJobId: requestBody.integrationJobId
      - text: Write a {typeName} log entry saying {message}.
        slots:
          typeName: requestBody.typeName
          message: requestBody.message
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/IntegrationJobLogs({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one integration job log entry
      effect: read
      questions:
      - How do I read a single integration job log entry by id?
      - What message and module did a particular job log entry record?
      instructions:
      - text: Get integration job log {id}.
        slots:
          id: path.id
      - text: Show the message on job log entry {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/IntegrationJobLogs({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an integration job log entry
      effect: write
      questions:
      - How do I overwrite an integration job log entry completely?
      - Is there a full replace for a job log record?
      instructions:
      - text: Replace integration job log {id} with message {message} of type {typeName}.
        slots:
          id: path.id
          message: requestBody.message
          typeName: requestBody.typeName
      - text: Overwrite the whole job log record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/IntegrationJobLogs({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an integration job log entry
      effect: destructive
      questions:
      - How do I delete one integration job log entry?
      - Can I delete a job log entry only when its ETag matches?
      instructions:
      - text: Delete integration job log {id}.
        slots:
          id: path.id
      - text: Delete job 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/IntegrationJobLogs({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update fields on an integration job log entry
      effect: write
      questions:
      - How do I correct just the message text on a job log entry?
      - Can I change the module name recorded on a log entry?
      instructions:
      - text: Change the message of job log {id} to {message}.
        slots:
          id: path.id
          message: requestBody.message
      - text: Patch job log {id} with module name {moduleName}.
        slots:
          id: path.id
          moduleName: requestBody.moduleName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/IntegrationJobLogs/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the default integration job log record
      effect: read
      questions:
      - What does a default integration job log record contain?
      - Can I get the template values for a new job log entry?
      instructions:
      - text: Get the default integration job log record.
      - text: Show the template for a new job log entry.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/integrationjoblogs/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete integration job logs
      effect: destructive
      questions:
      - How do I clear out many integration job log entries at once?
      - Can I bulk delete job logs by a list of ids?
      instructions:
      - text: Bulk delete integration job logs {ids}.
        slots:
          ids: query.ids
      - text: 'Clear these job log entries: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/integrationjoblogs({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a job log entry
      effect: read
      questions:
      - How do I read a custom property on an integration job log entry?
      - Can I fetch one extension property of a job log?
      instructions:
      - text: Get custom property {custompropertyKey} on job log {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show custom property {custompropertyKey} for integration job log {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      method: generated
      generated: '2026-09-26'