deploy(arazzo): send associated openapi sources during workflow deployments

src/api/models.ts

@@ -23,8 +23,9 @@ export interface PreviewRequest {
 }
 
 export interface Reference {
-  content?: string
-  location?: string
+  content: string
+  location: string
+  name?: string
 }
 
 export interface VersionRequest {
@@ -82,6 +83,10 @@ export interface DiffItem {
 
 export interface WorkflowVersionRequest {
   definition: string // workflowDefinition
+  // List of API references attached to the
+  // workflow (source descriptions in Arazzo
+  // vocabulary)
+  references?: Reference[]
 }
 
 export interface WorkflowVersionResponse {

src/core/workflow-deploy.ts

@@ -50,9 +50,9 @@ export class WorkflowDeploy {
   ): Promise<WorkflowVersionResponse | undefined> {
     let version: WorkflowVersionResponse | undefined
 
-    const request: WorkflowVersionRequest = {
-      definition: workflowDefinition.rawDefinition,
-    }
+    const [definition, references] = await workflowDefinition.extractDefinition()
+
+    const request: WorkflowVersionRequest = {definition, references}
 
     // eslint-disable-next-line prefer-const
     version = await this.createWorkflowVersion(mcpServer, request, token)

test/commands/deploy.test.ts

@@ -3,7 +3,9 @@
 import nock from 'nock'
 import {stub} from 'sinon'
 
+import {API} from '../../src/definition'
+
 nock.disableNetConnect()
 
 process.env.BUMP_TOKEN = process.env.BUMP_TOKEN || 'BAR'
 
@@ -90,7 +92,7 @@
 
       it("doesn't try to auto create a documentation", async () => {
         nock('https://bump.sh')
           .post('/api/v1/validations', (body) => !body.auto_create_documentation)
           .reply(200)
 
         await runCommand(
@@ -110,7 +112,7 @@
   })
 
   describe('Successful runs with MCP server', () => {
-    it('sends new workflow definition to Bump', async () => {
+    it('sends new workflow definition (flower) to Bump', async () => {
       nock('https://bump.sh').post('/api/v1/mcp_servers/crab/deploy').reply(201, {})
 
       const {stderr, stdout} = await runCommand(
@@ -123,6 +125,33 @@
       )
     })
 
+    it('sends new workflow definition with openapi sources (arazzo) to Bump', async () => {
+      const [definition, references] = await (
+        await API.load('examples/valid/arazzo/wikimedia.json')
+      ).extractDefinition()
+      nock('https://bump.sh')
+        .post('/api/v1/mcp_servers/crab/deploy', (body) => {
+          const {content: expectedContent, location: expectedLocation, name: expectedName} = references[0]
+          const {content: actualContent, location: actualLocation, name: actualName} = body.references[0]
+          return (
+            body.definition === definition &&
+            expectedContent === actualContent &&
+            expectedName === actualName &&
+            expectedLocation === actualLocation
+          )
+        })
+        .reply(201, {})
+
+      const {stderr, stdout} = await runCommand(
+        ['deploy', 'examples/valid/arazzo/wikimedia.json', '--mcp-server', 'crab'].join(' '),
+      )
+
+      expect(stderr).to.contain("Let's deploy on Bump.sh... done\n")
+      expect(stdout).to.contain(
+        'Your crab MCP server...has received a new workflow definition which will soon be ready.',
+      )
+    })
+
     it('sends unchanged workflow definition to Bump', async () => {
       nock('https://bump.sh').post('/api/v1/mcp_servers/crab/deploy').reply(204)