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

package/CHANGELOG.md

@@ -0,0 +1,8 @@
+# @xyd-js/openapi2opencli
+
+## 0.0.0-canary-4287eee-20260630010340
+
+### Patch Changes
+
+- Updated dependencies
+  - @xyd-js/openapi@0.0.0-canary-4287eee-20260630010340

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) LiveSession Sp.z.o.o
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE. 

package/README.md

@@ -0,0 +1,45 @@
+# @xyd-js/openapi2opencli
+
+Converts an **OpenAPI 3.x** document into an **OpenCLI** document
+([`@xyd-js/opencli`](../xyd-opencli)), embedding the `x-openapi` request binding so the
+downstream `opencli2*` code generators (Go first) can build real API requests.
+
+```ts
+import { openapi2opencli, openapi2opencliFromSource } from '@xyd-js/openapi2opencli';
+
+// from an already-dereferenced OpenAPIV3.Document
+const opencli = openapi2opencli(doc, { cliName: 'openai' });
+
+// or read + dereference a file/URL (via @xyd-js/openapi)
+const opencli = await openapi2opencliFromSource('./openapi.yaml', { cliName: 'openai' });
+```
+
+## Mapping (default `grouping: "path"`)
+
+| OpenAPI | OpenCLI |
+|---|---|
+| static path segment | nested resource command (kebab-case) |
+| `{param}` segment | positional `Argument` (required, path order) |
+| method + path shape | leaf action: GET-collection→`list`, GET-item→`retrieve` (+`get`), POST-collection→`create`, PUT/PATCH-item→`update`, DELETE-item→`delete` |
+| trailing static verb after a param (e.g. `/{id}/cancel`) | custom action (`cancel`); see `customActionVerbs` |
+| query param | `Option` (`group: "query"`) |
+| header / cookie param | `Option` (opt-in via `includeHeaders`, hidden, auth headers skipped) |
+| request body (object) | top-level props → `Option[]` (hybrid: scalars/scalar-arrays flatten, enums→`acceptedValues`, nested/`oneOf`/`anyOf`→JSON-string flag); multipart binary → file flag |
+
+Every leaf command carries `x-openapi` `{ method, path, contentType, params[], body }` and the
+root carries `x-openapi` `{ servers, security }`. See `OpenApi2OpenCliOptions` for `cliName`,
+`version`, `grouping`, `bodyStrategy`, `includeMethods`, `includeHeaders`, `flagCase`,
+`verbMap`, `customActionVerbs`, `includePaths`, `authEnvVar`.
+
+> Not yet derived from a pure OpenAPI spec (they live in vendor codegen config, e.g. Stainless):
+> the OpenAI CLI's `beta` prefix and `admin:` `:`-namespacing. These are handled later via
+> overrides / `x-cli` hooks (see the project plan, Milestone 3).
+
+## Tests
+
+Data-driven golden fixtures under `__fixtures__/<n>.<name>/` (`input.yaml` → `output.json`):
+
+```bash
+pnpm --filter @xyd-js/openapi2opencli test          # assert against committed goldens
+REGEN=1 pnpm --filter @xyd-js/openapi2opencli test   # regenerate output.json, then review the diff
+```

package/__fixtures__/-2.complex.openai/admin__organization__admin-api-keys__create/expected.json

@@ -0,0 +1,14 @@
+{
+  "commandPath": [
+    "admin",
+    "organization",
+    "admin-api-keys",
+    "create"
+  ],
+  "httpMethod": "post",
+  "docFlags": [
+    "name"
+  ],
+  "docCommand": "openai admin:organization:admin-api-keys create --admin-api-key 'My Admin API Key' --name 'New Admin Key'",
+  "docUrl": "https://developers.openai.com/api/reference/cli/resources/admin/subresources/organization/subresources/admin_api_keys/methods/create"
+}

package/__fixtures__/-2.complex.openai/admin__organization__admin-api-keys__create/input.json

@@ -0,0 +1,15 @@
+{
+  "httpMethod": "post",
+  "path": "/organization/admin_api_keys",
+  "operationId": "admin-api-keys-create",
+  "title": "Create admin API key",
+  "summary": "Create an organization admin API key",
+  "parameters": [],
+  "requestBody": {
+    "contentType": "application/json",
+    "required": true,
+    "properties": [
+      "name"
+    ]
+  }
+}

package/__fixtures__/-2.complex.openai/admin__organization__admin-api-keys__delete/expected.json

@@ -0,0 +1,14 @@
+{
+  "commandPath": [
+    "admin",
+    "organization",
+    "admin-api-keys",
+    "delete"
+  ],
+  "httpMethod": "delete",
+  "docFlags": [
+    "key-id"
+  ],
+  "docCommand": "openai admin:organization:admin-api-keys delete --admin-api-key 'My Admin API Key' --key-id key_id",
+  "docUrl": "https://developers.openai.com/api/reference/cli/resources/admin/subresources/organization/subresources/admin_api_keys/methods/delete"
+}

package/__fixtures__/-2.complex.openai/admin__organization__admin-api-keys__delete/input.json

@@ -0,0 +1,14 @@
+{
+  "httpMethod": "delete",
+  "path": "/organization/admin_api_keys/{key_id}",
+  "operationId": "admin-api-keys-delete",
+  "title": "Delete admin API key",
+  "summary": "Delete an organization admin API key",
+  "parameters": [
+    {
+      "name": "key_id",
+      "in": "path",
+      "required": true
+    }
+  ]
+}

package/__fixtures__/-2.complex.openai/admin__organization__admin-api-keys__list/expected.json

@@ -0,0 +1,12 @@
+{
+  "commandPath": [
+    "admin",
+    "organization",
+    "admin-api-keys",
+    "list"
+  ],
+  "httpMethod": "get",
+  "docFlags": [],
+  "docCommand": "openai admin:organization:admin-api-keys list --admin-api-key 'My Admin API Key'",
+  "docUrl": "https://developers.openai.com/api/reference/cli/resources/admin/subresources/organization/subresources/admin_api_keys/methods/list"
+}

package/__fixtures__/-2.complex.openai/admin__organization__admin-api-keys__list/input.json

@@ -0,0 +1,24 @@
+{
+  "httpMethod": "get",
+  "path": "/organization/admin_api_keys",
+  "operationId": "admin-api-keys-list",
+  "title": "List all organization and project API keys.",
+  "summary": "List organization API keys",
+  "parameters": [
+    {
+      "name": "after",
+      "in": "query",
+      "required": false
+    },
+    {
+      "name": "order",
+      "in": "query",
+      "required": false
+    },
+    {
+      "name": "limit",
+      "in": "query",
+      "required": false
+    }
+  ]
+}

package/__fixtures__/-2.complex.openai/admin__organization__admin-api-keys__retrieve/expected.json

@@ -0,0 +1,14 @@
+{
+  "commandPath": [
+    "admin",
+    "organization",
+    "admin-api-keys",
+    "retrieve"
+  ],
+  "httpMethod": "get",
+  "docFlags": [
+    "key-id"
+  ],
+  "docCommand": "openai admin:organization:admin-api-keys retrieve --admin-api-key 'My Admin API Key' --key-id key_id",
+  "docUrl": "https://developers.openai.com/api/reference/cli/resources/admin/subresources/organization/subresources/admin_api_keys/methods/retrieve"
+}

package/__fixtures__/-2.complex.openai/admin__organization__admin-api-keys__retrieve/input.json

@@ -0,0 +1,24 @@
+{
+  "httpMethod": "get",
+  "path": "/organization/admin_api_keys",
+  "operationId": "admin-api-keys-list",
+  "title": "List all organization and project API keys.",
+  "summary": "List organization API keys",
+  "parameters": [
+    {
+      "name": "after",
+      "in": "query",
+      "required": false
+    },
+    {
+      "name": "order",
+      "in": "query",
+      "required": false
+    },
+    {
+      "name": "limit",
+      "in": "query",
+      "required": false
+    }
+  ]
+}

package/__fixtures__/-2.complex.openai/admin__organization__audit-logs__list/expected.json

@@ -0,0 +1,12 @@
+{
+  "commandPath": [
+    "admin",
+    "organization",
+    "audit-logs",
+    "list"
+  ],
+  "httpMethod": "get",
+  "docFlags": [],
+  "docCommand": "openai admin:organization:audit-logs list --admin-api-key 'My Admin API Key'",
+  "docUrl": "https://developers.openai.com/api/reference/cli/resources/admin/subresources/organization/subresources/audit_logs/methods/list"
+}

package/__fixtures__/-2.complex.openai/admin__organization__audit-logs__list/input.json

@@ -0,0 +1,54 @@
+{
+  "httpMethod": "get",
+  "path": "/organization/audit_logs",
+  "operationId": "list-audit-logs",
+  "title": "List audit logs",
+  "summary": "List user actions and configuration changes within this organization.",
+  "parameters": [
+    {
+      "name": "effective_at",
+      "in": "query",
+      "required": false
+    },
+    {
+      "name": "project_ids[]",
+      "in": "query",
+      "required": false
+    },
+    {
+      "name": "event_types[]",
+      "in": "query",
+      "required": false
+    },
+    {
+      "name": "actor_ids[]",
+      "in": "query",
+      "required": false
+    },
+    {
+      "name": "actor_emails[]",
+      "in": "query",
+      "required": false
+    },
+    {
+      "name": "resource_ids[]",
+      "in": "query",
+      "required": false
+    },
+    {
+      "name": "limit",
+      "in": "query",
+      "required": false
+    },
+    {
+      "name": "after",
+      "in": "query",
+      "required": false
+    },
+    {
+      "name": "before",
+      "in": "query",
+      "required": false
+    }
+  ]
+}

package/__fixtures__/-2.complex.openai/admin__organization__certificates__activate/expected.json

@@ -0,0 +1,14 @@
+{
+  "commandPath": [
+    "admin",
+    "organization",
+    "certificates",
+    "activate"
+  ],
+  "httpMethod": "post",
+  "docFlags": [
+    "certificate-id"
+  ],
+  "docCommand": "openai admin:organization:certificates activate --admin-api-key 'My Admin API Key' --certificate-id cert_abc",
+  "docUrl": "https://developers.openai.com/api/reference/cli/resources/admin/subresources/organization/subresources/certificates/methods/activate"
+}

package/__fixtures__/-2.complex.openai/admin__organization__certificates__activate/input.json

@@ -0,0 +1,16 @@
+{
+  "httpMethod": "post",
+  "path": "/organization/certificates",
+  "operationId": "uploadCertificate",
+  "title": "Upload certificate",
+  "summary": "Upload a certificate to the organization. This does **not** automatically activate the certificate.\n\nOrganizations can upload up to 50 certificates.\n",
+  "parameters": [],
+  "requestBody": {
+    "contentType": "application/json",
+    "required": true,
+    "properties": [
+      "name",
+      "certificate"
+    ]
+  }
+}

package/__fixtures__/-2.complex.openai/admin__organization__certificates__create/expected.json

@@ -0,0 +1,14 @@
+{
+  "commandPath": [
+    "admin",
+    "organization",
+    "certificates",
+    "create"
+  ],
+  "httpMethod": "post",
+  "docFlags": [
+    "certificate"
+  ],
+  "docCommand": "openai admin:organization:certificates create --admin-api-key 'My Admin API Key' --certificate certificate",
+  "docUrl": "https://developers.openai.com/api/reference/cli/resources/admin/subresources/organization/subresources/certificates/methods/create"
+}

package/__fixtures__/-2.complex.openai/admin__organization__certificates__create/input.json

@@ -0,0 +1,16 @@
+{
+  "httpMethod": "post",
+  "path": "/organization/certificates",
+  "operationId": "uploadCertificate",
+  "title": "Upload certificate",
+  "summary": "Upload a certificate to the organization. This does **not** automatically activate the certificate.\n\nOrganizations can upload up to 50 certificates.\n",
+  "parameters": [],
+  "requestBody": {
+    "contentType": "application/json",
+    "required": true,
+    "properties": [
+      "name",
+      "certificate"
+    ]
+  }
+}

package/__fixtures__/-2.complex.openai/admin__organization__certificates__deactivate/expected.json

@@ -0,0 +1,14 @@
+{
+  "commandPath": [
+    "admin",
+    "organization",
+    "certificates",
+    "deactivate"
+  ],
+  "httpMethod": "post",
+  "docFlags": [
+    "certificate-id"
+  ],
+  "docCommand": "openai admin:organization:certificates deactivate --admin-api-key 'My Admin API Key' --certificate-id cert_abc",
+  "docUrl": "https://developers.openai.com/api/reference/cli/resources/admin/subresources/organization/subresources/certificates/methods/deactivate"
+}

package/__fixtures__/-2.complex.openai/admin__organization__certificates__deactivate/input.json

@@ -0,0 +1,16 @@
+{
+  "httpMethod": "post",
+  "path": "/organization/certificates",
+  "operationId": "uploadCertificate",
+  "title": "Upload certificate",
+  "summary": "Upload a certificate to the organization. This does **not** automatically activate the certificate.\n\nOrganizations can upload up to 50 certificates.\n",
+  "parameters": [],
+  "requestBody": {
+    "contentType": "application/json",
+    "required": true,
+    "properties": [
+      "name",
+      "certificate"
+    ]
+  }
+}

package/__fixtures__/-2.complex.openai/admin__organization__certificates__delete/expected.json

@@ -0,0 +1,14 @@
+{
+  "commandPath": [
+    "admin",
+    "organization",
+    "certificates",
+    "delete"
+  ],
+  "httpMethod": "delete",
+  "docFlags": [
+    "certificate-id"
+  ],
+  "docCommand": "openai admin:organization:certificates delete --admin-api-key 'My Admin API Key' --certificate-id certificate_id",
+  "docUrl": "https://developers.openai.com/api/reference/cli/resources/admin/subresources/organization/subresources/certificates/methods/delete"
+}

package/__fixtures__/-2.complex.openai/admin__organization__certificates__delete/input.json

@@ -0,0 +1,14 @@
+{
+  "httpMethod": "delete",
+  "path": "/organization/certificates/{certificate_id}",
+  "operationId": "deleteCertificate",
+  "title": "Delete certificate",
+  "summary": "Delete a certificate from the organization.\n\nThe certificate must be inactive for the organization and all projects.\n",
+  "parameters": [
+    {
+      "name": "certificate_id",
+      "in": "path",
+      "required": true
+    }
+  ]
+}

package/__fixtures__/-2.complex.openai/admin__organization__certificates__list/expected.json

@@ -0,0 +1,12 @@
+{
+  "commandPath": [
+    "admin",
+    "organization",
+    "certificates",
+    "list"
+  ],
+  "httpMethod": "get",
+  "docFlags": [],
+  "docCommand": "openai admin:organization:certificates list --admin-api-key 'My Admin API Key'",
+  "docUrl": "https://developers.openai.com/api/reference/cli/resources/admin/subresources/organization/subresources/certificates/methods/list"
+}

package/__fixtures__/-2.complex.openai/admin__organization__certificates__list/input.json

@@ -0,0 +1,24 @@
+{
+  "httpMethod": "get",
+  "path": "/organization/certificates",
+  "operationId": "listOrganizationCertificates",
+  "title": "List organization certificates",
+  "summary": "List uploaded certificates for this organization.",
+  "parameters": [
+    {
+      "name": "limit",
+      "in": "query",
+      "required": false
+    },
+    {
+      "name": "after",
+      "in": "query",
+      "required": false
+    },
+    {
+      "name": "order",
+      "in": "query",
+      "required": false
+    }
+  ]
+}

package/__fixtures__/-2.complex.openai/admin__organization__certificates__retrieve/expected.json

@@ -0,0 +1,14 @@
+{
+  "commandPath": [
+    "admin",
+    "organization",
+    "certificates",
+    "retrieve"
+  ],
+  "httpMethod": "get",
+  "docFlags": [
+    "certificate-id"
+  ],
+  "docCommand": "openai admin:organization:certificates retrieve --admin-api-key 'My Admin API Key' --certificate-id certificate_id",
+  "docUrl": "https://developers.openai.com/api/reference/cli/resources/admin/subresources/organization/subresources/certificates/methods/retrieve"
+}

package/__fixtures__/-2.complex.openai/admin__organization__certificates__retrieve/input.json

@@ -0,0 +1,24 @@
+{
+  "httpMethod": "get",
+  "path": "/organization/certificates",
+  "operationId": "listOrganizationCertificates",
+  "title": "List organization certificates",
+  "summary": "List uploaded certificates for this organization.",
+  "parameters": [
+    {
+      "name": "limit",
+      "in": "query",
+      "required": false
+    },
+    {
+      "name": "after",
+      "in": "query",
+      "required": false
+    },
+    {
+      "name": "order",
+      "in": "query",
+      "required": false
+    }
+  ]
+}

package/__fixtures__/-2.complex.openai/admin__organization__certificates__update/expected.json

@@ -0,0 +1,14 @@
+{
+  "commandPath": [
+    "admin",
+    "organization",
+    "certificates",
+    "update"
+  ],
+  "httpMethod": "post",
+  "docFlags": [
+    "certificate-id"
+  ],
+  "docCommand": "openai admin:organization:certificates update --admin-api-key 'My Admin API Key' --certificate-id certificate_id",
+  "docUrl": "https://developers.openai.com/api/reference/cli/resources/admin/subresources/organization/subresources/certificates/methods/update"
+}

package/__fixtures__/-2.complex.openai/admin__organization__certificates__update/input.json

@@ -0,0 +1,16 @@
+{
+  "httpMethod": "post",
+  "path": "/organization/certificates",
+  "operationId": "uploadCertificate",
+  "title": "Upload certificate",
+  "summary": "Upload a certificate to the organization. This does **not** automatically activate the certificate.\n\nOrganizations can upload up to 50 certificates.\n",
+  "parameters": [],
+  "requestBody": {
+    "contentType": "application/json",
+    "required": true,
+    "properties": [
+      "name",
+      "certificate"
+    ]
+  }
+}

package/__fixtures__/-2.complex.openai/admin__organization__data-retention__retrieve/expected.json

@@ -0,0 +1,12 @@
+{
+  "commandPath": [
+    "admin",
+    "organization",
+    "data-retention",
+    "retrieve"
+  ],
+  "httpMethod": "get",
+  "docFlags": [],
+  "docCommand": "openai admin:organization:data-retention retrieve --admin-api-key 'My Admin API Key'",
+  "docUrl": "https://developers.openai.com/api/reference/cli/resources/admin/subresources/organization/subresources/data_retention/methods/retrieve"
+}

package/__fixtures__/-2.complex.openai/admin__organization__data-retention__retrieve/input.json

@@ -0,0 +1,3 @@
+{
+  "note": "No matching operation in the vendored openai-openapi (newer/renamed resource)."
+}

package/__fixtures__/-2.complex.openai/admin__organization__data-retention__update/expected.json

@@ -0,0 +1,14 @@
+{
+  "commandPath": [
+    "admin",
+    "organization",
+    "data-retention",
+    "update"
+  ],
+  "httpMethod": "post",
+  "docFlags": [
+    "retention-type"
+  ],
+  "docCommand": "openai admin:organization:data-retention update --admin-api-key 'My Admin API Key' --retention-type zero_data_retention",
+  "docUrl": "https://developers.openai.com/api/reference/cli/resources/admin/subresources/organization/subresources/data_retention/methods/update"
+}

package/__fixtures__/-2.complex.openai/admin__organization__data-retention__update/input.json

@@ -0,0 +1,3 @@
+{
+  "note": "No matching operation in the vendored openai-openapi (newer/renamed resource)."
+}

package/__fixtures__/-2.complex.openai/admin__organization__groups__create/expected.json

@@ -0,0 +1,14 @@
+{
+  "commandPath": [
+    "admin",
+    "organization",
+    "groups",
+    "create"
+  ],
+  "httpMethod": "post",
+  "docFlags": [
+    "name"
+  ],
+  "docCommand": "openai admin:organization:groups create --admin-api-key 'My Admin API Key' --name x",
+  "docUrl": "https://developers.openai.com/api/reference/cli/resources/admin/subresources/organization/subresources/groups/methods/create"
+}

package/__fixtures__/-2.complex.openai/admin__organization__groups__create/input.json

@@ -0,0 +1,15 @@
+{
+  "httpMethod": "post",
+  "path": "/organization/groups",
+  "operationId": "create-group",
+  "title": "Create group",
+  "summary": "Creates a new group in the organization.",
+  "parameters": [],
+  "requestBody": {
+    "contentType": "application/json",
+    "required": true,
+    "properties": [
+      "name"
+    ]
+  }
+}

package/__fixtures__/-2.complex.openai/admin__organization__groups__delete/expected.json

@@ -0,0 +1,14 @@
+{
+  "commandPath": [
+    "admin",
+    "organization",
+    "groups",
+    "delete"
+  ],
+  "httpMethod": "delete",
+  "docFlags": [
+    "group-id"
+  ],
+  "docCommand": "openai admin:organization:groups delete --admin-api-key 'My Admin API Key' --group-id group_id",
+  "docUrl": "https://developers.openai.com/api/reference/cli/resources/admin/subresources/organization/subresources/groups/methods/delete"
+}

package/__fixtures__/-2.complex.openai/admin__organization__groups__delete/input.json

@@ -0,0 +1,14 @@
+{
+  "httpMethod": "delete",
+  "path": "/organization/groups/{group_id}",
+  "operationId": "delete-group",
+  "title": "Delete group",
+  "summary": "Deletes a group from the organization.",
+  "parameters": [
+    {
+      "name": "group_id",
+      "in": "path",
+      "required": true
+    }
+  ]
+}

package/__fixtures__/-2.complex.openai/admin__organization__groups__list/expected.json

@@ -0,0 +1,12 @@
+{
+  "commandPath": [
+    "admin",
+    "organization",
+    "groups",
+    "list"
+  ],
+  "httpMethod": "get",
+  "docFlags": [],
+  "docCommand": "openai admin:organization:groups list --admin-api-key 'My Admin API Key'",
+  "docUrl": "https://developers.openai.com/api/reference/cli/resources/admin/subresources/organization/subresources/groups/methods/list"
+}