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

[management] Add quality rating on apis #1403

Closed
NicolasGeraud opened this Issue Jul 19, 2018 · 0 comments

Comments

Projects
None yet
2 participants
@NicolasGeraud
Member

NicolasGeraud commented Jul 19, 2018

Add a quality rate on apis according to criteria :

  • markdown documentation exists and is published
  • swagger documentation exists and is published
  • an healthcheck is set
  • the description contains has a minimum length
  • the default logo is not used
  • views and labels are set on the API

The idea is to invite API publisher to configure all non mandatory fields according to the admin rules.
The platform admin will configure the criteria he wants to use and the weight of each criteria.
For example the admin will set the following config :

criteria weight
logo 1
description (140char) 1
functional documentation 2

By default the API has a score of 0%. If the publisher set a new logo, the new score becomes 25%. You published a markdown documentation, the score becomes 75%.

The administrator can also choose to display this score on the portal.

@NicolasGeraud NicolasGeraud added this to the 1.19.0 milestone Jul 19, 2018

@NicolasGeraud NicolasGeraud self-assigned this Aug 15, 2018

NicolasGeraud added a commit to gravitee-io/gravitee-management-rest-api that referenced this issue Aug 21, 2018

NicolasGeraud added a commit to gravitee-io/gravitee-management-webui that referenced this issue Aug 21, 2018

NicolasGeraud added a commit to gravitee-io/gravitee-management-rest-api that referenced this issue Aug 21, 2018

NicolasGeraud added a commit to gravitee-io/gravitee-management-webui that referenced this issue Aug 21, 2018

NicolasGeraud added a commit to gravitee-io/gravitee-management-webui that referenced this issue Aug 22, 2018

NicolasGeraud added a commit to gravitee-io/gravitee-management-rest-api that referenced this issue Aug 22, 2018

NicolasGeraud added a commit to gravitee-io/gravitee-management-rest-api that referenced this issue Aug 27, 2018

NicolasGeraud added a commit to gravitee-io/gravitee-management-webui that referenced this issue Aug 27, 2018

NicolasGeraud added a commit to gravitee-io/gravitee-management-rest-api that referenced this issue Aug 27, 2018

brasseld added a commit to gravitee-io/gravitee-management-rest-api that referenced this issue Aug 28, 2018

brasseld added a commit to gravitee-io/gravitee-management-webui that referenced this issue Aug 28, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment