Skip to content
This repository has been archived by the owner on Feb 28, 2019. It is now read-only.

Adds swagger description fields to MappingRule and RollupRule #27

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

m-sandusky
Copy link
Contributor

Adds swagger description fields to MappingRule and RollupRule and their corresponding data models (MappingRuleData, RollupRuleData)

@@ -836,6 +836,9 @@
"name": {
"type": "string"
},
"description": {
Copy link
Contributor

Choose a reason for hiding this comment

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

For this we actually need to make a change to the backend protobuf message.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yup, I wanted to make a separate pull request for that (as it's in a different repo I believe). This pull request was mainly to confirm agree on the upcoming API change, and have the changes updated in Swagger.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Cool, looks good. I agree with Xi, we should merge it with the actual implementation so its consistent on master.

Also, I wonder if there is a way to extend an Object in swagger markup. eg MappingRule is implemented by MappingRuleData. Might help on code duplication.

@coveralls
Copy link

coveralls commented Oct 18, 2017

Coverage Status

Coverage remained the same at 40.141% when pulling e7f5354 on add-rule-description-field-swagger-docs into 9325f5b on master.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants