cloudendpoints / endpoints-java

A Java framework for building RESTful APIs on Google App Engine
Apache License 2.0
32 stars 35 forks source link

Add description on enum constants #133

Closed clementdenis closed 6 years ago

clementdenis commented 6 years ago

This PR allows to set a description on enum values in API method parameters, as allowed in the discovery format.

PS: we tried to implement description for enums in Swagger here, as described in Swagger documentation for enums, using the description field, but we preferred not to include it yet.

googlebot commented 6 years ago

So there's good news and bad news.

:thumbsup: The good news is that everyone that needs to sign a CLA (the pull request submitter and all commit authors) have done so. Everything is all good there.

:confused: The bad news is that it appears that one or more commits were authored by someone other than the pull request submitter. We need to confirm that all authors are ok with their commits being contributed to this project. Please have them confirm that here in the pull request.

Note to project maintainer: This is a terminal state, meaning the cla/google commit status will not change from this State. It's up to you to confirm consent of the commit author(s) and merge this pull request when appropriate.

kaldebert commented 6 years ago

I'm ok with my commits being contributed to this project.

tangiel commented 6 years ago

Looks like merging the other PR puts this in conflict. Please fix.

codecov-io commented 6 years ago

Codecov Report

:exclamation: No coverage uploaded for pull request base (master@be24045). Click here to learn what that means. The diff coverage is 100%.

Impacted file tree graph

@@            Coverage Diff            @@
##             master     #133   +/-   ##
=========================================
  Coverage          ?   79.86%           
  Complexity        ?     1662           
=========================================
  Files             ?      156           
  Lines             ?     5568           
  Branches          ?      716           
=========================================
  Hits              ?     4447           
  Misses            ?      843           
  Partials          ?      278
Impacted Files Coverage Δ Complexity Δ
.../api/server/spi/config/model/SchemaRepository.java 92.15% <100%> (ø) 28 <0> (?)
...e/api/server/spi/discovery/DiscoveryGenerator.java 87.74% <100%> (ø) 52 <0> (?)

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update be24045...34b9e4b. Read the comment docs.

kaldebert commented 6 years ago

@tangiel The merge includes the fix for the currently failing master. The last commit covers the missing case for description of $ref fields.