Swetrix · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Swetrix Admin Views API

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

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/v1/project/{pid}/views'].get
$.paths['/v1/project/{pid}/views'].post
$.paths['/v1/project/{pid}/views/{viewId}'].get
$.paths['/v1/project/{pid}/views/{viewId}'].delete
$.paths['/v1/project/{pid}/views/{viewId}'].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 Swetrix Admin Views API
  version: 1.0.0
extends: openapi/swetrix-views-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: 5
- target: $.paths['/v1/project/{pid}/views'].get
  update:
    x-apievangelist-phrasing:
      intent: List a project's saved dashboard views
      effect: read
      questions:
      - Which saved segments exist on my project's dashboard?
      - Can I list saved views on a password-protected project?
      instructions:
      - text: List the saved views for project {pid}.
        slots:
          pid: path.pid
      - text: Show every saved dashboard segment in project {pid}.
        slots:
          pid: path.pid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/project/{pid}/views'].post
  update:
    x-apievangelist-phrasing:
      intent: Save a new dashboard view or segment
      effect: write
      questions:
      - How do I save a filtered segment of my dashboard for reuse?
      - Can a saved view include both filters and custom events?
      instructions:
      - text: Create a {type} view named {name} in project {pid}.
        slots:
          type: requestBody.type
          name: requestBody.name
          pid: path.pid
      - text: Save a new {type} segment {name} in project {pid} with filters {filters}.
        slots:
          type: requestBody.type
          name: requestBody.name
          pid: path.pid
          filters: requestBody.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/project/{pid}/views/{viewId}'].get
  update:
    x-apievangelist-phrasing:
      intent: View one saved dashboard view's configuration
      effect: read
      questions:
      - What filters are stored in a particular saved view?
      - Can I fetch a single saved segment's settings by its ID?
      instructions:
      - text: Get saved view {viewId} in project {pid}.
        slots:
          viewId: path.viewId
          pid: path.pid
      - text: Show the configuration of segment {viewId} on project {pid}.
        slots:
          viewId: path.viewId
          pid: path.pid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/project/{pid}/views/{viewId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a saved dashboard view
      effect: destructive
      questions:
      - How do I get rid of a saved segment I don't use anymore?
      - Can I delete one saved view from a project's dashboard?
      instructions:
      - text: Delete saved view {viewId} from project {pid}.
        slots:
          viewId: path.viewId
          pid: path.pid
      - text: Remove segment {viewId} on project {pid}.
        slots:
          viewId: path.viewId
          pid: path.pid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/project/{pid}/views/{viewId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a saved view's name, filters or events
      effect: write
      questions:
      - Can I change the filters on a segment I already saved?
      - Is renaming an existing saved view possible?
      instructions:
      - text: Rename saved view {viewId} in project {pid} to {name}.
        slots:
          viewId: path.viewId
          pid: path.pid
          name: requestBody.name
      - text: Update the filters of existing view {viewId} on project {pid} to {filters}.
        slots:
          viewId: path.viewId
          pid: path.pid
          filters: requestBody.filters
      method: generated
      generated: '2026-09-26'