Algolia · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Algolia Monitoring API

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

What the actions change

x-apievangelist-phrasing

Targets 15

$.info
$.paths['/{path}'].get
$.paths['/{path}'].put
$.paths['/{path}'].post
$.paths['/{path}'].delete
$.paths['/1/status'].get
$.paths['/1/status/{clusters}'].get
$.paths['/1/incidents'].get
$.paths['/1/incidents/{clusters}'].get
$.paths['/1/inventory/servers'].get
$.paths['/1/latency/{clusters}'].get
$.paths['/1/indexing/{clusters}'].get
$.paths['/1/reachability/{clusters}/probes'].get
$.paths['/1/infrastructure/{metric}/period/{period}'].get
$.paths['/setClientApiKey'].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 Algolia Monitoring API
  version: 1.0.0
extends: openapi/algolia-monitoring-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: 14
- target: $.paths['/{path}'].get
  update:
    x-apievangelist-phrasing:
      intent: Send a raw GET request to the Monitoring API
      effect: read
      questions:
      - Can I read a Monitoring endpoint that the client library doesn't wrap?
      - Is there a generic way to GET any Monitoring API path with custom query parameters?
      instructions:
      - text: Send a raw GET request to Monitoring API path {path}.
        slots:
          path: path.path
      - text: Fetch Monitoring path {path} with query parameters {parameters}.
        slots:
          path: path.path
          parameters: query.parameters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{path}'].put
  update:
    x-apievangelist-phrasing:
      intent: Send a raw PUT request to the Monitoring API
      effect: write
      questions:
      - Can I send a custom PUT to a Monitoring path that has no dedicated method?
      - Is there a passthrough for PUT calls on an arbitrary Monitoring endpoint?
      instructions:
      - text: Send a raw PUT request to Monitoring API path {path}.
        slots:
          path: path.path
      - text: PUT to Monitoring path {path} with query parameters {parameters}.
        slots:
          path: path.path
          parameters: query.parameters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{path}'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a raw POST request to the Monitoring API
      effect: write
      questions:
      - Can I POST to a Monitoring endpoint the SDK doesn't expose as a method?
      - What's the generic escape hatch for posting to any Monitoring API path?
      instructions:
      - text: Send a raw POST request to Monitoring API path {path}.
        slots:
          path: path.path
      - text: POST to Monitoring path {path} with query parameters {parameters}.
        slots:
          path: path.path
          parameters: query.parameters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{path}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Send a raw DELETE request to the Monitoring API
      effect: destructive
      questions:
      - Can I issue a DELETE against an arbitrary Monitoring API path?
      - Is there a generic delete call for Monitoring endpoints without a dedicated method?
      instructions:
      - text: Send a raw DELETE request to Monitoring API path {path}.
        slots:
          path: path.path
      - text: DELETE Monitoring path {path} with query parameters {parameters}.
        slots:
          path: path.path
          parameters: query.parameters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/1/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of all Algolia clusters
      effect: read
      questions:
      - Is Algolia up right now across all clusters?
      - Which clusters and instances are currently reporting a degraded status?
      instructions:
      - text: Show the status of every Algolia cluster.
      - text: Tell me whether any cluster anywhere is down right now.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/1/status/{clusters}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of specific clusters
      effect: read
      questions:
      - Is the cluster my application runs on operational?
      - How do I check the status of just a couple of named clusters?
      instructions:
      - text: Check the status of clusters {clusters}.
        slots:
          clusters: path.clusters
      - text: Confirm whether cluster {clusters} is operational right now.
        slots:
          clusters: path.clusters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/1/incidents'].get
  update:
    x-apievangelist-phrasing:
      intent: List known incidents across all clusters
      effect: read
      questions:
      - Are there any known incidents affecting Algolia clusters?
      - What incidents has the platform reported recently across every cluster?
      instructions:
      - text: List all known incidents across every cluster.
      - text: Show me every open or recent platform-wide incident.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/1/incidents/{clusters}'].get
  update:
    x-apievangelist-phrasing:
      intent: List incidents for specific clusters
      effect: read
      questions:
      - Has my cluster had any incidents lately?
      - Which incidents were reported against a particular set of clusters?
      instructions:
      - text: List incidents reported for clusters {clusters}.
        slots:
          clusters: path.clusters
      - text: Show any incidents logged against cluster {clusters}.
        slots:
          clusters: path.clusters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/1/inventory/servers'].get
  update:
    x-apievangelist-phrasing:
      intent: List the servers behind my clusters
      effect: read
      questions:
      - Which servers is my Algolia application assigned to?
      - What servers make up the clusters in the inventory?
      instructions:
      - text: List the servers assigned to my application's clusters.
      - text: Show the server inventory for my clusters.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/1/latency/{clusters}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get average search latency for clusters
      effect: read
      questions:
      - How fast are search requests on my cluster on average?
      - What's the current average search latency for a given cluster?
      instructions:
      - text: Show average search latency for clusters {clusters}.
        slots:
          clusters: path.clusters
      - text: Report how long searches take on cluster {clusters} right now.
        slots:
          clusters: path.clusters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/1/indexing/{clusters}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get indexing latency for clusters
      effect: read
      questions:
      - How long does indexing currently take on my cluster?
      - Is indexing on a specific cluster lagging behind?
      instructions:
      - text: Show indexing latency metrics for clusters {clusters}.
        slots:
          clusters: path.clusters
      - text: Check whether indexing is slow on cluster {clusters}.
        slots:
          clusters: path.clusters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/1/reachability/{clusters}/probes'].get
  update:
    x-apievangelist-phrasing:
      intent: Test whether clusters are reachable
      effect: read
      questions:
      - Can Algolia's probes reach my cluster?
      - How do I test network reachability for a set of clusters?
      instructions:
      - text: Run reachability probes against clusters {clusters}.
        slots:
          clusters: path.clusters
      - text: Tell me if cluster {clusters} is reachable from the probes.
        slots:
          clusters: path.clusters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/1/infrastructure/{metric}/period/{period}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get infrastructure metrics over a time window
      effect: read
      questions:
      - How do I pull every infrastructure metric for my Algolia servers aggregated over the last day?
      - What infrastructure metrics can I see aggregated over a chosen period on Premium or Elevate?
      instructions:
      - text: Get infrastructure metric {metric} over period {period}.
        slots:
          metric: path.metric
          period: path.period
      - text: Report {metric} for my servers aggregated over the last {period}.
        slots:
          metric: path.metric
          period: path.period
      method: generated
      generated: '2026-09-26'
- target: $.paths['/setClientApiKey'].get
  update:
    x-apievangelist-phrasing:
      intent: Switch the API key the Monitoring client uses
      effect: write
      questions:
      - Can I change which API key my Monitoring client authenticates with?
      - How do I rotate the key an existing Monitoring client sends?
      instructions:
      - text: Switch the Monitoring client to authenticate with API key {apiKey}.
        slots:
          apiKey: query.apiKey
      - text: Use {apiKey} for all further Monitoring API requests.
        slots:
          apiKey: query.apiKey
      method: generated
      generated: '2026-09-26'