Skip to content

Commit

Permalink
ISSUE-1376: [update] Webhooks, update datatypes for ID and timestamps (
Browse files Browse the repository at this point in the history
…#39)

<!-- Ticket number or summary of work -->
# ISSUE-1376: [update] Webhooks, update datatypes for ID and timestamps
* https://github.com/bigcommerce/api-specs/issue/1376

## What changed?
<!-- Provide a bulleted list in the present tense -->
* Update datatypes for id and timestamps

## Release notes draft
<!-- Provide an entry for the release notes using simple, conversational
language. Don't be too technical. Explain how the change will benefit
the merchant and link to the feature.

Examples:
* The newly-released [X feature] is now available to use. Now, you’ll be
able to [perform Y action].
* We're happy to announce [X feature], which can help you [perform Y
action].
* [X feature] helps you to create [Y response] using the [Z query
parameter]. Now, you can deliver [ex, localized shopping experiences for
your customers].
* Fixed a bug in the [X endpoint]. Now the [Y field] will appear when
you click [Z option]. -->
* Updated datatypes in the Webhooks V3 specifications.

## Anything else?
<!-- Add related PRs, salient notes, additional ticket numbers, etc. -->
* https://github.com/bigcommerce/api-specs/issue/1376

ping {names}
  • Loading branch information
Sarah Riehl authored and bc-tgomez committed Apr 26, 2024
1 parent c01fa4c commit 8554296
Showing 1 changed file with 20 additions and 14 deletions.
34 changes: 20 additions & 14 deletions reference/webhooks.v3.yml
Original file line number Diff line number Diff line change
Expand Up @@ -235,10 +235,12 @@ paths:
default: true
created_at:
type: integer
description: Created time
example: 1561488106
description: The time the webhook was created, represented in UNIX epoch time.
updated_at:
type: integer
description: Updated time
example: 1561488106
description: The time the webhook was most recently updated, represented in UNIX epoch time.
status:
type: string
description: The webhook status.
Expand Down Expand Up @@ -449,7 +451,7 @@ components:
type: object
properties:
id:
type: number
type: integer
client_id:
type: string
minLength: 1
Expand All @@ -471,9 +473,11 @@ components:
is_active:
type: boolean
created_at:
type: number
type: integer
description: The time the webhook was created, represented in UNIX epoch time.
updated_at:
type: number
type: integer
description: The time the webhook was most recently updated, represented in UNIX epoch time.
meta:
type: object
properties:
Expand Down Expand Up @@ -605,7 +609,7 @@ components:
type: object
properties:
id:
type: number
type: integer
client_id:
type: string
minLength: 1
Expand All @@ -627,9 +631,11 @@ components:
is_active:
type: boolean
created_at:
type: number
type: integer
description: The time the webhook was created, represented in UNIX epoch time.
updated_at:
type: number
type: integer
description: The time the webhook was most recently updated, represented in UNIX epoch time.
meta:
type: object
properties:
Expand Down Expand Up @@ -2706,7 +2712,7 @@ components:
- relative
value:
type: integer
description: 'The number of items that the inventory changed by. This can be negative if the inventory is decreased `-3` or positive if an item is returned to the inventory from an order, `2`'
description: 'The number of items that the inventory changed by. This can be negative if the inventory is decreased `-3` or positive if an item is returned to the inventory from an order, `2`.'
example: 2
variant_id:
type: integer
Expand Down Expand Up @@ -2779,7 +2785,7 @@ components:
- relative
value:
type: integer
description: 'The number of items that the inventory changed by. This can be negative if the inventory is decreased `-3` or positive if an item is returned to the inventory from an order, `2`'
description: 'The number of items that the inventory changed by. This can be negative if the inventory is decreased `-3` or positive if an item is returned to the inventory from an order, `2`.'
example: 2
variant_id:
type: integer
Expand Down Expand Up @@ -3106,11 +3112,11 @@ components:
created_at:
type: integer
example: 1561488106
description: Time when the webhook was created.
description: The time the webhook was created, represented in UNIX epoch time.
updated_at:
type: integer
example: 1561488106
description: Time when the webhook was updated.
description: The time the webhook was most recently updated, represented in UNIX epoch time.
HistoryEvent:
type: object
properties:
Expand Down Expand Up @@ -3180,8 +3186,8 @@ components:
- properties:
created_at:
type: integer
example: 1561482670
description: Hook creation date, in Unix timestamp format.
example: 1561488106
description: The time the webhook was created, represented in UNIX epoch time.
readOnly: true
store_id:
type: string
Expand Down

0 comments on commit 8554296

Please sign in to comment.