Add OpenAPI 3.0 specification for hoist-core HTTP API#512
Draft
Add OpenAPI 3.0 specification for hoist-core HTTP API#512
Conversation
Comprehensive spec covering all 122 public endpoints across 26 controllers: - Core client endpoints (auth, config, prefs, JSON blobs, views, tracking, env) - Admin REST CRUD (AppConfig, Preference, UserPreference, JsonBlob, Monitor, LogLevel) - Admin non-REST (roles, users, alert banners, track logs, diff, JSON search) - Admin cluster (services, logs, memory, connection pool, WebSocket, env) Includes domain model schemas, reusable components, and role documentation. Also adds: - validate-openapi.py: cross-references spec paths against controller source - validate-openapi.sh: shell wrapper for validation - openapi/README.md: usage, maintenance, and code generation instructions https://claude.ai/code/session_01D4r2yEC4SheNSLAKbEQWat
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
2 participants
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
Adds a comprehensive OpenAPI 3.0.3 specification documenting the full public HTTP API surface of hoist-core, along with validation tooling and maintenance documentation.
What's Included
openapi/openapi.yamlopenapi/validate-openapi.pyopenapi/validate-openapi.shopenapi/README.mdEndpoint Coverage
XhController)XhViewController)Keeping It Current
./openapi/validate-openapi.shto verify all controller actions are coverednpx @redocly/cli lint openapi/openapi.yamlTest plan
validate-openapi.pypasses with 99/99 endpoints matched, 0 missingnpx @redocly/cli lint openapi/openapi.yamlfor full OpenAPI 3.0 schema validationhttps://claude.ai/code/session_01D4r2yEC4SheNSLAKbEQWat