Strivacity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin Portal Instance Config API

4 actions 4 updates phrasing extends openapi/strivacity-instance-config-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 4

$.info
$.paths['/admin/api/v1/instance/config'].get
$.paths['/admin/api/v1/instance/config'].post
$.paths['/admin/api/v1/instance/config/addresses'].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 Portal Instance Config API
  version: 1.0.0
extends: openapi/strivacity-instance-config-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: 3
- target: $.paths['/admin/api/v1/instance/config'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the instance configuration
      effect: read
      questions:
      - What company name and IP allow list are set on my instance?
      - How can I see my tenant's instance-wide configuration?
      instructions:
      - text: Show the instance configuration.
      - text: Get the current IP allow list and company name for this instance.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/instance/config'].post
  update:
    x-apievangelist-phrasing:
      intent: Update the instance configuration
      effect: write
      questions:
      - How do I restrict admin access to an IP allow list?
      - Can I change the company name shown for my instance?
      instructions:
      - text: Set the instance company name to {companyName}.
        slots:
          companyName: requestBody.companyName
      - text: Update the instance IP allow list to {ipAllowedList} for company {companyName}.
        slots:
          ipAllowedList: requestBody.ipAllowedList
          companyName: requestBody.companyName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/instance/config/addresses'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the instance addresses
      effect: read
      questions:
      - What addresses does my instance use?
      - Where do I find the instance address to configure my integrations?
      instructions:
      - text: Show the instance addresses.
      - text: Get the address of this instance.
      method: generated
      generated: '2026-10-01'