Add postman templates to api documentation - Githubissues

cds-snc / notification-planning

Project planning for GC Notify Team

5 stars 0 forks source link

Add postman templates to api documentation #1268

Open sastels opened 1 year ago

sastels commented 1 year ago

Description

As a client, I need to be able to learn how to use our api.

WHY are we building?

client request. This would be an easy thing for us to do and possibly more users to figure out the api on their own.

WHAT are we building?

Postman templates

VALUE created by our solution

user experience
increased self-service, reduce in support tickets

Acceptance Criteria

[ ] templates created for a few cases of using the api

Related

Helpdesk ticket

QA Steps

[ ] use the templates to make api calls

yaelberger-commits commented 1 year ago

cc @andrewleith if those postman files are helpful, maybe we can use them to create templates?

andrewleith commented 1 year ago

Yeah for sure wouldn't be too hard and could help new users quite a bit!

What do we want to create templates for? Here are some things we could provide templates for: Email

Sending an email without personalisation
Sending an email with personalisation
Sending a file as an attachment
Sending a file as a link

SMS

Sending an SMS without personalisation
Sending an SMS with personalisation

BULK

Send a bulk email request
Send a bulk SMS request