Strivacity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Strivacity Consent API

8 actions 8 updates phrasing extends openapi/strivacity-consent-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 8

$.info

$.paths['/admin/api/v1/consents'].get

$.paths['/admin/api/v1/consents'].post

$.paths['/admin/api/v1/consents/{id}'].get

$.paths['/admin/api/v1/consents/{id}'].put

$.paths['/myaccount/api/v1/consents'].get

$.paths['/myaccount/api/v1/consents/{consentId}/optIn'].post

$.paths['/myaccount/api/v1/consents/{consentId}/optOut'].post

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 Strivacity Consent API
  version: 1.0.0
extends: openapi/strivacity-consent-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: 7
- target: $.paths['/admin/api/v1/consents'].get
  update:
    x-apievangelist-phrasing:
      intent: List configured consents
      effect: read
      questions:
      - Which consents have we configured for customers to accept?
      - Can I filter consent definitions by name or policy tag?
      instructions:
      - text: List all configured consents.
      - text: Find consent definitions named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/consents'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a consent
      effect: write
      questions:
      - How do I add a new terms or marketing consent?
      - What version must a newly created consent start at?
      instructions:
      - text: Create a consent named {name} with display text {text}.
        slots:
          name: requestBody.name
          text: requestBody.displayText
      - text: Add a new consent {name} showing {text} to customers.
        slots:
          name: requestBody.name
          text: requestBody.displayText
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/consents/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a consent definition
      effect: read
      questions:
      - What text and version does a consent definition have?
      - Can I look up one configured consent by its ID?
      instructions:
      - text: Get consent {id}.
        slots:
          id: path.id
      - text: Show the configured consent definition {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/consents/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a consent definition
      effect: write
      questions:
      - How do I publish a new version of a consent's wording?
      - Can I change consent text without bumping the version?
      instructions:
      - text: Update consent {id} with display text {text}.
        slots:
          id: path.id
          text: requestBody.displayText
      - text: Bump consent {id} to version {version}.
        slots:
          id: path.id
          version: requestBody.version
      method: generated
      generated: '2026-10-01'
- target: $.paths['/myaccount/api/v1/consents'].get
  update:
    x-apievangelist-phrasing:
      intent: List my own consents
      effect: read
      questions:
      - Which consents have I accepted on my account?
      - Can a signed-in customer see their own consents?
      instructions:
      - text: List the consents on my account.
      - text: Show which consents I have accepted or declined.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/myaccount/api/v1/consents/{consentId}/optIn'].post
  update:
    x-apievangelist-phrasing:
      intent: Accept a consent as the signed-in user
      effect: write
      questions:
      - How does a customer opt in to a consent themselves?
      - Can I accept a consent from my own account?
      instructions:
      - text: Accept consent {consent} on my account.
        slots:
          consent: path.consentId
      - text: Opt me in to consent {consent}.
        slots:
          consent: path.consentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/myaccount/api/v1/consents/{consentId}/optOut'].post
  update:
    x-apievangelist-phrasing:
      intent: Revoke a consent as the signed-in user
      effect: destructive
      questions:
      - How does a customer withdraw a consent they gave earlier?
      - Can I opt out of marketing consent from my account?
      instructions:
      - text: Revoke consent {consent} on my account.
        slots:
          consent: path.consentId
      - text: Opt me out of consent {consent}.
        slots:
          consent: path.consentId
      method: generated
      generated: '2026-10-01'