Skip to content

Commit

Permalink
MI-5: Update docs with QR code customizations
Browse files Browse the repository at this point in the history
  • Loading branch information
kevinpjones committed Mar 12, 2024
1 parent 1e5ed0d commit f438206
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions shared/models/qr_code.yml
Original file line number Diff line number Diff line change
Expand Up @@ -39,3 +39,26 @@ properties:
pages:
type: string
description: Specify the pages where the QR code should be stamped in a comma separated format. Your QR code can be printed in the same position on multiple pages. For postcards, the values should either be "front", "back" (for either front or back) or "front,back" (for the QR code to be printed on both sides). For self-mailers, the values should either be "inside", "outside" (for either inside or outside) or "inside,outside" (for the QR code to be printed on both sides). For letters, the values can be specific page numbers ("1", "3"), page number ranges such as "1-3", or a comma separated combination of both ("1,3,5-7").

logo:
type: object
description: Allows specifying a logo to be placed over top of the center of the QR code. Logos must be in PNG or JPEG format and have a maximum file size of 1 MB.
properties:
url:
type: string
description: The public URL of the logo image to be retrieved and placed over the center of the QR code.
pattern: "^https://[-a-zA-Z0-9@:%._+~#=/]{1,256}.(png|jpe?g)$"

style:
type: object
description: Customizes the appearance of the QR code.
properties:
background_color:
type: string
description: The background color of the QR code in hexadecimal format. For example, `#000000` is black and `#FFFFFF` is white.
pattern: "^#[A-Fa-f0-9]{6}$"

foreground_color:
type: string
description: The foreground color of the QR code in hexadecimal format. For example, `#000000` is black and `#FFFFFF` is white.
pattern: "^#[A-Fa-f0-9]{6}$"

0 comments on commit f438206

Please sign in to comment.