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.

Sign up for GitHub

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

Jump to bottom

Branding API improvement #3334

Merged
merged 4 commits into from
Jan 17, 2018
Merged

Branding API improvement #3334

merged 4 commits into from
Jan 17, 2018

Conversation

matleppa
Copy link
Member

Closes #3325

Changes

  • corrected API to update socialMediaLinks instead of socialMedia in Branding DB
  • /POST and /PUT: added information about erroneous parameter in 400 response
  • enhanced generated swagger document
    • added general description
    • added descriptions in endpoints

Developer checklist

This checklist is to be completed by the PR developer:

  • Alternative solutions were compared/discussed before writing code
    • trade-offs with this solution are considered acceptable
  • Code in this PR adheres to the project styleguide
  • This pull request does not decrease project test coverage
  • If the code changes existing database collection(s), migration has been written
  • If UI texts are added or changed, all texts are internationalized

Reviewer checklist

Reviewed by: @username1

This list is to be completed by the pull request reviewer:

  • Code works as described/expected
  • Code seems to be error free
    • no browser console errors visible
    • no server console errors visible
    • passes CI build
  • Code is written in a way that promotes maintainability
    • easy to understand
    • well organized
    • follows project coding standards and conventions
    • well documented

@ghost ghost assigned matleppa Jan 16, 2018
@ghost ghost added the in progress label Jan 16, 2018
@matleppa matleppa changed the title Branding API improve Branding API improvement Jan 16, 2018
@matleppa matleppa requested a review from marla-singer January 16, 2018 12:31
marla-singer
marla-singer suggested changes Jan 17, 2018
View reviewed changes
Copy link
Contributor

@marla-singer marla-singer left a comment

Choose a reason for hiding this comment

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

Just one remark. Another looks good

apinf_packages/rest_apis/server/branding.js
@@ -6,7 +6,10 @@
// Meteor contributed packages imports
import { Restivus } from 'meteor/nimble:restivus';

const SettingsV1 = new Restivus({
// APInf imports
import descriptionBranding from '/apinf_packages/rest_apis/lib/descriptions/branding_texts';
Copy link
Contributor

Choose a reason for hiding this comment

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

As I see you didn't use this variable in this file

Remove

Copy link
Member Author

Choose a reason for hiding this comment

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

Do you mean variable descriptionBranding?
It is used on line 27.
( description: descriptionBranding.general, )

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah, sorry, didn't see it

@marla-singer marla-singer added this to the Sprint 62 milestone Jan 17, 2018
@marla-singer marla-singer merged commit 976aef4 into develop Jan 17, 2018
@marla-singer marla-singer deleted the feature/branding-api-document-improve branch January 17, 2018 12:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@marla-singer marla-singer marla-singer approved these changes

Assignees

@matleppa matleppa

Labels
None yet
Projects
None yet
Milestone
Sprint 62
Development

Successfully merging this pull request may close these issues.
2 participants
@matleppa @marla-singer