bump-cli 2.9.12 → 2.10.0

package/README.md

@@ -9,15 +9,21 @@
   <a href="https://bump.sh/users/sign_up">Sign up</a>
 </p>
 
-The Bump.sh CLI is used to interact with API documentation and hubs hosted on Bump.sh from your choice of popular API description formats: OpenAPI, Swagger, or AsyncAPI.
+The Bump.sh CLI is used to interact with API documentation, hubs and workflows hosted on Bump.sh from your choice of popular API description formats: OpenAPI, Swagger, or AsyncAPI for API documentation. Flower or Arazzo for API workflows.
 
 Using [OpenAPI](https://github.com/OAI/OpenAPI-Specification) (v3.x and v2.0) or [AsyncAPI](https://www.asyncapi.com/docs/reference/specification/latest) (2.x), you can do any of the following:
 
 - Validate an API document before publishing to your documentation.
-- Publish an API document to your Bump.sh documentation or hubs.
-- Compare two API documents to generate a human-readable diff from your API definition.
+- [Publish an API document](#the-deploy-command) to your Bump.sh documentation or hubs.
+- [Compare two API documents](#the-diff-command) to generate a human-readable diff from your API definition.
 Under the hood, it uses the API of [developers.bump.sh](https://developers.bump.sh). And is built with the [`oclif`](https://oclif.io) framework in Typescript.
 
+Using [Flower](https://docs.bump.sh/help/mcp-servers/specification-support/flower-support/) or [Arazzo](https://docs.bump.sh/arazzo/v1.0/), you can:
+
+- [Deploy a workflow document](#deploy-a-workflow-document-on-your-mcp-server) to your Bump.sh MCP server
+
+Have fun designing APIs ✨.
+
 [![Version](https://img.shields.io/npm/v/bump-cli.svg)](https://npmjs.org/package/bump-cli)
 [![Tests](https://github.com/bump-sh/cli/actions/workflows/checks.yml/badge.svg)](https://github.com/bump-sh/cli/actions/workflows/checks.yml)
 [![License](https://img.shields.io/npm/l/bump-cli.svg)](https://github.com/bump-sh/cli/blob/master/package.json)
@@ -177,15 +183,25 @@ Please check `bump deploy --help` for more usage details.
 
 #### Deploy a workflow document on your MCP server
 
-Use the `bump deploy` command with the `--mcp-server` flag to push a workflow definition to your MCP server.
+Use the `bump deploy` command with the `--mcp-server` flag to push a
+workflow definition to your MCP server.
+
+Documents following either [Arazzo](https://docs.bump.sh/arazzo/v1.0/)
+or
+[Flower](https://docs.bump.sh/help/mcp-servers/specification-support/flower-support/)
+specification are supported.
+
 
 ```shell
-bump deploy path/to/flower-document.yml --mcp-server my-mcp-server-id-or-slug --token $BUMP_TOKEN
+bump deploy path/to/flower-or-arazzo-document.yml --mcp-server my-mcp-server-id-or-slug --token $BUMP_TOKEN
 ```
 
 > [!NOTE]
 > You can find your own `mcp-server-id-or-slug` and `$BUMP_TOKEN` api key from your [MCP server settings](https://bump.sh/dashboard) at 'https://bump.sh/{your-organization}/workflow/set/{mcp-server-id}/tokens'.
 
+More details about the MCP server feature are available on [this
+dedicated help section](https://docs.bump.sh/help/mcp-servers/).
+
 This feature is currently in closed beta.
 Request an early access at hello@bump.sh
 

package/dist/api/models.d.ts

@@ -17,8 +17,9 @@ export interface PreviewRequest {
     references?: Reference[];
 }
 export interface Reference {
-    content?: string;
-    location?: string;
+    content: string;
+    location: string;
+    name?: string;
 }
 export interface VersionRequest {
     auto_create_documentation?: boolean;
@@ -69,6 +70,7 @@ export interface DiffItem {
 }
 export interface WorkflowVersionRequest {
     definition: string;
+    references?: Reference[];
 }
 export interface WorkflowVersionResponse {
     id: string;

package/dist/core/overlay.js

@@ -119,7 +119,7 @@ export class Overlay {
     update(spec, parent, update, property_or_index) {
         try {
             // Deep merge objects using a module (built-in spread operator is only shallow)
-            const merger = mergician({ appendArrays: true });
+            const merger = mergician({ appendArrays: true, dedupArrays: true });
             if (property_or_index === '$') {
                 // You can't actually merge an update on a root object
                 // target with the jsonpathly lib, this is just us merging

package/dist/core/schemas/arazzo-schemas/index.d.ts

@@ -0,0 +1,7 @@
+import type { JSONSchema7 } from 'json-schema';
+declare const _default: {
+    schemas: {
+        '1.0': JSONSchema7;
+    };
+};
+export default _default;

package/dist/core/schemas/arazzo-schemas/index.js

@@ -0,0 +1,8 @@
+// Spec definitions are copied from the official
+// spec repo https://spec.openapis.org/arazzo/
+import schemaV10 from './v1.0/schema.json' with { type: 'json' };
+export default {
+    schemas: {
+        '1.0': schemaV10,
+    },
+};