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

Postman Setup Docs #1

Merged
merged 2 commits into from
Sep 28, 2022
Merged

Postman Setup Docs #1

merged 2 commits into from
Sep 28, 2022

Conversation

emilkovacev
Copy link
Member

Proposed changes


Postman is an invaluable resource for new developers on this api. Having a pre-configured json file for postman will allow developers to understand exactly what a request looks like, and how they can make that request. Another option would be to host that json config file somewhere in this repo, so that we can make updates as we develop new endpoints.

Types of changes


What types of changes does your code introduce?
Put an x in the boxes that apply

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation Update (if none of the other choices apply)

Checklist


  • My changeset covers only what is described above (no extraneous changes)
  • Lint and 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)
  • Any dependent changes have been merged downstream

Further comments


N/A

Postman is an invaluable resource for new developers on this api. Having a pre-configured json file for postman will allow developers to understand exactly what a request looks like, and how they can make that request. Another option would be to host that json config file somewhere in this repo, so that we can make updates as we develop new endpoints.
@emilkovacev emilkovacev added the documentation Improvements or additions to documentation label Sep 21, 2022
@emilkovacev emilkovacev self-assigned this Sep 21, 2022
Copy link
Member

@jessehartloff jessehartloff left a comment

Choose a reason for hiding this comment

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

Looks good. More documentation is always a good thing

@jessehartloff jessehartloff merged commit e65a160 into makeopensource:master Sep 28, 2022
jessehartloff pushed a commit that referenced this pull request Oct 26, 2022
@emilkovacev emilkovacev deleted the postman-setup-docs branch November 17, 2022 04:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Development

Successfully merging this pull request may close these issues.

2 participants