Skip to content

Add OneRoster REST API documentation#1

Closed
ottenhoff wants to merge 1 commit into
mainfrom
agent/add-rest-api-docs
Closed

Add OneRoster REST API documentation#1
ottenhoff wants to merge 1 commit into
mainfrom
agent/add-rest-api-docs

Conversation

@ottenhoff

Copy link
Copy Markdown
Member

What changed

  • add a workflow-first OneRoster 1.2 REST guide
  • generate an 81-operation catalog from the OpenAPI-derived registry
  • check generated documentation for drift during pnpm run check
  • include the documentation in the npm package

Why

Callers need a quick path from common integration tasks to the correct typed client method, raw HTTP endpoint, query controls, success status, and OAuth scopes. The generated catalog keeps that reference aligned with the operation registry without requiring network access during normal checks.

Validation

  • pnpm run check
  • 41 test files and 317 tests passed
  • pnpm run build
  • pnpm pack --dry-run

@ottenhoff
ottenhoff marked this pull request as ready for review July 15, 2026 23:52
@ottenhoff

Copy link
Copy Markdown
Member Author

Closing this draft because the requested changes were pushed directly to main.

@ottenhoff ottenhoff closed this Jul 15, 2026
@ottenhoff
ottenhoff deleted the agent/add-rest-api-docs branch July 15, 2026 23:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant