Skip to content

docs(readme): note JumpCloud OpenAPI operationId standardization #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
jklaassenjc wants to merge 1 commit into
base: main
Choose a base branch
from
+8 −0
Draft

docs(readme): note JumpCloud OpenAPI operationId standardization #33

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Loading