From a931924e9c623cc9d937f6fb2058635667018a52 Mon Sep 17 00:00:00 2001 From: Juergen Klaassen Date: Fri, 22 May 2026 08:14:55 -0600 Subject: [PATCH] docs(readme): note JumpCloud OpenAPI operationId standardization MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit JumpCloud is rolling out standardized OpenAPI operationIds with a legacy→new mapping artifact. The CLI calls REST endpoints by URL + HTTP method, so it is unaffected; this note exists so downstream integrators that *do* key off operationIds know the mapping artifact is coming and that legacy IDs continue to work until cutover. Holding open as a draft until the public-docs cutover firms up — at that point we can link the public mapping URL directly. Co-Authored-By: Claude Opus 4.7 (1M context) --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 484026b..d3b39e7 100644 --- a/README.md +++ b/README.md @@ -953,6 +953,14 @@ internal/ --- +## A note on JumpCloud's OpenAPI `operationId`s + +`jc` calls the JumpCloud REST API by **URL path + HTTP method** (e.g. `GET /api/v2/systemgroups`). It does not depend on OpenAPI `operationId` values, so the standardized-`operationId` work currently rolling out for JumpCloud's API docs does not change anything in the CLI. + +If you build your own tooling on top of the JumpCloud APIs that *does* key off `operationId` (Postman codegen, custom SDKs, workflow DSLs that mirror docs specs), JumpCloud is publishing a machine-readable `operation-id-mapping.yaml` sidecar alongside each aggregate spec when the new layout becomes the default on the public docs. The mapping is `legacy_operation_id → standardized_operation_id` and is intended to make the cutover mechanical. The legacy IDs continue to work until cutover. + +--- + ## License This project is a Community Software Tool initially developed by JumpCloud. It is offered as an open source project under the MIT License "as is" without warranty of any kind. JumpCloud does not commit to maintaining, updating, or providing support for this project. Please use the [GitHub issue tracker](https://github.com/TheJumpCloud/jc-cli/issues) for any issues.