Repository navigation
docs: add Harbor Library API reference sample [PANL-015] - #10
Merged
Merged
Conversation
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Bihc4e3Pg6Ago5K1xfMbe5
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Bihc4e3Pg6Ago5K1xfMbe5
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
api-reference/harbor-library/: an OpenAPI file, nine documentation pages, and a small sandbox server with no dependencies.tests/run_examples.pyruns all 28curlexamples 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 existingexamplesGitHub Action.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.