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

docs(api): adds missing params from user docs #5806

Merged
merged 4 commits into from Apr 23, 2019

Conversation

shreyanshdwivedi
Copy link
Member

@shreyanshdwivedi shreyanshdwivedi commented Apr 16, 2019

Fixes #5773

Checklist

  • I have read the Contribution & Best practices Guide and my PR follows them.
  • My branch is up-to-date with the Upstream development branch.
  • The unit tests pass locally with my changes
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)
  • All the functions created/modified in this PR contain relevant docstrings.

Short description of what this resolves:

Fields was_registered_with_order, is_user_organizer, is_user_coorganizer, is_user_track_organizer, is_user_moderator is_user_registrar, is_user_attendee were added, documentation has not been updated

Changes proposed in this pull request:

  • adds was_registered_with_order to user docs
    sss

@codecov
Copy link

codecov bot commented Apr 16, 2019

Codecov Report

Merging #5806 into development will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff              @@
##           development    #5806   +/-   ##
============================================
  Coverage        66.58%   66.58%           
============================================
  Files              282      282           
  Lines            13729    13729           
============================================
  Hits              9141     9141           
  Misses            4588     4588

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 977b80a...ac8f4f1. Read the comment docs.

@shreyanshdwivedi
Copy link
Member Author

shreyanshdwivedi commented Apr 16, 2019

@iamareebjamal @CosmicCoder96 there are few more fields which aren't added to the docs but are returned for the user docs.
is_user_organizer, is_user_coorganizer, is_user_track_organizer, is_user_moderator is_user_registrar, is_user_attendee.
Should I add them to this PR?
ss

@shreyanshdwivedi
Copy link
Member Author

@CosmicCoder96 @iamareebjamal please review

@iamareebjamal
Copy link
Member

We are repeating ourselves a lot. We should be keeping the documentation DRY and use types. Please open an issue for that

https://blog.apimatic.io/common-mistakes-developers-make-in-their-api-blueprint-files-4b3b8c61306b

@iamareebjamal iamareebjamal changed the title docs:adds missing params from user docs docs(api): adds missing params from user docs Apr 16, 2019
@shreyanshdwivedi
Copy link
Member Author

@CosmicCoder96 please review

@shreyanshdwivedi
Copy link
Member Author

@iamareebjamal please merge

@iamareebjamal iamareebjamal merged commit 95ffaa5 into fossasia:development Apr 23, 2019
@shreyanshdwivedi shreyanshdwivedi deleted the userDocs branch June 14, 2019 08:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation: Update users docs
3 participants