IntegrationOS · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for One Passthrough API
8 actions
8 updates
phrasing
extends
openapi/integration-os-passthrough-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 8
$.info
$.paths['/v1/passthrough/{key}'].get
$.paths['/v1/passthrough/{key}'].put
$.paths['/v1/passthrough/{key}'].post
$.paths['/v1/passthrough/{key}'].delete
$.paths['/v1/passthrough/{key}'].patch
$.paths['/v1/passthrough/{key}'].head
$.paths['/v1/passthrough/{key}'].options
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 Passthrough API
version: 1.0.0
extends: openapi/integration-os-passthrough-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['/v1/passthrough/{key}'].get
update:
x-apievangelist-phrasing:
intent: Read data from a platform via a raw GET
effect: read
questions:
- How do I fetch a record from a connected platform when no ready-made action covers it?
- Can I send a raw GET to an upstream endpoint and have my connection's credentials signed in for me?
instructions:
- text: Send a passthrough GET to {key} on connection {connection}.
slots:
key: path.key
connection: header.X-One-Connection-Key
- text: Read upstream path {key} with a GET using connection {connection} and action {action}.
slots:
key: path.key
connection: header.X-One-Connection-Key
action: header.X-One-Action-Id
method: generated
generated: '2026-10-01'
- target: $.paths['/v1/passthrough/{key}'].put
update:
x-apievangelist-phrasing:
intent: Replace a platform record via a raw PUT
effect: write
questions:
- Can I overwrite a whole record on a connected platform with a raw PUT call?
- Which headers does a passthrough PUT need so the upstream call uses the right connection?
instructions:
- text: Send a passthrough PUT to {key} on connection {connection} to replace that record.
slots:
key: path.key
connection: header.X-One-Connection-Key
- text: Replace the upstream resource at {key} with a PUT via connection {connection}, action {action}.
slots:
key: path.key
connection: header.X-One-Connection-Key
action: header.X-One-Action-Id
method: generated
generated: '2026-10-01'
- target: $.paths['/v1/passthrough/{key}'].post
update:
x-apievangelist-phrasing:
intent: Create on a platform via a raw POST
effect: write
questions:
- How do I create something on a connected platform through a raw POST when there's no built-in action?
- Is the request body kept intact when I POST through the passthrough proxy?
instructions:
- text: Send a passthrough POST to {key} on connection {connection}.
slots:
key: path.key
connection: header.X-One-Connection-Key
- text: Create a record upstream by POSTing to {key} through connection {connection} using action {action}.
slots:
key: path.key
connection: header.X-One-Connection-Key
action: header.X-One-Action-Id
method: generated
generated: '2026-10-01'
- target: $.paths['/v1/passthrough/{key}'].delete
update:
x-apievangelist-phrasing:
intent: Delete on a platform via a raw DELETE
effect: destructive
questions:
- Can I remove a record on a connected platform by forwarding a raw DELETE?
- What does the passthrough proxy need to delete an upstream resource with my stored credentials?
instructions:
- text: Send a passthrough DELETE to {key} on connection {connection}.
slots:
key: path.key
connection: header.X-One-Connection-Key
- text: Delete the upstream resource at {key} via connection {connection} and action {action}.
slots:
key: path.key
connection: header.X-One-Connection-Key
action: header.X-One-Action-Id
method: generated
generated: '2026-10-01'
- target: $.paths['/v1/passthrough/{key}'].patch
update:
x-apievangelist-phrasing:
intent: Partly update a platform record via raw PATCH
effect: write
questions:
- How do I change just a few fields on a connected platform's record with a raw PATCH?
- Can a passthrough PATCH run in an organization or project tenant instead of my personal scope?
instructions:
- text: Send a passthrough PATCH to {key} on connection {connection}.
slots:
key: path.key
connection: header.X-One-Connection-Key
- text: Patch selected fields at upstream path {key} through connection {connection} in project {project}.
slots:
key: path.key
connection: header.X-One-Connection-Key
project: header.X-One-Project-Id
method: generated
generated: '2026-10-01'
- target: $.paths['/v1/passthrough/{key}'].head
update:
x-apievangelist-phrasing:
intent: Check a platform resource via a raw HEAD
effect: read
questions:
- Can I check whether an upstream resource exists with a HEAD request, without pulling the body?
- Does the passthrough proxy forward HEAD requests to the connected platform?
instructions:
- text: Send a passthrough HEAD to {key} on connection {connection}.
slots:
key: path.key
connection: header.X-One-Connection-Key
- text: Check headers only for upstream path {key} via connection {connection}, action {action}.
slots:
key: path.key
connection: header.X-One-Connection-Key
action: header.X-One-Action-Id
method: generated
generated: '2026-10-01'
- target: $.paths['/v1/passthrough/{key}'].options
update:
x-apievangelist-phrasing:
intent: Probe a platform endpoint via raw OPTIONS
effect: read
questions:
- How do I find which methods an upstream endpoint allows by forwarding an OPTIONS request?
- Can the passthrough proxy send an OPTIONS preflight to a connected platform?
instructions:
- text: Send a passthrough OPTIONS request to {key} on connection {connection}.
slots:
key: path.key
connection: header.X-One-Connection-Key
- text: Ask upstream path {key} which methods it allows, via connection {connection} and action {action}.
slots:
key: path.key
connection: header.X-One-Connection-Key
action: header.X-One-Action-Id
method: generated
generated: '2026-10-01'