Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Player Tracking: REST SDK Reference #1570

Merged
merged 2 commits into from
May 19, 2020

Conversation

markmandel
Copy link
Member

What type of PR is this?

Uncomment only one /kind <> line, hit enter to put that in a new line, and remove leading whitespace from that line:

/kind breaking
/kind bug
/kind cleanup

/kind documentation

/kind feature
/kind hotfix

What this PR does / Why we need it:

Reference for player tracking API for the REST interface for the SDK.

Also regrouped as how we now have it in the Client SDK guide.

Which issue(s) this PR fixes:

Work on #1033

Special notes for your reviewer:

@markmandel markmandel added kind/feature New features for Agones kind/documentation Documentation for Agones labels May 18, 2020
@markmandel markmandel added this to the 1.6.0 milestone May 18, 2020
@agones-bot
Copy link
Collaborator

Build Succeeded 👏

Build Id: d2885726-5357-455c-974e-56cb27946060

The following development artifacts have been built, and will exist for the next 30 days:

A preview of the website (the last 30 builds are retained):

To install this version:

  • git fetch https://github.com/GoogleCloudPlatform/agones.git pull/1570/head:pr_1570 && git checkout pr_1570
  • helm install ./install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.6.0-8197691


#### Alpha: SetPlayerCapacity

Update the [`GameServer.Status.Players.Capacity`][playerstatus] value with a new capacity.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It might be worth clarifying that this capacity is not enforced as that is not a responsibility of Agones

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a good idea, I'm going to tackle this in #1569 , since it doesn't seem REST API specific.


With some matchmakers and game matching strategies, it can be important for game servers to mark themselves as `Allocated`.
For those scenarios, this SDK functionality exists.
Apply a Annotation with the prefix "agones.dev/sdk-" to the backing `GameServer` metadata
Copy link
Collaborator

@aLekSer aLekSer May 19, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Apply a Annotation with the prefix "agones.dev/sdk-" to the backing `GameServer` metadata
Apply an Annotation with the prefix "agones.dev/sdk-" to the backing `GameServer` metadata

or the Annotation not sure what suits better here.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done. PTAL!

Reference for player tracking API for the REST interface for the SDK.

Also regrouped as how we now have it in the Client SDK guide.

Work on googleforgames#1033
@markmandel markmandel force-pushed the docs/tracking-rest branch from 8197691 to 417f01e Compare May 19, 2020 16:52
@agones-bot
Copy link
Collaborator

Build Succeeded 👏

Build Id: 1724e88e-1364-4af1-b355-b54964ef39df

The following development artifacts have been built, and will exist for the next 30 days:

A preview of the website (the last 30 builds are retained):

To install this version:

  • git fetch https://github.com/GoogleCloudPlatform/agones.git pull/1570/head:pr_1570 && git checkout pr_1570
  • helm install ./install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.6.0-417f01e

@google-oss-robot
Copy link

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: aLekSer, markmandel

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@agones-bot
Copy link
Collaborator

Build Succeeded 👏

Build Id: 971cb3fb-ba86-4065-8379-391381788701

The following development artifacts have been built, and will exist for the next 30 days:

A preview of the website (the last 30 builds are retained):

To install this version:

  • git fetch https://github.com/GoogleCloudPlatform/agones.git pull/1570/head:pr_1570 && git checkout pr_1570
  • helm install ./install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.6.0-74a1b6e

@markmandel markmandel merged commit 3f1233a into googleforgames:master May 19, 2020
@markmandel markmandel deleted the docs/tracking-rest branch May 19, 2020 18:07
ilkercelikyilmaz pushed a commit to ilkercelikyilmaz/agones that referenced this pull request Oct 23, 2020
Reference for player tracking API for the REST interface for the SDK.

Also regrouped as how we now have it in the Client SDK guide.

Work on googleforgames#1033
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved kind/documentation Documentation for Agones kind/feature New features for Agones lgtm size/L
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants