docs: add the service-player api snapshot - #17
Closed
hbrombeer wants to merge 1 commit into
Closed
Conversation
service-player was missing from the reference because it spoke only gRPC and had no OpenAPI document to publish. groundsgg/service-player#99 gives it a REST API under /v1/players; this is the snapshot that build produces. Written with the same action the release bot uses, rather than by hand, so the bot's next run against a tagged release is a plain content update.
Member
Author
|
Superseded by #19: with OPENAPI_PUBLISHER_PRIVATE_KEY in place, the release of service-player v0.9.0 published the snapshot itself — same content, stamped with the tag instead of |
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 Player API to the reference — network-wide presence: who is online, on which proxy and backend server, under what name, and in which language.
service-playerwas the only data service missing here, because it spoke only gRPC and so had no OpenAPI document to publish. groundsgg/service-player#99 gives it a REST API under/v1/players; this is the snapshot that build produces — 12 operations, 15 schemas.Generated with
groundsgg/.github/actions/update-openapi-snapshot, the same action the release bot runs, rather than written by hand. The registry entry and file layout are therefore what the bot would produce, and its next run against a tagged release is a plain content update rather than a conflict.Draft until two things happen
OPENAPI_PUBLISHER_PRIVATE_KEYsecret is added togroundsgg/service-player. It is missing today, so the release workflow cannot open this PR itself — which is why it is here by hand. (OPENAPI_PUBLISHER_APP_IDis already set.) That missing secret is the same failure that silently droppedservice-mapsv1.3.0 from the reference.The snapshot's
info.versionreadsdevbecause it comes from an unreleased build, matching howservice-permissionsis published today. The release run will replace it with the tag.