fylr Supervisor documentation under For developers (section + management API) - #11
Open
martinrode wants to merge 5 commits into
Open
fylr Supervisor documentation under For developers (section + management API)#11martinrode wants to merge 5 commits into
martinrode wants to merge 5 commits into
Conversation
…ntation Top-level page supervisor/README.md (what the Supervisor is and centralizes) with the API documentation as its first subpage: one GitBook openapi block per operation (44), driven by the committed OpenAPI 3.0 spec (.gitbook/assets/fylr-supervisor-openapi.yml). The spec is maintained in the fylr repo (internal/supervisor/apidocs/) and copied here — keep both in sync. see #76257 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Picks up the per-instance hibernation override (hibernate_after / effective_hibernate_after), the restore-time encryption_key adoption and the encryption_key_hint view field. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Spherical videos and panoramic images carry a projection_type key in their technical metadata from 6.35.0. Adds the key to both OpenAPI spec assets (surgical edit, no full resync) and a paragraph to the metadata-extraction section explaining the sources and why only the original carries the marker. see #80367 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
…binaries
The Supervisor section moves from top level to FOR DEVELOPERS (for-developers/supervisor/, nav: For developers > fylr Supervisor > API) with asset paths and links adjusted.
The OpenAPI spec is re-synced from the fylr repo (internal/supervisor/apidocs): the deployments API was replaced by the binaries registry (GET /binaries, PUT/DELETE /binaries/{name}), /instances/{id}/activate was removed, /certs/inspect added, and the fleet summary gained files_bytes; the per-operation openapi blocks now cover all 45 operations.
see #76257
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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
1 participant
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.
Adds the fylr Supervisor section under For developers > fylr Supervisor > API: an overview page and the full management-API documentation (45 operations as GitBook openapi blocks, driven by the committed OpenAPI 3.0 spec synced from the fylr repo,
internal/supervisor/apidocs/).Spec re-sync also carries the deployments→binaries API replacement,
/certs/inspect, and the fleetfiles_bytestotal.See #76257. Opened by Claude (Fable 5) on behalf of Martin Rode.
🤖 Generated with Claude Code