Laravel · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Forge Monitors API

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

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/orgs/{organization}/servers/{server}/monitors'].get
$.paths['/orgs/{organization}/servers/{server}/monitors'].post
$.paths['/orgs/{organization}/servers/{server}/monitors/{monitor}'].get
$.paths['/orgs/{organization}/servers/{server}/monitors/{monitor}'].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 Forge Monitors API
  version: 1.0.0
extends: openapi/laravel-monitors-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: 4
- target: $.paths['/orgs/{organization}/servers/{server}/monitors'].get
  update:
    x-apievangelist-phrasing:
      intent: List a server's monitors
      effect: read
      questions:
      - What resource monitors are set up on my server?
      - Can I see only the monitors that are currently alerting?
      instructions:
      - text: List the monitors on server {server} in {organization}.
        slots:
          server: path.server
          organization: path.organization
      - text: Show monitors on server {server} in {organization} in state {state}.
        slots:
          server: path.server
          organization: path.organization
          state: query.filter[state]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/monitors'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a server resource monitor
      effect: write
      questions:
      - How do I get an alert when my server's disk or CPU usage crosses a threshold?
      - Can a monitor wait a number of minutes before notifying me?
      instructions:
      - text: Create a {type} monitor on server {server} in {organization} that alerts {notify} when usage is {operator} {threshold}.
        slots:
          type: requestBody.type
          server: path.server
          organization: path.organization
          notify: requestBody.notify
          operator: requestBody.operator
          threshold: requestBody.threshold
      - text: Notify {notify} if {type} on {server} ({organization}) stays {operator} {threshold} for {minutes} minutes.
        slots:
          notify: requestBody.notify
          type: requestBody.type
          server: path.server
          organization: path.organization
          operator: requestBody.operator
          threshold: requestBody.threshold
          minutes: requestBody.minutes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/monitors/{monitor}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a server monitor
      effect: read
      questions:
      - What threshold and state does one server monitor have?
      - Can I check a single monitor by its ID?
      instructions:
      - text: Show monitor {monitor} on server {server} in {organization}.
        slots:
          monitor: path.monitor
          server: path.server
          organization: path.organization
      - text: Get the current state of monitor {monitor} on {server} in {organization}.
        slots:
          monitor: path.monitor
          server: path.server
          organization: path.organization
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/monitors/{monitor}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a server monitor
      effect: destructive
      questions:
      - How do I stop a monitor from sending alerts by removing it?
      - Can I delete one monitor from a server?
      instructions:
      - text: Delete monitor {monitor} from server {server} in {organization}.
        slots:
          monitor: path.monitor
          server: path.server
          organization: path.organization
      - text: Remove the resource alert {monitor} on {server} in {organization}.
        slots:
          monitor: path.monitor
          server: path.server
          organization: path.organization
      method: generated
      generated: '2026-10-01'