arazzo: 1.0.1
info:
title: Pipedream Update Connect Project Settings
summary: Read a project's current settings, apply updates, and confirm the new values.
description: >-
A settings-management flow for an existing Connect project. The workflow
retrieves the project to capture its current configuration, patches the
project with the supplied name and Connect display settings, and retrieves
it again to confirm the changes persisted. Every step spells out its request
inline so the flow can be read and executed without opening the underlying
OpenAPI description.
version: 1.0.0
sourceDescriptions:
- name: projectsApi
url: ../openapi/pipedream-projects-api-openapi.yml
type: openapi
workflows:
- workflowId: update-project-settings
summary: Read, update, and verify a Connect project's settings.
description: >-
Retrieves the project's current settings, applies the supplied updates, and
re-reads the project to confirm the new values.
inputs:
type: object
required:
- projectId
properties:
projectId:
type: string
description: The project ID, which starts with proj_.
name:
type: string
description: Optional new display name for the project.
appName:
type: string
description: Optional new Connect application display name shown to end users.
supportEmail:
type: string
description: Optional new support email displayed to end users.
steps:
- stepId: readProject
description: >-
Retrieve the project to capture its current settings before applying
updates.
operationId: retrieveProject
parameters:
- name: project_id
in: path
value: $inputs.projectId
successCriteria:
- condition: $statusCode == 200
outputs:
currentName: $response.body#/name
currentAppName: $response.body#/app_name
- stepId: updateProject
description: >-
Patch the project with the supplied name and Connect display settings.
operationId: updateProject
parameters:
- name: project_id
in: path
value: $inputs.projectId
requestBody:
contentType: application/json
payload:
name: $inputs.name
app_name: $inputs.appName
support_email: $inputs.supportEmail
successCriteria:
- condition: $statusCode == 200
outputs:
updatedProject: $response.body
- stepId: verifyProject
description: >-
Re-read the project to confirm the updated settings persisted.
operationId: retrieveProject
parameters:
- name: project_id
in: path
value: $inputs.projectId
successCriteria:
- condition: $statusCode == 200
outputs:
verifiedName: $response.body#/name
verifiedAppName: $response.body#/app_name
outputs:
previousName: $steps.readProject.outputs.currentName
updatedProject: $steps.updateProject.outputs.updatedProject
verifiedName: $steps.verifyProject.outputs.verifiedName
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.