Adobe Suite · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Reactor Secrets API
12 actions
12 updates
phrasing
extends
openapi/adobe-suite-secrets-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Adobe Suite's API. It is a proposal applied on top of the contract, not a document Adobe Suite publishes.
What the actions change
x-apievangelist-phrasing
Targets 12
$.info
$.paths['/properties/{PROPERTY_ID}/secrets'].get
$.paths['/properties/{PROPERTY_ID}/secrets'].post
$.paths['/secrets/{SECRET_ID}'].get
$.paths['/secrets/{SECRET_ID}'].delete
$.paths['/secrets/{SECRET_ID}'].patch
$.paths['/environments/{ENVIRONMENT_ID}/secrets'].get
$.paths['/secrets/{SECRET_ID}/notes'].get
$.paths['/secrets/{SECRET_ID}/notes'].post
$.paths['/secrets/{SECRET_ID}/data_elements'].get
$.paths['/secrets/{SECRET_ID}/environment'].get
$.paths['/secrets/{SECRET_ID}/property'].get
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 Reactor Secrets API
version: 1.0.0
extends: openapi/adobe-suite-secrets-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 11
- target: $.paths['/properties/{PROPERTY_ID}/secrets'].get
update:
x-apievangelist-phrasing:
intent: List a tag property's secrets
effect: read
questions:
- How do I see all the secrets stored on a tags property?
- Can I filter a property's secrets by environment, status or type?
- Which secrets on my property have a given name?
instructions:
- text: List the secrets for property {PROPERTY_ID}.
slots:
PROPERTY_ID: path.PROPERTY_ID
- text: Show secrets on property {PROPERTY_ID} with status {status}.
slots:
PROPERTY_ID: path.PROPERTY_ID
status: query.status
- text: List property {PROPERTY_ID} secrets in environment {environment_id}.
slots:
PROPERTY_ID: path.PROPERTY_ID
environment_id: query.environment_id
method: generated
generated: '2026-09-26'
- target: $.paths['/properties/{PROPERTY_ID}/secrets'].post
update:
x-apievangelist-phrasing:
intent: Create a secret on a tag property
effect: write
questions:
- How do I add a new secret, like OAuth or token credentials, to a tags property?
- Can I create an event forwarding secret through the Reactor API?
instructions:
- text: Create a secret on property {PROPERTY_ID} with {data}.
slots:
PROPERTY_ID: path.PROPERTY_ID
data: requestBody.data
- text: Add a new secret to property {PROPERTY_ID}.
slots:
PROPERTY_ID: path.PROPERTY_ID
method: generated
generated: '2026-09-26'
- target: $.paths['/secrets/{SECRET_ID}'].get
update:
x-apievangelist-phrasing:
intent: Get a secret's details
effect: read
questions:
- How do I look up one secret by its ID?
- Can I check a secret's status and type?
instructions:
- text: Show secret {SECRET_ID}.
slots:
SECRET_ID: path.SECRET_ID
- text: Get the details and status of secret {SECRET_ID}.
slots:
SECRET_ID: path.SECRET_ID
method: generated
generated: '2026-09-26'
- target: $.paths['/secrets/{SECRET_ID}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a secret
effect: destructive
questions:
- How do I delete a secret I no longer need?
- Can I permanently remove a secret from my tags setup?
instructions:
- text: Delete secret {SECRET_ID}.
slots:
SECRET_ID: path.SECRET_ID
- text: Remove secret {SECRET_ID} permanently.
slots:
SECRET_ID: path.SECRET_ID
method: generated
generated: '2026-09-26'
- target: $.paths['/secrets/{SECRET_ID}'].patch
update:
x-apievangelist-phrasing:
intent: Test or retry a secret's credential exchange
effect: write
questions:
- How do I manually retry the credential exchange for a secret?
- Can I test an oauth2 secret against the authorization service without changing it?
instructions:
- text: Retry the exchange for secret {SECRET_ID}.
slots:
SECRET_ID: path.SECRET_ID
- text: Test or retry secret {SECRET_ID} with payload {data}.
slots:
SECRET_ID: path.SECRET_ID
data: requestBody.data
method: generated
generated: '2026-09-26'
- target: $.paths['/environments/{ENVIRONMENT_ID}/secrets'].get
update:
x-apievangelist-phrasing:
intent: List an environment's secrets
effect: read
questions:
- Which secrets are bound to a particular environment?
- Can I page through the secrets in one environment?
instructions:
- text: List secrets in environment {ENVIRONMENT_ID}.
slots:
ENVIRONMENT_ID: path.ENVIRONMENT_ID
- text: Show page {page_number} of environment {ENVIRONMENT_ID} secrets.
slots:
ENVIRONMENT_ID: path.ENVIRONMENT_ID
page_number: query.page[number]
method: generated
generated: '2026-09-26'
- target: $.paths['/secrets/{SECRET_ID}/notes'].get
update:
x-apievangelist-phrasing:
intent: List notes on a secret
effect: read
questions:
- How do I read the notes left on a secret?
- Can I search a secret's notes by text?
instructions:
- text: List notes on secret {SECRET_ID}.
slots:
SECRET_ID: path.SECRET_ID
- text: Find notes on secret {SECRET_ID} containing {text}.
slots:
SECRET_ID: path.SECRET_ID
text: query.text
method: generated
generated: '2026-09-26'
- target: $.paths['/secrets/{SECRET_ID}/notes'].post
update:
x-apievangelist-phrasing:
intent: Add a note to a secret
effect: write
questions:
- Can I leave a note on a secret for my team?
- How do I annotate a secret with a comment?
instructions:
- text: Add a note to secret {SECRET_ID}.
slots:
SECRET_ID: path.SECRET_ID
- text: Create a note on secret {SECRET_ID} explaining its purpose.
slots:
SECRET_ID: path.SECRET_ID
method: generated
generated: '2026-09-26'
- target: $.paths['/secrets/{SECRET_ID}/data_elements'].get
update:
x-apievangelist-phrasing:
intent: List data elements that use a secret
effect: read
questions:
- Which data elements reference this secret?
- Can I see only published or enabled data elements using a secret?
instructions:
- text: List data elements that reference secret {SECRET_ID}.
slots:
SECRET_ID: path.SECRET_ID
- text: Show enabled data elements using secret {SECRET_ID} where enabled is {enabled}.
slots:
SECRET_ID: path.SECRET_ID
enabled: query.enabled
method: generated
generated: '2026-09-26'
- target: $.paths['/secrets/{SECRET_ID}/environment'].get
update:
x-apievangelist-phrasing:
intent: Get the environment a secret belongs to
effect: read
questions:
- Which environment is this secret tied to?
- How do I find the environment for a given secret?
instructions:
- text: Show the environment for secret {SECRET_ID}.
slots:
SECRET_ID: path.SECRET_ID
- text: Which environment owns secret {SECRET_ID}.
slots:
SECRET_ID: path.SECRET_ID
method: generated
generated: '2026-09-26'
- target: $.paths['/secrets/{SECRET_ID}/property'].get
update:
x-apievangelist-phrasing:
intent: Get the property a secret belongs to
effect: read
questions:
- What tags property does this secret live under?
- How can I look up the parent property of a secret?
instructions:
- text: Show the property that owns secret {SECRET_ID}.
slots:
SECRET_ID: path.SECRET_ID
- text: Get the parent property of secret {SECRET_ID}.
slots:
SECRET_ID: path.SECRET_ID
method: generated
generated: '2026-09-26'