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

Swagger for Game Server API #393

Merged
merged 19 commits into from
Sep 19, 2022

Conversation

ShrayRastogi
Copy link
Contributor

@ShrayRastogi ShrayRastogi commented Sep 16, 2022

  1. Added swag and gin-swagger packages
  2. Generated swagger docs
  3. Set Swagger host and base path dynamically
  4. Added API definitions for GameServerAPI

Live demo here - http://20.244.70.222:5001/swagger/index.html

@@ -144,6 +157,15 @@ func listGameServeBuilds(c *gin.Context) {
}
}

// @Summary get a game server build by buildName and namespace
Copy link
Collaborator

Choose a reason for hiding this comment

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

can we call them "GameServer" and "GameServerBuild" to be consistent with the rest of the documentation? Thank you!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

sure, will do! Thanks @dgkanatsios for checking it out, created this draft PR for early feedback!!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@dgkanatsios - Could you help with this error - "go utils need to be executed", which go-utils to use?

Copy link
Collaborator

Choose a reason for hiding this comment

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

this is the step in the pipeline that shows which utilities are executed. https://github.com/PlayFab/thundernetes/blob/main/.github/workflows/unit-tests.yml#L29

@ShrayRastogi
Copy link
Contributor Author

Resolves #160

@ShrayRastogi
Copy link
Contributor Author

@dgkanatsios - I have uploaded the changes here, if you want to check it out - http://20.244.70.222:5001/swagger/index.html

@dgkanatsios
Copy link
Collaborator

I can see it, nice, thank you!

@ShrayRastogi ShrayRastogi marked this pull request as ready for review September 19, 2022 05:33
@ShrayRastogi
Copy link
Contributor Author

I can see it, nice, thank you!

Full list is now available at - http://20.244.70.222:5001/swagger/index.html, check it out and let me know if any changes are required.

@dgkanatsios
Copy link
Collaborator

LGTM! Can you also make a PR to the documentation with instructions for folks to generate and access the swagger file?

Copy link
Collaborator

@dgkanatsios dgkanatsios left a comment

Choose a reason for hiding this comment

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

:shipit:

@ShrayRastogi
Copy link
Contributor Author

LGTM! Can you also make a PR to the documentation with instructions for folks to generate and access the swagger file?

@dgkanatsios - Done, please check here - #397

@dgkanatsios dgkanatsios merged commit a585b0f into PlayFab:main Sep 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants