Contentstack · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Contentstack Projects API
11 actions
11 updates
phrasing
extends
openapi/contentstack-projects-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Contentstack's API. It is a proposal applied on top of the contract, not a document Contentstack publishes.
What the actions change
x-apievangelist-phrasing
Targets 11
$.info
$.paths['/v1/organizations/{organization_uid}/projects'].get
$.paths['/v1/organizations/{organization_uid}/projects'].post
$.paths['/v1/organizations/{organization_uid}/projects/{project_uid}'].get
$.paths['/v1/organizations/{organization_uid}/projects/{project_uid}'].put
$.paths['/v1/organizations/{organization_uid}/projects/{project_uid}'].delete
$.paths['/projects'].get
$.paths['/projects'].post
$.paths['/projects/{project_uid}'].get
$.paths['/projects/{project_uid}'].put
$.paths['/projects/{project_uid}'].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 Contentstack Projects API
version: 1.0.0
extends: openapi/contentstack-projects-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: 10
- target: $.paths['/v1/organizations/{organization_uid}/projects'].get
update:
x-apievangelist-phrasing:
intent: List automation projects in an organization
effect: read
questions:
- Which Automation Hub projects exist in my Contentstack organization?
- Where can I see all the automation projects that group my workflows and variables?
instructions:
- text: List the automation projects in organization {org}.
slots:
org: path.organization_uid
- text: Show every Automation Hub project under org {org}.
slots:
org: path.organization_uid
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organization_uid}/projects'].post
update:
x-apievangelist-phrasing:
intent: Create an automation project
effect: write
questions:
- How do I start a new Automation Hub project to hold my automations?
- Can I add a description when I create an automation project?
instructions:
- text: Create an automation project named {name} in organization {org}.
slots:
name: requestBody.name
org: path.organization_uid
- text: Set up a new Automation Hub project {name} in org {org} described as {description}.
slots:
name: requestBody.name
org: path.organization_uid
description: requestBody.description
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organization_uid}/projects/{project_uid}'].get
update:
x-apievangelist-phrasing:
intent: Get an automation project's details
effect: read
questions:
- What's the status and creation date of one of my automation projects?
- How can I look up a single Automation Hub project by its UID?
instructions:
- text: Show automation project {project} in organization {org}.
slots:
project: path.project_uid
org: path.organization_uid
- text: Get the details of Automation Hub project {project} in org {org}.
slots:
project: path.project_uid
org: path.organization_uid
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organization_uid}/projects/{project_uid}'].put
update:
x-apievangelist-phrasing:
intent: Rename or redescribe an automation project
effect: write
questions:
- Can I rename an Automation Hub project after creating it?
- How do I change the description of an existing automation project?
instructions:
- text: Rename automation project {project} in org {org} to {name}.
slots:
project: path.project_uid
org: path.organization_uid
name: requestBody.name
- text: Update Automation Hub project {project} in org {org} with name {name} and description {description}.
slots:
project: path.project_uid
org: path.organization_uid
name: requestBody.name
description: requestBody.description
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organization_uid}/projects/{project_uid}'].delete
update:
x-apievangelist-phrasing:
intent: Delete an automation project
effect: destructive
questions:
- What gets removed when I delete an Automation Hub project?
- Is deleting an automation project with its automations and variables reversible?
instructions:
- text: Delete automation project {project} from organization {org}.
slots:
project: path.project_uid
org: path.organization_uid
- text: Permanently remove Automation Hub project {project} and its automations in org {org}.
slots:
project: path.project_uid
org: path.organization_uid
method: generated
generated: '2026-09-26'
- target: $.paths['/projects'].get
update:
x-apievangelist-phrasing:
intent: List Launch hosting projects
effect: read
questions:
- Which Contentstack Launch projects do I have for hosting web apps?
- How many environments does each of my Launch projects have?
instructions:
- text: List all my Launch projects.
- text: Show the Launch web hosting projects I can access with their environment counts.
method: generated
generated: '2026-09-26'
- target: $.paths['/projects'].post
update:
x-apievangelist-phrasing:
intent: Create a Launch project for a web app
effect: write
questions:
- How do I create a Launch project to deploy my website?
- Can I set the framework when creating a new Launch project?
instructions:
- text: Create a Launch project named {name}.
slots:
name: requestBody.name
- text: Create Launch project {name} using the {framework} framework.
slots:
name: requestBody.name
framework: requestBody.framework
method: generated
generated: '2026-09-26'
- target: $.paths['/projects/{project_uid}'].get
update:
x-apievangelist-phrasing:
intent: Get a Launch project's details
effect: read
questions:
- Which stack is a given Launch project linked to?
- How do I check the configuration and status of one Launch project?
instructions:
- text: Show Launch project {project}.
slots:
project: path.project_uid
- text: Get the configuration and linked stack for Launch project {project}.
slots:
project: path.project_uid
method: generated
generated: '2026-09-26'
- target: $.paths['/projects/{project_uid}'].put
update:
x-apievangelist-phrasing:
intent: Update a Launch project's settings
effect: write
questions:
- Can I change the framework setting of an existing Launch project?
- How do I rename a Launch hosting project?
instructions:
- text: Rename Launch project {project} to {name}.
slots:
project: path.project_uid
name: requestBody.name
- text: Switch Launch project {project} named {name} to framework {framework}.
slots:
project: path.project_uid
name: requestBody.name
framework: requestBody.framework
method: generated
generated: '2026-09-26'
- target: $.paths['/projects/{project_uid}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a Launch project
effect: destructive
questions:
- Does deleting a Launch project also wipe its environments and deployment history?
- How do I remove a Launch hosting project I no longer need?
instructions:
- text: Delete Launch project {project}.
slots:
project: path.project_uid
- text: Permanently remove Launch project {project} with all its environments and deployments.
slots:
project: path.project_uid
method: generated
generated: '2026-09-26'