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

Update fields in cluster-service API to be snake_case #3237

Merged
merged 5 commits into from
Sep 5, 2023

Conversation

sarataha
Copy link
Member

@sarataha sarataha commented Aug 21, 2023

Part of: #3220

What changed?
Updated field names in cluster-service API to meet the styling guide, by changing field names to be snake_case
Ref: https://protobuf.dev/programming-guides/style/
Also ensured docstrings all make sense, and omitted the name of message (function) in the proto file.

We also go through to UI and

  • make sure request and and response payloads are all declaring types
  • remove lots of unused code found while going through the types

Why was this change made?
This is part of the API clean up before publishing it for customer usage.

How was this change implemented?

How did you validate the change?

Release notes

Documentation Changes

Other follow ups

@sarataha sarataha added enhancement New feature or request team/pesto labels Aug 21, 2023
@sarataha sarataha force-pushed the api-fieldnames-update branch 3 times, most recently from cf5d156 to 371a066 Compare August 21, 2023 20:35
@sarataha sarataha marked this pull request as ready for review August 21, 2023 20:59
@sarataha sarataha requested a review from a team August 21, 2023 21:33
@sarataha sarataha force-pushed the api-fieldnames-update branch from 371a066 to 531cfc6 Compare August 23, 2023 13:55
- And remove all a lot of unused code in the FE too
@foot foot requested a review from jpellizzari as a code owner September 4, 2023 21:33
rpc ListTemplateParams(ListTemplateParamsRequest)
returns (ListTemplateParamsResponse) {
option (google.api.http) = {
get : "/v1/templates/{template_name}/params"
};
}

// Returns a list of profiles within that template
// `gitops get <template-name> --list-profiles`
Copy link
Collaborator

Choose a reason for hiding this comment

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

Lets omit the cli command here.

The annotation mentioned here is no longer required too

Copy link
Collaborator

@foot foot left a comment

Choose a reason for hiding this comment

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

Nice one!

@foot foot merged commit 3468cfa into main Sep 5, 2023
@foot foot deleted the api-fieldnames-update branch September 5, 2023 10:57
AsmaaNabilBakr pushed a commit that referenced this pull request Sep 6, 2023
* Update fields in cluster-service API to be snake_case
* Make sure all network requests in the UI use the protobuf types
* And remove all a lot of unused code in the FE too


---------

Co-authored-by: Simon Howe <[email protected]>
Co-authored-by: Simon <[email protected]>
AsmaaNabilBakr added a commit that referenced this pull request Sep 6, 2023
* fix button spaces

* remove unused imports

* update snaps

* remove unused styled components

* Rename ui-cra -> ui and move package.json to root (#3263)

* Search replace all the ui-cra to ui
* and move package.json to root
* run eject

* Update fields in cluster-service API to be snake_case (#3237)

* Update fields in cluster-service API to be snake_case
* Make sure all network requests in the UI use the protobuf types
* And remove all a lot of unused code in the FE too


---------

Co-authored-by: Simon Howe <[email protected]>
Co-authored-by: Simon <[email protected]>

* Bump @adobe/css-tools from 4.2.0 to 4.3.1 (#3284)

Bumps [@adobe/css-tools](https://github.com/adobe/css-tools) from 4.2.0 to 4.3.1.
- [Changelog](https://github.com/adobe/css-tools/blob/main/History.md)
- [Commits](https://github.com/adobe/css-tools/commits)

---
updated-dependencies:
- dependency-name: "@adobe/css-tools"
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Simon <[email protected]>

* Bump async from 2.6.3 to 2.6.4 (#3285)

Bumps [async](https://github.com/caolan/async) from 2.6.3 to 2.6.4.
- [Release notes](https://github.com/caolan/async/releases)
- [Changelog](https://github.com/caolan/async/blob/v2.6.4/CHANGELOG.md)
- [Commits](caolan/async@v2.6.3...v2.6.4)

---
updated-dependencies:
- dependency-name: async
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Simon <[email protected]>

* Explorer extending - gitopssets (#3267)

* Add gitopsset kind to supported objects in explorer query

* add gitopssets to rbac rules

* Add gitopssets to ToFluxObject

* Add gitopssets to getKindRoute fn in ui

* Add gitopssets query server testcase to server integration tests

* Use allowGitOpsSetsAnyOnDefaultNamespace for gitopsset support query server test

* Add gitopssets crd to query suite test

* changed category gitopsset (#3290)

---------

Co-authored-by: Eneko Fernández <[email protected]>

* update snaps

---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: Simon <[email protected]>
Co-authored-by: Sara Elzayat <[email protected]>
Co-authored-by: Simon Howe <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Rana Tarek Hassan <[email protected]>
Co-authored-by: Eneko Fernández <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request team/pesto
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants