@xyd-js/openapi2opencli 0.0.0-canary-4287eee-20260630010340

package/__fixtures__/1.basic/output.json

@@ -0,0 +1,74 @@
+{
+  "opencli": "1.0.0",
+  "info": {
+    "title": "sample-api",
+    "version": "1.2.0",
+    "description": "A tiny sample API for testing openapi2opencli.",
+    "contact": {
+      "name": "API Support",
+      "url": "https://example.com/support",
+      "email": "support@example.com"
+    },
+    "license": {
+      "name": "MIT",
+      "url": "https://opensource.org/licenses/MIT"
+    }
+  },
+  "x-openapi": {
+    "servers": [
+      "https://api.example.com/v1"
+    ],
+    "security": [
+      {
+        "type": "http",
+        "kind": "bearer",
+        "envVar": "SAMPLE_API_API_KEY",
+        "scheme": "bearer",
+        "bearerFormat": "JWT"
+      }
+    ]
+  },
+  "commands": [
+    {
+      "name": "models",
+      "commands": [
+        {
+          "name": "list",
+          "description": "Lists the currently available models.",
+          "x-openapi": {
+            "method": "get",
+            "path": "/models",
+            "operationId": "listModels"
+          }
+        },
+        {
+          "name": "retrieve",
+          "aliases": [
+            "get"
+          ],
+          "description": "Retrieves a model instance.",
+          "arguments": [
+            {
+              "name": "model",
+              "required": true,
+              "description": "The ID of the model to use for this request."
+            }
+          ],
+          "x-openapi": {
+            "method": "get",
+            "path": "/models/{model}",
+            "operationId": "retrieveModel",
+            "params": [
+              {
+                "in": "path",
+                "name": "model",
+                "from": "argument:model",
+                "required": true
+              }
+            ]
+          }
+        }
+      ]
+    }
+  ]
+}

package/__fixtures__/2.crud/input.yaml

@@ -0,0 +1,113 @@
+openapi: 3.0.3
+info:
+  title: Widgets API
+  version: 2.0.0
+servers:
+  - url: https://api.widgets.test
+security:
+  - apiKey: []
+paths:
+  /widgets:
+    get:
+      operationId: listWidgets
+      summary: List all widgets.
+      parameters:
+        - name: limit
+          in: query
+          required: false
+          description: Maximum number of widgets to return.
+          schema:
+            type: integer
+        - name: status
+          in: query
+          description: Filter by status.
+          schema:
+            type: string
+            enum: [active, archived, draft]
+      responses:
+        "200":
+          description: OK
+    post:
+      operationId: createWidget
+      summary: Create a widget.
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required: [name]
+              properties:
+                name:
+                  type: string
+                  description: The widget name.
+                color:
+                  type: string
+                  enum: [red, green, blue]
+                tags:
+                  type: array
+                  items:
+                    type: string
+                enabled:
+                  type: boolean
+                config:
+                  type: object
+                  properties:
+                    weight:
+                      type: number
+      responses:
+        "201":
+          description: Created
+  /widgets/{widget_id}:
+    get:
+      operationId: retrieveWidget
+      summary: Retrieve a widget.
+      parameters:
+        - name: widget_id
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        "200":
+          description: OK
+    patch:
+      operationId: updateWidget
+      summary: Update a widget.
+      parameters:
+        - name: widget_id
+          in: path
+          required: true
+          schema:
+            type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                name:
+                  type: string
+                enabled:
+                  type: boolean
+      responses:
+        "200":
+          description: OK
+    delete:
+      operationId: deleteWidget
+      summary: Delete a widget.
+      parameters:
+        - name: widget_id
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        "204":
+          description: No Content
+components:
+  securitySchemes:
+    apiKey:
+      type: apiKey
+      in: header
+      name: X-Api-Key

package/__fixtures__/2.crud/output.json

@@ -0,0 +1,281 @@
+{
+  "opencli": "1.0.0",
+  "info": {
+    "title": "widgets-api",
+    "version": "2.0.0"
+  },
+  "x-openapi": {
+    "servers": [
+      "https://api.widgets.test"
+    ],
+    "security": [
+      {
+        "type": "apiKey",
+        "kind": "apiKey-header",
+        "envVar": "WIDGETS_API_API_KEY",
+        "in": "header",
+        "name": "X-Api-Key"
+      }
+    ]
+  },
+  "commands": [
+    {
+      "name": "widgets",
+      "commands": [
+        {
+          "name": "list",
+          "description": "List all widgets.",
+          "options": [
+            {
+              "name": "limit",
+              "description": "Maximum number of widgets to return.",
+              "group": "query",
+              "arguments": [
+                {
+                  "name": "integer"
+                }
+              ]
+            },
+            {
+              "name": "status",
+              "description": "Filter by status.",
+              "group": "query",
+              "arguments": [
+                {
+                  "name": "string",
+                  "acceptedValues": [
+                    "active",
+                    "archived",
+                    "draft"
+                  ]
+                }
+              ]
+            }
+          ],
+          "x-openapi": {
+            "method": "get",
+            "path": "/widgets",
+            "operationId": "listWidgets",
+            "params": [
+              {
+                "in": "query",
+                "name": "limit",
+                "from": "option:limit"
+              },
+              {
+                "in": "query",
+                "name": "status",
+                "from": "option:status"
+              }
+            ]
+          }
+        },
+        {
+          "name": "create",
+          "description": "Create a widget.",
+          "options": [
+            {
+              "name": "name",
+              "group": "body",
+              "required": true,
+              "description": "The widget name.",
+              "arguments": [
+                {
+                  "name": "string"
+                }
+              ]
+            },
+            {
+              "name": "color",
+              "group": "body",
+              "arguments": [
+                {
+                  "name": "string",
+                  "acceptedValues": [
+                    "red",
+                    "green",
+                    "blue"
+                  ]
+                }
+              ]
+            },
+            {
+              "name": "tags",
+              "group": "body",
+              "arguments": [
+                {
+                  "name": "string",
+                  "arity": {
+                    "minimum": 0
+                  }
+                }
+              ]
+            },
+            {
+              "name": "enabled",
+              "group": "body"
+            },
+            {
+              "name": "config",
+              "group": "body",
+              "arguments": [
+                {
+                  "name": "json"
+                }
+              ]
+            }
+          ],
+          "x-openapi": {
+            "method": "post",
+            "path": "/widgets",
+            "operationId": "createWidget",
+            "contentType": "application/json",
+            "body": {
+              "style": "flatten",
+              "contentType": "application/json",
+              "properties": [
+                {
+                  "name": "name",
+                  "from": "option:name",
+                  "jsonPath": "name",
+                  "encoding": "string",
+                  "required": true
+                },
+                {
+                  "name": "color",
+                  "from": "option:color",
+                  "jsonPath": "color",
+                  "encoding": "string"
+                },
+                {
+                  "name": "tags",
+                  "from": "option:tags",
+                  "jsonPath": "tags",
+                  "encoding": "array"
+                },
+                {
+                  "name": "enabled",
+                  "from": "option:enabled",
+                  "jsonPath": "enabled",
+                  "encoding": "boolean"
+                },
+                {
+                  "name": "config",
+                  "from": "option:config",
+                  "jsonPath": "config",
+                  "encoding": "json"
+                }
+              ]
+            }
+          }
+        },
+        {
+          "name": "retrieve",
+          "aliases": [
+            "get"
+          ],
+          "description": "Retrieve a widget.",
+          "arguments": [
+            {
+              "name": "widget-id",
+              "required": true
+            }
+          ],
+          "x-openapi": {
+            "method": "get",
+            "path": "/widgets/{widget_id}",
+            "operationId": "retrieveWidget",
+            "params": [
+              {
+                "in": "path",
+                "name": "widget_id",
+                "from": "argument:widget-id",
+                "required": true
+              }
+            ]
+          }
+        },
+        {
+          "name": "update",
+          "description": "Update a widget.",
+          "arguments": [
+            {
+              "name": "widget-id",
+              "required": true
+            }
+          ],
+          "options": [
+            {
+              "name": "name",
+              "group": "body",
+              "arguments": [
+                {
+                  "name": "string"
+                }
+              ]
+            },
+            {
+              "name": "enabled",
+              "group": "body"
+            }
+          ],
+          "x-openapi": {
+            "method": "patch",
+            "path": "/widgets/{widget_id}",
+            "operationId": "updateWidget",
+            "contentType": "application/json",
+            "params": [
+              {
+                "in": "path",
+                "name": "widget_id",
+                "from": "argument:widget-id",
+                "required": true
+              }
+            ],
+            "body": {
+              "style": "flatten",
+              "contentType": "application/json",
+              "properties": [
+                {
+                  "name": "name",
+                  "from": "option:name",
+                  "jsonPath": "name",
+                  "encoding": "string"
+                },
+                {
+                  "name": "enabled",
+                  "from": "option:enabled",
+                  "jsonPath": "enabled",
+                  "encoding": "boolean"
+                }
+              ]
+            }
+          }
+        },
+        {
+          "name": "delete",
+          "description": "Delete a widget.",
+          "arguments": [
+            {
+              "name": "widget-id",
+              "required": true
+            }
+          ],
+          "x-openapi": {
+            "method": "delete",
+            "path": "/widgets/{widget_id}",
+            "operationId": "deleteWidget",
+            "params": [
+              {
+                "in": "path",
+                "name": "widget_id",
+                "from": "argument:widget-id",
+                "required": true
+              }
+            ]
+          }
+        }
+      ]
+    }
+  ]
+}

package/__fixtures__/3.nested/input.yaml

@@ -0,0 +1,84 @@
+openapi: 3.0.3
+info:
+  title: Stores API
+  version: 1.0.0
+servers:
+  - url: https://api.stores.test/v2
+paths:
+  /stores/{store_id}/items:
+    get:
+      operationId: listStoreItems
+      summary: List items in a store.
+      parameters:
+        - name: store_id
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: limit
+          in: query
+          schema:
+            type: integer
+      responses:
+        "200":
+          description: OK
+    post:
+      operationId: createStoreItem
+      summary: Create an item in a store.
+      parameters:
+        - name: store_id
+          in: path
+          required: true
+          schema:
+            type: string
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required: [sku]
+              properties:
+                sku:
+                  type: string
+                quantity:
+                  type: integer
+      responses:
+        "201":
+          description: Created
+  /stores/{store_id}/items/{item_id}:
+    get:
+      operationId: retrieveStoreItem
+      summary: Retrieve a store item.
+      parameters:
+        - name: store_id
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: item_id
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        "200":
+          description: OK
+  /stores/{store_id}/items/{item_id}/archive:
+    post:
+      operationId: archiveStoreItem
+      summary: Archive a store item.
+      parameters:
+        - name: store_id
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: item_id
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        "200":
+          description: OK