IntegrationOS · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for One Event Access API
10 actions
10 updates
phrasing
extends
openapi/integration-os-event-access-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for IntegrationOS's API. It is a proposal applied on top of the contract, not a document IntegrationOS publishes.
What the actions change
x-apievangelist-phrasing
Targets 10
$.info
$.paths['/v1/event-access'].get
$.paths['/v1/event-access'].post
$.paths['/v1/event-access/organizations/{org_id}'].get
$.paths['/v1/event-access/organizations/{org_id}'].post
$.paths['/v1/event-access/organizations/{org_id}/projects/{project_id}'].get
$.paths['/v1/event-access/organizations/{org_id}/projects/{project_id}'].post
$.paths['/v1/event-access/organizations/{org_id}/projects/{project_id}/{key_id}'].delete
$.paths['/v1/event-access/organizations/{org_id}/{key_id}'].delete
$.paths['/v1/event-access/{id}'].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 One Event Access API
version: 1.0.0
extends: openapi/integration-os-event-access-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: 9
- target: $.paths['/v1/event-access'].get
update:
x-apievangelist-phrasing:
intent: List my event access keys
effect: read
questions:
- Which event access keys exist in my personal scope?
- Can I list event access keys for just the test environment?
instructions:
- text: List my event access keys, page {page}.
slots:
page: query.page
- text: Show my personal event access keys in the {environment} environment, page {page}.
slots:
environment: query.environment
page: query.page
method: generated
generated: '2026-10-01'
- target: $.paths['/v1/event-access'].post
update:
x-apievangelist-phrasing:
intent: Create a personal event access key
effect: write
questions:
- How do I create an event access key in my own account?
- Can a personal event access key use the default OAuth credentials?
instructions:
- text: Create a personal event access key for connector definition {connection_definition_id} in {environment}, active {active}.
slots:
connection_definition_id: requestBody.connectionDefinitionId
environment: requestBody.environment
active: requestBody.active
- text: Make me an event access key on {connection_definition_id} for the {environment} environment with scopes {scopes}, active {active}.
slots:
connection_definition_id: requestBody.connectionDefinitionId
environment: requestBody.environment
scopes: requestBody.scopes
active: requestBody.active
method: generated
generated: '2026-10-01'
- target: $.paths['/v1/event-access/organizations/{org_id}'].get
update:
x-apievangelist-phrasing:
intent: List an organization's event access keys
effect: read
questions:
- What event access keys belong to my organization?
- Can I see an org's event access keys for the live environment only?
instructions:
- text: List event access keys for organization {org_id}, page {page}.
slots:
org_id: path.org_id
page: query.page
- text: Show org {org_id}'s {environment} event access keys, page {page}.
slots:
org_id: path.org_id
environment: query.environment
page: query.page
method: generated
generated: '2026-10-01'
- target: $.paths['/v1/event-access/organizations/{org_id}'].post
update:
x-apievangelist-phrasing:
intent: Create an organization event access key
effect: write
questions:
- How do I create an event access key at the organization level?
- Can I tag an org event access key with labels, and how many?
instructions:
- text: Create an event access key in org {org_id} for connection type {connection_type} in {environment}.
slots:
org_id: path.org_id
connection_type: requestBody.connectionType
environment: requestBody.environment
- text: Add org {org_id} event access key {name} ({connection_type}, {environment}) tagged {tags}.
slots:
org_id: path.org_id
name: requestBody.name
connection_type: requestBody.connectionType
environment: requestBody.environment
tags: requestBody.tags
method: generated
generated: '2026-10-01'
- target: $.paths['/v1/event-access/organizations/{org_id}/projects/{project_id}'].get
update:
x-apievangelist-phrasing:
intent: List a project's event access keys
effect: read
questions:
- Which event access keys are scoped to a single project?
- Can I page through one project's event access keys by environment?
instructions:
- text: List event access keys for project {project_id} in org {org_id}, page {page}.
slots:
project_id: path.project_id
org_id: path.org_id
page: query.page
- text: Show project {project_id}'s {environment} event access keys under organization {org_id}, page {page}.
slots:
project_id: path.project_id
environment: query.environment
org_id: path.org_id
page: query.page
method: generated
generated: '2026-10-01'
- target: $.paths['/v1/event-access/organizations/{org_id}/projects/{project_id}'].post
update:
x-apievangelist-phrasing:
intent: Create a project event access key
effect: write
questions:
- How do I create an event access key for one project?
- Can a project event access key be hidden?
instructions:
- text: Set up a project-level event access key for {project_id} (organization {org_id}), connection type {connection_type}, {environment}.
slots:
project_id: path.project_id
org_id: path.org_id
connection_type: requestBody.connectionType
environment: requestBody.environment
- text: Add project {project_id} event access key {name} under organization {org_id}, type {connection_type}, environment {environment}.
slots:
project_id: path.project_id
name: requestBody.name
org_id: path.org_id
connection_type: requestBody.connectionType
environment: requestBody.environment
method: generated
generated: '2026-10-01'
- target: $.paths['/v1/event-access/organizations/{org_id}/projects/{project_id}/{key_id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a project event access key
effect: destructive
questions:
- How do I revoke an event access key that belongs to a project?
- Can I delete one project's event access key without touching org keys?
instructions:
- text: Delete event access key {key_id} from project {project_id} in org {org_id}.
slots:
key_id: path.key_id
project_id: path.project_id
org_id: path.org_id
- text: Revoke project {project_id}'s event access key {key_id} under organization {org_id}.
slots:
project_id: path.project_id
key_id: path.key_id
org_id: path.org_id
method: generated
generated: '2026-10-01'
- target: $.paths['/v1/event-access/organizations/{org_id}/{key_id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete an organization event access key
effect: destructive
questions:
- How do I revoke an organization-level event access key?
- Is there a way to remove an event access key from my org?
instructions:
- text: Delete event access key {key_id} from organization {org_id}.
slots:
key_id: path.key_id
org_id: path.org_id
- text: Revoke org {org_id}'s event access key {key_id}.
slots:
key_id: path.key_id
org_id: path.org_id
method: generated
generated: '2026-10-01'
- target: $.paths['/v1/event-access/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a personal event access key
effect: destructive
questions:
- How do I delete an event access key from my personal scope?
- Can I revoke one of my own event access keys by id?
instructions:
- text: Delete my event access key {id}.
slots:
id: path.id
- text: Revoke personal event access key {id}.
slots:
id: path.id
method: generated
generated: '2026-10-01'