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

KIALI-1329 Adding documentation to Metrics endpoints #461

Merged
merged 4 commits into from Aug 29, 2018

Conversation

xeviknal
Copy link
Member

@xeviknal xeviknal commented Aug 27, 2018

** Describe the change **

  1. Adding all the query params from metrics endpoints has been adapted to be in swagger format.
  2. Fixed missing params in swagger for AppList endpoint.
  3. Classified all the endpoints per resource type (Apps, Namespaces, Services, Workloads, Config).
  4. Adding swagger documentation to old undocumented endpoints.

** Issue reference **
KIALI-1329

** Backwards incompatible? **
Yes.

screenshot of api documentation

NOTE: update your swagger installation to fix a infinit loop (go-swagger/go-swagger#1614) // remove its installation folder and run again make swagger-install

@lucasponce
Copy link
Contributor

I think the "reporter" param is missing in the doc.
This was introduced in a previous PR:
https://github.com/kiali/kiali/blob/master/prometheus/metrics.go#L34
and it hits the inner API but not proper documented across the handlers.

@xeviknal
Copy link
Member Author

@lucasponce comments addressed :)

Copy link
Contributor

@lucasponce lucasponce left a comment

Choose a reason for hiding this comment

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

LGTM
Thanks @xeviknal

@lucasponce lucasponce merged commit 9961ba0 into kiali:master Aug 29, 2018
@xeviknal xeviknal deleted the KIALI-1329 branch September 26, 2018 08:38
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

2 participants