Conga · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Extensibility Custom Code API
22 actions
22 updates
phrasing
extends
openapi/conga-custom-code-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Conga's API. It is a proposal applied on top of the contract, not a document Conga publishes.
What the actions change
x-apievangelist-phrasing
Targets 22 · first 16 shown; the file carries all of them
$.info
$.paths['/api/extensibility/v1/customcode'].get
$.paths['/api/extensibility/v1/customcode/execute'].post
$.paths['/api/extensibility/v1/customcode/migration/export/{Type}'].post
$.paths['/api/extensibility/v1/customcode/migration/import/{Type}'].post
$.paths['/api/extensibility/v1/customcode/trusted-apis'].get
$.paths['/api/extensibility/v1/customcode/trusted-apis'].post
$.paths['/api/extensibility/v1/customcode/trusted-apis/allowed-http-verbs'].get
$.paths['/api/extensibility/v1/customcode/trusted-apis/uri'].get
$.paths['/api/extensibility/v1/customcode/trusted-apis/{name}'].get
$.paths['/api/extensibility/v1/customcode/trusted-apis/{name}'].put
$.paths['/api/extensibility/v1/customcode/trusted-apis/{name}'].delete
$.paths['/api/extensibility/v1/customcode/trusted-objects'].get
$.paths['/api/extensibility/v1/customcode/trusted-objects'].post
$.paths['/api/extensibility/v1/customcode/trusted-objects/allowed-operations'].get
$.paths['/api/extensibility/v1/customcode/trusted-objects/{name}'].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 Extensibility Custom Code API
version: 1.0.0
extends: openapi/conga-custom-code-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: 21
- target: $.paths['/api/extensibility/v1/customcode'].get
update:
x-apievangelist-phrasing:
intent: List all custom code projects
effect: read
questions:
- Which custom code projects are deployed in my Conga platform?
- Can I see every custom code project with its details in one list?
instructions:
- text: List all custom code projects.
- text: Show me every custom code project and its information.
method: generated
generated: '2026-10-01'
- target: $.paths['/api/extensibility/v1/customcode/execute'].post
update:
x-apievangelist-phrasing:
intent: Run a custom code method
effect: write
questions:
- How do I invoke a method in one of my custom code projects on demand?
- Can I pass parameters when executing custom code?
instructions:
- text: Execute method {MethodName} of class {FullyQualifiedClassname} in custom code {Name}.
slots:
MethodName: requestBody.MethodName
FullyQualifiedClassname: requestBody.FullyQualifiedClassname
Name: requestBody.Name
- text: Run custom code {Name} with parameters {Parameters}.
slots:
Name: requestBody.Name
Parameters: requestBody.Parameters
method: generated
generated: '2026-10-01'
- target: $.paths['/api/extensibility/v1/customcode/migration/export/{Type}'].post
update:
x-apievangelist-phrasing:
intent: Export custom code projects or resources
effect: write
questions:
- How do I export custom code projects to move them to another org?
- Can I export just resources rather than whole projects for migration?
instructions:
- text: Export custom code of type {Type} for migration package {PackageId}.
slots:
Type: path.Type
PackageId: requestBody.PackageId
- text: Export {Type} using migration configuration {MigrationConfigurationId}.
slots:
Type: path.Type
MigrationConfigurationId: requestBody.MigrationConfigurationId
method: generated
generated: '2026-10-01'
- target: $.paths['/api/extensibility/v1/customcode/migration/import/{Type}'].post
update:
x-apievangelist-phrasing:
intent: Import custom code projects or resources
effect: write
questions:
- How do I bring exported custom code projects into this org?
- Can I import custom code resources from a migration package?
instructions:
- text: Import custom code of type {Type} from migration package {PackageId}.
slots:
Type: path.Type
PackageId: requestBody.PackageId
- text: Load {Type} into this org with migration configuration {MigrationConfigurationId}.
slots:
Type: path.Type
MigrationConfigurationId: requestBody.MigrationConfigurationId
method: generated
generated: '2026-10-01'
- target: $.paths['/api/extensibility/v1/customcode/trusted-apis'].get
update:
x-apievangelist-phrasing:
intent: List trusted API configurations
effect: read
questions:
- Which external APIs is custom code allowed to call?
- Can I see all trusted API entries for custom code?
instructions:
- text: List every trusted API configuration.
- text: Show all external endpoints custom code is trusted to call.
method: generated
generated: '2026-10-01'
- target: $.paths['/api/extensibility/v1/customcode/trusted-apis'].post
update:
x-apievangelist-phrasing:
intent: Add a trusted API configuration
effect: write
questions:
- How do I allow custom code to call a new external endpoint?
- Can I restrict which HTTP verbs a trusted API accepts when I add it?
instructions:
- text: Add trusted API {Name} for endpoint {Endpoint} allowing {AllowedHttpVerbs}.
slots:
Name: requestBody.Name
Endpoint: requestBody.Endpoint
AllowedHttpVerbs: requestBody.AllowedHttpVerbs
- text: Trust the new endpoint {Endpoint} for custom code calls.
slots:
Endpoint: requestBody.Endpoint
method: generated
generated: '2026-10-01'
- target: $.paths['/api/extensibility/v1/customcode/trusted-apis/allowed-http-verbs'].get
update:
x-apievangelist-phrasing:
intent: List HTTP verbs allowed for trusted APIs
effect: read
questions:
- What HTTP methods can a trusted API configuration permit?
- Which verbs are valid values when setting up a trusted API?
instructions:
- text: List the HTTP verbs a trusted API can allow.
- text: Show the permitted HTTP methods for trusted API setup.
method: generated
generated: '2026-10-01'
- target: $.paths['/api/extensibility/v1/customcode/trusted-apis/uri'].get
update:
x-apievangelist-phrasing:
intent: Find a trusted API configuration by URI
effect: read
questions:
- Is a given endpoint URL already registered as a trusted API?
- Can I look up a trusted API entry by its URI instead of its name?
instructions:
- text: Find the trusted API configuration for URI {uri}.
slots:
uri: query.uri
- text: Check whether {uri} is set up as a trusted endpoint.
slots:
uri: query.uri
method: generated
generated: '2026-10-01'
- target: $.paths['/api/extensibility/v1/customcode/trusted-apis/{name}'].get
update:
x-apievangelist-phrasing:
intent: Get a trusted API configuration by name
effect: read
questions:
- What endpoint and verbs does a named trusted API allow?
- How do I view a single trusted API entry by name?
instructions:
- text: Fetch the trusted API configuration named {name}.
slots:
name: path.name
- text: Show the endpoint and verbs for trusted API {name}.
slots:
name: path.name
method: generated
generated: '2026-10-01'
- target: $.paths['/api/extensibility/v1/customcode/trusted-apis/{name}'].put
update:
x-apievangelist-phrasing:
intent: Update a trusted API configuration
effect: write
questions:
- Can I change the endpoint of an existing trusted API?
- Is it possible to add more allowed verbs to a trusted API later?
instructions:
- text: Point trusted API {name} at endpoint {Endpoint}.
slots:
name: path.name
Endpoint: requestBody.Endpoint
- text: Change the allowed verbs on trusted API {name} to {AllowedHttpVerbs}.
slots:
name: path.name
AllowedHttpVerbs: requestBody.AllowedHttpVerbs
method: generated
generated: '2026-10-01'
- target: $.paths['/api/extensibility/v1/customcode/trusted-apis/{name}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a trusted API configuration
effect: destructive
questions:
- How do I stop custom code from calling an external API I trusted before?
- Can I remove a trusted API entry by name?
instructions:
- text: Delete the trusted API configuration {name}.
slots:
name: path.name
- text: Revoke trust for external API {name}.
slots:
name: path.name
method: generated
generated: '2026-10-01'
- target: $.paths['/api/extensibility/v1/customcode/trusted-objects'].get
update:
x-apievangelist-phrasing:
intent: List trusted object configurations
effect: read
questions:
- Which out-of-the-box objects can custom code access?
- What trusted object configurations exist?
instructions:
- text: List all trusted OOTB object configurations.
- text: Show which standard objects custom code is trusted to use.
method: generated
generated: '2026-10-01'
- target: $.paths['/api/extensibility/v1/customcode/trusted-objects'].post
update:
x-apievangelist-phrasing:
intent: Add a trusted object configuration
effect: write
questions:
- How do I let custom code work with a standard Conga object?
- Can I limit which operations custom code may perform on a trusted object?
instructions:
- text: Trust object {ObjectName} for custom code with operations {AllowedOperations}.
slots:
ObjectName: requestBody.ObjectName
AllowedOperations: requestBody.AllowedOperations
- text: Add a trusted object configuration for {ObjectName}.
slots:
ObjectName: requestBody.ObjectName
method: generated
generated: '2026-10-01'
- target: $.paths['/api/extensibility/v1/customcode/trusted-objects/allowed-operations'].get
update:
x-apievangelist-phrasing:
intent: List operations allowed on trusted objects
effect: read
questions:
- Which operations can be granted on a trusted object?
- What are the valid allowed-operation values for trusted objects?
instructions:
- text: List the operations a trusted object configuration can allow.
- text: Show valid allowed operations for trusted objects.
method: generated
generated: '2026-10-01'
- target: $.paths['/api/extensibility/v1/customcode/trusted-objects/{name}'].get
update:
x-apievangelist-phrasing:
intent: Get a trusted object configuration
effect: read
questions:
- What operations is custom code allowed on a particular trusted object?
- How do I view one trusted object configuration by object name?
instructions:
- text: Fetch the trusted object configuration for {name}.
slots:
name: path.name
- text: Show the allowed operations on trusted object {name}.
slots:
name: path.name
method: generated
generated: '2026-10-01'
- target: $.paths['/api/extensibility/v1/customcode/trusted-objects/{name}'].put
update:
x-apievangelist-phrasing:
intent: Update a trusted object configuration
effect: write
questions:
- Can I change which operations are allowed on an existing trusted object?
- Is it possible to narrow the operations on a trusted object after it was added?
instructions:
- text: Set the allowed operations on trusted object {name} to {AllowedOperations}.
slots:
name: path.name
AllowedOperations: requestBody.AllowedOperations
- text: Update trusted object configuration {name}.
slots:
name: path.name
method: generated
generated: '2026-10-01'
- target: $.paths['/api/extensibility/v1/customcode/trusted-objects/{name}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a trusted object configuration
effect: destructive
questions:
- How do I revoke custom code access to a standard object?
- Can I remove a trusted object entry entirely?
instructions:
- text: Delete the trusted object configuration for {name}.
slots:
name: path.name
- text: Remove {name} from the trusted objects list.
slots:
name: path.name
method: generated
generated: '2026-10-01'
- target: $.paths['/api/extensibility/v1/customcode/{name}'].get
update:
x-apievangelist-phrasing:
intent: Get a custom code project by name
effect: read
questions:
- What does a specific custom code project contain?
- Can I look up one custom code project by its project name?
instructions:
- text: Fetch custom code project {name}.
slots:
name: path.name
- text: Show the details of custom code {name}.
slots:
name: path.name
method: generated
generated: '2026-10-01'
- target: $.paths['/api/extensibility/v1/customcode/{name}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a custom code project
effect: destructive
questions:
- How do I remove a custom code project I no longer use?
- Can I delete custom code by project name?
instructions:
- text: Delete custom code project {name}.
slots:
name: path.name
- text: Remove the {name} custom code project from the org.
slots:
name: path.name
method: generated
generated: '2026-10-01'
- target: $.paths['/api/extensibility/v1/customcode/{name}/debuglog'].post
update:
x-apievangelist-phrasing:
intent: Turn debug logging on or off for custom code
effect: write
questions:
- How do I enable debug logs for a custom code project?
- Can I switch debug logging off again once I'm done troubleshooting?
instructions:
- text: Turn on debug logging for custom code {name}.
slots:
name: path.name
- text: Set debug log enabled to {enable} for project {name}.
slots:
enable: query.enable
name: path.name
method: generated
generated: '2026-10-01'
- target: $.paths['/api/extensibility/v1/customcode/{projectName}/download'].get
update:
x-apievangelist-phrasing:
intent: Download a custom code project as a ZIP
effect: read
questions:
- Can I download the source of a custom code project?
- What format does a custom code project download come in?
instructions:
- text: Download custom code project {projectName} as a ZIP.
slots:
projectName: path.projectName
- text: Get the ZIP archive for project {projectName}.
slots:
projectName: path.projectName
method: generated
generated: '2026-10-01'