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

PMAPI-1829: add buckslips docs #400

Merged
merged 11 commits into from
Oct 20, 2022
Merged

PMAPI-1829: add buckslips docs #400

merged 11 commits into from
Oct 20, 2022

Conversation

jlincodes
Copy link
Contributor

@jlincodes jlincodes commented Oct 13, 2022 •
edited
Loading

Implements changes for PMAPI-1829

Checklist

  • Up to date with main
  • All the tests are passing
    • Delete all resources created in tests
  • Prettier
  • Spectral Lint
  • npm run bundle outputs nothing suspect
  • npm run postman outputs nothing suspect

Changes

  • Adds Buckslip and Buckslip Orders sections under Special Features
  • Adds all relevant endpoints to new sections
  • Adds Buckslips to Creatives and Letters (response only)

Areas of Concern (optional)

@jlincodes jlincodes self-assigned this Oct 13, 2022
@jlincodes jlincodes changed the title Pmapi 1829 add buckslips docs PMAPI-1829: add buckslips docs Oct 13, 2022
@jlincodes jlincodes marked this pull request as ready for review October 13, 2022 18:29
@jlincodes jlincodes requested review from a team and BennyKitchell as code owners October 13, 2022 18:29
jho44
jho44 suggested changes Oct 17, 2022
View reviewed changes
lob-api-public.yml Outdated
Comment on lines 2531 to 2539
/buckslips:
$ref: resources/buckslips/buckslips.yml

/buckslips/{buckslip_id}:
$ref: resources/buckslips/buckslip.yml

/buckslips/{buckslip_id}/orders:
$ref: resources/buckslips/buckslip_orders/buckslip_orders.yml

Copy link
Contributor

Choose a reason for hiding this comment

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

If you could just move these above the /bulk/us_verifications endpoint to maintain the alphabetical ordering, that'd be great ^^

Copy link
Contributor

Choose a reason for hiding this comment

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

LTGM otherwise!

@jlincodes jlincodes requested a review from jho44 October 19, 2022 02:26
@maelingmurphy
Copy link
Contributor

Just viewed the docs locally using npm run redoc and the changes look great, Julie! There have been some inventory-related updates to the Buckslip & Buckslip Order serialized responses (from this PR) but we can a file a followup ticket for those updates as to not block these initial docs from going out.

jho44
jho44 approved these changes Oct 20, 2022
View reviewed changes
Copy link
Contributor

@jho44 jho44 left a comment

Choose a reason for hiding this comment

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

LGTM outside of that thing we talked about with cards and buckslips not appearing for certified or registered letters. Will also note that you added buckslips to creatives, not campaigns (though I know they're part of the same API group...bygones).

@jlincodes jlincodes merged commit 2737ff3 into main Oct 20, 2022
@jlincodes jlincodes deleted the PMAPI-1829-add-buckslips-docs branch October 20, 2022 16:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@maelingmurphy maelingmurphy maelingmurphy approved these changes

@jho44 jho44 jho44 approved these changes

@BennyKitchell BennyKitchell Awaiting requested review from BennyKitchell

@jharrell jharrell Awaiting requested review from jharrell

Assignees

@jlincodes jlincodes

Labels
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@jlincodes @maelingmurphy @jho44