Strivacity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin Portal Translation API

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

$.info
$.paths['/admin/api/v1/translations'].get
$.paths['/admin/api/v1/translations/{languageCode}'].get
$.paths['/admin/api/v1/translations/{languageCode}'].post
$.paths['/admin/api/v1/translations/{languageCode}'].delete
$.paths['/admin/api/v1/translations/{languageCode}/disable'].post
$.paths['/admin/api/v1/translations/{languageCode}/enable'].post

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 Translation API
  version: 1.0.0
extends: openapi/strivacity-translation-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: 6
- target: $.paths['/admin/api/v1/translations'].get
  update:
    x-apievangelist-phrasing:
      intent: List admin console translations
      effect: read
      questions:
      - Which languages have translations in my instance?
      - Can I see all available translations and whether they're enabled?
      instructions:
      - text: List all translations.
      - text: Show every language translation we have.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/translations/{languageCode}'].get
  update:
    x-apievangelist-phrasing:
      intent: Export a language translation
      effect: read
      questions:
      - How do I download the translation file for a language?
      - Can I export the current French translation to edit it?
      instructions:
      - text: Export the translation for language {lang}.
        slots:
          lang: path.languageCode
      - text: Download the {lang} translation file.
        slots:
          lang: path.languageCode
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/translations/{languageCode}'].post
  update:
    x-apievangelist-phrasing:
      intent: Import a language translation
      effect: write
      questions:
      - How do I upload my own translated strings for a language?
      - Can I import a translation file to override default text?
      instructions:
      - text: Import translation file {file} for language {lang}.
        slots:
          file: requestBody.file
          lang: path.languageCode
      - text: Upload new {lang} translations from {file}.
        slots:
          lang: path.languageCode
          file: requestBody.file
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/translations/{languageCode}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Reset a language translation to default
      effect: destructive
      questions:
      - How do I undo a translation I imported?
      - Can I clear custom translations for one language?
      instructions:
      - text: Reset the translation for language {lang}.
        slots:
          lang: path.languageCode
      - text: Clear imported {lang} translations back to default.
        slots:
          lang: path.languageCode
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/translations/{languageCode}/disable'].post
  update:
    x-apievangelist-phrasing:
      intent: Disable a language
      effect: write
      questions:
      - How do I stop offering a language to users?
      - Can I turn off a translation without deleting it?
      instructions:
      - text: Disable language {lang}.
        slots:
          lang: path.languageCode
      - text: Turn off the {lang} translation.
        slots:
          lang: path.languageCode
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/translations/{languageCode}/enable'].post
  update:
    x-apievangelist-phrasing:
      intent: Enable a language
      effect: write
      questions:
      - How do I make a new language available to users?
      - Can I switch a disabled translation back on?
      instructions:
      - text: Enable language {lang}.
        slots:
          lang: path.languageCode
      - text: Turn on the {lang} translation.
        slots:
          lang: path.languageCode
      method: generated
      generated: '2026-10-01'