GTBitsOfGood/stempower

Create Postman Collection to Document API

Open

#12 opened on Jan 26, 2019

View on GitHub
 (0 comments) (0 reactions) (0 assignees)JavaScript (3 forks)auto 404
backendgood first issue

Repository metrics

Stars
 (1 star)
PR merge metrics
 (PR metrics pending)

Description

There currently exists a Postman collection for the Mentor API, which is meant to provide a RESTful way of accessing and updating the Mentor collection. There is also an incomplete collection for the Organization API.

Go through the /routes subdirectory of the /backend folder and create a master Postman collection that encapsulates all current endpoints. This will go a long way towards making it easy for team members to quickly get working with the backend, and it it will also give new members a great way to start learning the codebase.

As you are creating the collection, if you notice any endpoint that seems out of place or does not follow a RESTful style, please either fix the problem or mark it down as an issue to address later.

Contributor guide

Research direction
Explore the /backend/routes directory to identify all endpoints and create a master Postman collection.
Tech stack
javascript
Domain
backendapi
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PostmanREST API basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75