SDK Matrices for NodeJS, C#, CPP, REST #3548
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -75,4 +75,39 @@ agonesSDK.watchGameServer((result) => { | |||||
|
|
||||||
| To mark the game server as [reserved]({{< relref "_index.md#reserveseconds" >}}) for a period of time, call the async method `reserve(seconds)`. The result will be an empty object. | ||||||
|
|
||||||
| ## SDK Functionality | ||||||
|
|
||||||
| | Area | Action | Implemented | | ||||||
| |-----------------|---------------------|-------------| | ||||||
| | Lifecycle | Ready | ✔️ | | ||||||
| | Lifecycle | Health | ✔️ | | ||||||
| | Lifecycle | Reserve | ✔️ | | ||||||
| | Lifecycle | Allocate | ✔️ | | ||||||
| | Lifecycle | Shutdown | ✔️ | | ||||||
| | Configuration | GameServer | ✔️ | | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| | Configuration | Watch | ✔️ | | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| | Metadata | SetAnnotation | ✔️ | | ||||||
| | Metadata | SetLabel | ✔️ | | ||||||
| | Counters | GetCounterCount | ❌ | | ||||||
| | Counters | SetCounterCount | ❌ | | ||||||
| | Counters | IncrementCounter | ❌ | | ||||||
| | Counters | DecrementCounter | ❌ | | ||||||
| | Counters | SetCounterCapacity | ❌ | | ||||||
| | Counters | GetCounterCapacity | ❌ | | ||||||
| | Lists | AppendListValue | ❌ | | ||||||
| | Lists | DeleteListValue | ❌ | | ||||||
| | Lists | SetListCapacity | ❌ | | ||||||
| | Lists | GetListCapacity | ❌ | | ||||||
| | Lists | ListContains | ❌ | | ||||||
| | Lists | GetListLength | ❌ | | ||||||
| | Lists | GetListValues | ❌ | | ||||||
| | Player Tracking | GetConnectedPlayers | ✔️ | | ||||||
| | Player Tracking | GetPlayerCapacity | ✔️ | | ||||||
| | Player Tracking | GetPlayerCount | ✔️ | | ||||||
| | Player Tracking | IsPlayerConnected | ✔️ | | ||||||
| | Player Tracking | PlayerConnect | ✔️ | | ||||||
| | Player Tracking | PlayerDisconnect | ✔️ | | ||||||
| | Player Tracking | SetPlayerCapacity | ✔️ | | ||||||
|
|
||||||
|
|
||||||
| For more information, please read the [SDK Overview]({{< relref "_index.md" >}}), check out {{< ghlink href="sdks/nodejs/src/agonesSDK.js" >}}agonesSDK.js{{< /ghlink >}} and also look at the {{< ghlink href="examples/nodejs-simple" >}}Node.js example{{< / >}}. | ||||||
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -36,6 +36,18 @@ The same could be run for `alpha.swagger.json` and `beta.swagger.json` as requir | |
|
|
||
| You can read more about OpenAPI/Swagger code generation in their [Command Line Tool Documentation](https://swagger.io/docs/open-source-tools/swagger-codegen/) | ||
|
|
||
| ## SDK Functionality | ||
|
|
||
| | Area | Action | Implemented | | ||
| |-----------|--------------------------------------------------------|-------------| | ||
| | Counters | GET /v1alpha1/counters/{name} | ✔️ | | ||
|
There was a problem hiding this comment. This part looks good to me. Do we want to add rows for other funcations like the other SDKs? There was a problem hiding this comment. I have the same question 🙋♀️ @igooch Looking forward to your inputs There was a problem hiding this comment. I'm not entirely sure what Mark envisioned here, but I would start similarly to the "Action" column like we have in https://agones.dev/site/docs/guides/client-sdks/go/. Then below we can include the Path, Method, Body for each action. The actions for Counters are I would also include the existing actions "Ready", "Health" etc. that are named below in this doc. (The generated client API is at agones/test/sdk/restapi/swagger/api_sdk.go if you want to see the method names.) |
||
| | Counters | PATCH /v1alpha1/counters/{counterUpdateRequest.name} | ✔️ | | ||
| | Lists | PATCH /v1alpha1/lists/{list.name} | ✔️ | | ||
| | Lists | GET /v1alpha1/lists/{name} | ✔️ | | ||
| | Lists | POST /v1alpha1/lists/{name}:addValue | ✔️ | | ||
| | Lists | POST /v1alpha1/lists/{name}:removeValue | ✔️ | | ||
|
|
||
Kalaiselvi84 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ## Reference | ||
|
|
||
| ### Lifecycle Management | ||
|
|
||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.