Strivacity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin Portal Organization Policy API

6 actions 6 updates phrasing extends openapi/strivacity-organization-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/v2/applications/{appId}/organizations'].get

$.paths['/admin/api/v2/applications/{appId}/organizations'].post

$.paths['/admin/api/v2/applications/{appId}/organizations/{orgId}'].get

$.paths['/admin/api/v2/applications/{appId}/organizations/{orgId}'].put

$.paths['/admin/api/v2/applications/{appId}/organizations/{orgId}'].delete

OpenAPI Overlay

# 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 Organization Policy API
  version: 1.0.0
extends: openapi/strivacity-organization-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/v2/applications/{appId}/organizations'].get
  update:
    x-apievangelist-phrasing:
      intent: List an application's organization policies
      effect: read
      questions:
      - Which organizations have custom policies on my application?
      - Can I see organization-specific overrides for one app?
      instructions:
      - text: List organization policies for application {app}.
        slots:
          app: path.appId
      - text: Show organization overrides on app {app}.
        slots:
          app: path.appId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v2/applications/{appId}/organizations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an organization policy for an app
      effect: write
      questions:
      - How do I give one organization its own login providers on an app?
      - Can an organization have different policies within an application?
      instructions:
      - text: Create an organization policy for organization {org} on application {app}.
        slots:
          org: requestBody.organization
          app: path.appId
      - text: Add login providers {providers} for organization {org} on app {app}.
        slots:
          providers: requestBody.loginProviders
          org: requestBody.organization
          app: path.appId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v2/applications/{appId}/organizations/{orgId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an organization policy for an app
      effect: read
      questions:
      - What policies apply to one organization on my application?
      - Can I view the policy for a single organization on an app?
      instructions:
      - text: Get the policy of organization {org} on application {app}.
        slots:
          org: path.orgId
          app: path.appId
      - text: Show organization {org}'s settings on app {app}.
        slots:
          org: path.orgId
          app: path.appId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v2/applications/{appId}/organizations/{orgId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an organization policy for an app
      effect: write
      questions:
      - How do I change the login providers an organization uses on an app?
      - Can I update an organization's policies within an application?
      instructions:
      - text: Update the policy of organization {org} on application {app}.
        slots:
          org: path.orgId
          app: path.appId
      - text: Change login providers for organization {org} on app {app} to {providers}.
        slots:
          org: path.orgId
          app: path.appId
          providers: requestBody.loginProviders
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v2/applications/{appId}/organizations/{orgId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an organization policy from an app
      effect: destructive
      questions:
      - How do I remove an organization's override from an application?
      - Can I delete an organization policy on an app?
      instructions:
      - text: Delete the policy of organization {org} on application {app}.
        slots:
          org: path.orgId
          app: path.appId
      - text: Remove organization {org}'s override from app {app}.
        slots:
          org: path.orgId
          app: path.appId
      method: generated
      generated: '2026-10-01'