Strivacity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin Portal Self Service Policy API

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

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/admin/api/v1/selfServicePolicies'].get
$.paths['/admin/api/v1/selfServicePolicies'].post
$.paths['/admin/api/v1/selfServicePolicies/{id}'].get
$.paths['/admin/api/v1/selfServicePolicies/{id}'].put
$.paths['/admin/api/v1/selfServicePolicies/{id}'].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 Admin Portal Self Service Policy API
  version: 1.0.0
extends: openapi/strivacity-self-service-policy-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: 5
- target: $.paths['/admin/api/v1/selfServicePolicies'].get
  update:
    x-apievangelist-phrasing:
      intent: List self-service policies
      effect: read
      questions:
      - Which self-service policies control what customers can change on their own?
      - Can I filter self-service policies by tag or name?
      instructions:
      - text: List self-service policies.
      - text: List self-service policies tagged {policyTags}.
        slots:
          policyTags: query.policyTags
      - text: Find self-service policies named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/selfServicePolicies'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a self-service policy
      effect: write
      questions:
      - How do I define what users can manage themselves in their account portal?
      - What options does a new self-service policy need?
      instructions:
      - text: Create self-service policy {name} with options {options}.
        slots:
          name: requestBody.name
          options: requestBody.options
      - text: Set up a {policyTag}-tagged self-service policy called {name} allowing {options}.
        slots:
          name: requestBody.name
          policyTag: requestBody.policyTag
          options: requestBody.options
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/selfServicePolicies/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a self-service policy
      effect: read
      questions:
      - What options are enabled in a particular self-service policy?
      - Can I view one self-service policy by ID?
      instructions:
      - text: Get self-service policy {id}.
        slots:
          id: path.id
      - text: Show the options in self-service policy {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/selfServicePolicies/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a self-service policy
      effect: write
      questions:
      - How do I change what customers can edit under an existing self-service policy?
      - Can I rename a self-service policy?
      instructions:
      - text: Update self-service policy {id} options to {options}.
        slots:
          id: path.id
          options: requestBody.options
      - text: Rename self-service policy {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/selfServicePolicies/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a self-service policy
      effect: destructive
      questions:
      - Why can't I delete a self-service policy that an application uses?
      - How do I remove a self-service policy?
      instructions:
      - text: Delete self-service policy {id}.
        slots:
          id: path.id
      - text: Remove the unused self-service policy {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'