Repository navigation
feat(launchpad): build governance-rest-api-reference - #1224
Open
rubenvdlinde wants to merge 2 commits into
Open
rubenvdlinde wants to merge 2 commits into
rubenvdlinde wants to merge 2 commits into
Conversation
Task 5: the REST API page in the docs, with Basic authentication by app password and the OCS-APIRequest header, and what public and internal stability mean. Task 4 (route half of the drift check): composer lint:openapi, in check:strict, fails on an API route without an operation, an operation without x-launchpad-stability, or an operation without a route. It found GET and PUT /analytics/me unmarked; both are now internal, which also turns OpenApiStabilityTest green again. Assisted-by: ClaudeCode:claude-opus-5-5
rubenvdlinde
requested review from
Rem-Dam,
SudoThijn,
WilcoLouwerse,
bbrands02,
remko48 and
rjzondervan
as code owners
November 14, 2026 18:04
Assisted-by: ClaudeCode:claude-opus-5-5
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.
Continues the build of
openspec/changes/governance-rest-api-reference(the stability markers and their pinning test landed in #1202).Tasks done
docs/features/rest-api.md: where the reference lives (openapi.json, also served at/api/v1/openapi.json), the base URL, Basic authentication with a Nextcloud app password plusOCS-APIRequest: true, whatpublicandinternalmean, and which operations are public.composer lint:openapi(scripts/lint-openapi.php, logic inscripts/OpenApiRouteCoverage.php) added tocheck:strict. It fails on a versioned API route with no operation, an operation withoutx-launchpad-stability, or an operation without a route. Path parameters are compared by position; the catch-all API fallback is skipped.GET/PUT /analytics/mewithout a stability marker (the cause of theOpenApiStabilityTestfailure on development). Both are markedinternal; the pinned public set is unchanged.Tasks left, and why
nextcloud/openapi-extractorand record the generator choice (D1). Adding the dev dependency and judging its output against the existing 184-operation document needs a person.openapi.jsonboth depend on that choice.Tests
tests/Unit/Scripts/OpenApiRouteCoverageTest.php(6): matching routes pass whatever the parameter names; a fixture with an undocumented route fails and names it; a missing or unknown stability fails; an operation without a route fails; the fallback route is skipped; the committed document covers the app's routes. Disabling the undocumented-route check turns it red.OpenApiStabilityTest,/analytics/me); this branch 4142 tests, 0 failures.composer lint:openapi: 184 operations, every API route documented. phpstan clean on the new class.docusaurus buildsucceeds and buildsdocs/features/rest-api. Its only warnings come from the docs preset and are not new.Generated by Claude Code