Skip to content

Commit

Permalink
update failure_reason, fix horizontal spelling
Browse files Browse the repository at this point in the history
  • Loading branch information
zachwreed committed Nov 7, 2023
1 parent 721296b commit 5471370
Show file tree
Hide file tree
Showing 9 changed files with 95 additions and 37 deletions.
42 changes: 21 additions & 21 deletions docs/index.html

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions resources/checks/models/check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -90,9 +90,9 @@ allOf:
- failed

failure_reason:
type: string
description: A string describing the reason for failure if the check failed to render.
nullable: true
allOf:
- $ref: "../../../shared/models/failure_reason/failure_reason.yml"
- nullable: true

object:
type: string
Expand Down
6 changes: 3 additions & 3 deletions resources/letters/models/letter_generated_base.yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,9 @@ allOf:
- failed

failure_reason:
type: string
description: A string describing the reason for failure if the letter failed to render.
nullable: true
allOf:
- $ref: "../../../shared/models/failure_reason/failure_reason.yml"
- nullable: true

object:
type: string
Expand Down
6 changes: 3 additions & 3 deletions resources/postcards/models/postcard.yml
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,9 @@ allOf:
- failed

failure_reason:
type: string
description: A string describing the reason for failure if the postcard failed to render.
nullable: true
allOf:
- $ref: "../../../shared/models/failure_reason/failure_reason.yml"
- nullable: true

object:
type: string
Expand Down
6 changes: 3 additions & 3 deletions resources/self_mailers/models/self_mailer.yml
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,6 @@ allOf:
- failed

failure_reason:
type: string
description: A string describing the reason for failure if the self mailer failed to render.
nullable: true
allOf:
- $ref: "../../../shared/models/failure_reason/failure_reason.yml"
- nullable: true
38 changes: 38 additions & 0 deletions shared/models/failure_reason/error.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
type: object
description: Failure error details

properties:
url:
type: string
description: Failed URL of asset
nullable: true

host:
type: string
description: URL host
nullable: true

path:
type: string
description: URL path
nullable: true

protocol:
type: string
description: Network protocol
nullable: true

remediation:
type: string
description: Instructions on how to resolve the error
nullable: true

error_type:
type: string
description: HTTP response status code message or service defined error
nullable: true

status_code:
type: number
description: HTTP response status codes if the error is asset related
nullable: true
20 changes: 20 additions & 0 deletions shared/models/failure_reason/failure_reason.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
type: object
description: An object describing the reason for failure if the resource failed to render.
required:
- remediation
- failure_reason

properties:
remediation:
type: string
description: Instructions on how to resolve the error

failure_reason:
type: string
description: Reason failure occurred

errors:
type: array
nullable: true
items:
$ref: "../../../shared/models/failure_reason/error.yml"
4 changes: 2 additions & 2 deletions shared/models/qr_code.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,11 @@ properties:

right:
type: string
description: Horizonal distance (in inches) to place QR code from the right. Only allowed if "left" isn't provided.
description: Horizontal distance (in inches) to place QR code from the right. Only allowed if "left" isn't provided.

left:
type: string
description: Horizonal distance (in inches) to place QR code from the left. Only allowed if "right" isn't provided.
description: Horizontal distance (in inches) to place QR code from the left. Only allowed if "right" isn't provided.

bottom:
type: string
Expand Down
4 changes: 2 additions & 2 deletions shared/models/qr_code_campaigns.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@ properties:

right:
type: string
description: Horizonal distance (in inches) to place QR code from the right. Only allowed if "left" isn't provided.
description: Horizontal distance (in inches) to place QR code from the right. Only allowed if "left" isn't provided.

left:
type: string
description: Horizonal distance (in inches) to place QR code from the left. Only allowed if "right" isn't provided.
description: Horizontal distance (in inches) to place QR code from the left. Only allowed if "right" isn't provided.

bottom:
type: string
Expand Down

0 comments on commit 5471370

Please sign in to comment.