Skip to content

docs: add Harbor Library API reference sample [PANL-015] - #10

Merged
darthrootbeer merged 2 commits into
mainfrom
docs/harbor-library-api
Oct 27, 2026
Merged

darthrootbeer merged 2 commits into
mainfrom
docs/harbor-library-api

Conversation

@darthrootbeer

Copy link
Copy Markdown
Owner

Context

The review panel found that the API sample in this repo (a republished copy of an older help center page) had no code and no errors section, and its endpoint could not be checked. This replaces it, in the table, with a new sample about a made-up API, where every example runs. Ticket: PANL-015.

Changes

  • New folder api-reference/harbor-library/: an OpenAPI file, nine documentation pages, and a small sandbox server with no dependencies.
  • tests/run_examples.py runs all 28 curl examples against the sandbox and fails if a response differs, if a status is not in the OpenAPI file, or if an error link lands on no heading. It runs in the existing examples GitHub Action.
  • README: one new row in the API reference table. The old MURAL pages are untouched and still linked.
  • Reviewed over two rounds by four reader personas (Integration Engineer, Junior Developer, Support Translator, Technical Writer). Round 2 passed the stop rule.

Review notes: the README wording about how it was made ("designed and directed, drafted with Claude") is Ben's call to approve before merge. Not merged yet for that reason.

  • Docs updated

darthrootbeer and others added 2 commits October 26, 2026 21:08
@darthrootbeer
darthrootbeer merged commit 095922f into main Oct 27, 2026
2 checks passed
@darthrootbeer
darthrootbeer deleted the docs/harbor-library-api branch October 27, 2026 01:21
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