CMB-586: add booklets CRUD documentation #498
Conversation
|
The booklets launch is scheduled for end of July. This PR is expected to be merged when we're good to go with the launch of booklets. However, at this moment in time, it is good for a review. |
| @@ -0,0 +1,4 @@ | |||
| type: boolean | |||
There was a problem hiding this comment.
color shouldn't be part of the booklet payload so we can remove this attribute and remove color from the samples. I think we still have it in the booklet serializer but currently it will always be undefined. I'll create a ticket to remove color and return_address.
| - $ref: "../../../shared/attributes/model_ids/vrsn_id.yml" | ||
|
|
||
| campaign_id: | ||
| $ref: "../../../shared/attributes/campaign_id.yml" |
There was a problem hiding this comment.
This file should be updated to note that campaign ids for booklets will also be prefixed with camp_.
It also looks like the description in /shared/parameters/campaign_id.yml should also be updated for the list endpoint parameter.
| color: true | ||
| mail_type: usps_first_class |
There was a problem hiding this comment.
Didn't catch color in the response last time time but this should be removed as well.
| color: true | |
| mail_type: usps_first_class | |
| mail_type: usps_first_class |
| date_created: "2018-12-08T03:01:07.651Z" | ||
| date_modified: "2018-12-08T03:01:07.651Z" | ||
| object: address | ||
| color: true |
| date_modified: "2017-09-05T15:54:53.264Z" | ||
| deleted: true | ||
| object: address | ||
| color: true |
| -d 'qr_code[pages]=3,4-5' \ | ||
| -d 'fsc=true' | ||
| label: CURL | ||
| # - lang: Typescript |
There was a problem hiding this comment.
not blocking, just curious why this is commented out
There was a problem hiding this comment.
Booklets are not part of the SDKs. The SDKs are in a strange state where they have not been maintained over the past several months. I've surfaced this to my manager @nperri6 (and @gtstewart16) and he's been in talks with the ELT to determine the next steps for the SDKs. In the meantime, we do not want to convey the wrong information to the users of the API, given that the examples are pointing to the usage of these objects under the respective SDKs. That's why the Blueprint team agreed to leave out the code examples.
Fixes CMB-586
Checklist
mainnpm run bundleoutputs nothing suspectnpm run postmanoutputs nothing suspectChanges
true.sizeproperty defaults to9x6.Areas of Concern (optional)
As mentioned above, the code samples are missing. This is because they are not part of the SDKs. Once they are introduced in the SDKs, the docs will need to be updated.
I encourage the reviewers to pull down the branch and preview the HTML to catch any errors or mistakes prior to approval.