feat: expose Protocol v1 ingestion over plain JSON and OCS - #23
Merged
Merged
Conversation
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.
Summary
Expose Usage Statistics Protocol v1 report ingestion through two equivalent Nextcloud routes backed by the same application service:
Both routes accept the same Protocol v1 request fields and persist reports through the same validation and storage path.
Why
The generic PHP client expects the Protocol v1 response body directly, for example
{"status":"accepted"}. A report endpoint implemented only as anOCSControllerwraps that result underocs.data, coupling the generic protocol client to a Nextcloud-specific response envelope.The plain route keeps Protocol v1 framework-agnostic. The OCS route remains available for the Nextcloud ecosystem without changing the generic client contract.
Implementation
FrontpageRouteApiRouteOpenAPI
The server now ships the generated OpenAPI contracts and TypeScript types in the repository, following the same drift-check approach used by LibreSign.
The generated default specification contains both ingestion routes:
/index.php/apps/usage_statistics_server/api/{apiVersion}/reports/ocs/v2.php/apps/usage_statistics_server/api/{apiVersion}/reportsAdministrative OCS routes remain in
openapi-administration.json, whileopenapi-full.jsoncontains the complete API.Compatibility
LibreCodeCoop/usage_statistics_client#4 runs the real generic client against this server branch and verifies submission, persistence and aggregation end to end. The client itself remains unaware of OCS.