Skip to content

Commit 011b16c

Browse files
ShipEngineBuildShipEngineBuild
committed
Update to latest openapi definition
1 parent 36e0aa2 commit 011b16c

4 files changed

Lines changed: 181 additions & 29 deletions

File tree

‎docs/index.html‎

Lines changed: 17 additions & 13 deletions
Large diffs are not rendered by default.

‎openapi.json‎

Lines changed: 133 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"openapi": "3.0.0",
33
"info": {
44
"title": "ShipEngine API",
5-
"version": "1.1.202510231110",
5+
"version": "1.1.202511061111",
66
"termsOfService": "https://www.shipengine.com/terms-of-service/",
77
"x-logo": {
88
"url": "https://shipengine.github.io/img/shipengine-logo-square.png",
@@ -28263,7 +28263,7 @@
2826328263
"sales_orders_imported",
2826428264
"track"
2826528265
],
28266-
"description": "The possible webook event values"
28266+
"description": "The possible webhook event values"
2826728267
}
2826828268
]
2826928269
},
@@ -28298,6 +28298,17 @@
2829828298
]
2829928299
},
2830028300
"description": "Array of custom webhook headers"
28301+
},
28302+
"name": {
28303+
"type": "string",
28304+
"example": "My Webhook",
28305+
"description": "The name of the webhook"
28306+
},
28307+
"store_id": {
28308+
"type": "integer",
28309+
"format": "int32",
28310+
"example": 123456,
28311+
"description": "Store ID"
2830128312
}
2830228313
}
2830328314
}
@@ -28694,7 +28705,7 @@
2869428705
},
2869528706
"post": {
2869628707
"summary": "Create a Webhook",
28697-
"description": "Create a webook for specific events in the environment.",
28708+
"description": "Create a webhook for specific events in the environment.",
2869828709
"tags": [
2869928710
"webhooks"
2870028711
],
@@ -28727,7 +28738,7 @@
2872728738
"sales_orders_imported",
2872828739
"track"
2872928740
],
28730-
"description": "The possible webook event values"
28741+
"description": "The possible webhook event values"
2873128742
}
2873228743
]
2873328744
},
@@ -28776,6 +28787,17 @@
2877628787
]
2877728788
},
2877828789
"description": "Array of custom webhook headers"
28790+
},
28791+
"name": {
28792+
"type": "string",
28793+
"example": "My New Webhook",
28794+
"description": "The name of the webhook"
28795+
},
28796+
"store_id": {
28797+
"type": "integer",
28798+
"format": "int32",
28799+
"example": 123456,
28800+
"description": "Store ID"
2877928801
}
2878028802
}
2878128803
}
@@ -28847,7 +28869,7 @@
2884728869
"sales_orders_imported",
2884828870
"track"
2884928871
],
28850-
"description": "The possible webook event values"
28872+
"description": "The possible webhook event values"
2885128873
}
2885228874
]
2885328875
},
@@ -28882,6 +28904,17 @@
2888228904
]
2888328905
},
2888428906
"description": "Array of custom webhook headers"
28907+
},
28908+
"name": {
28909+
"type": "string",
28910+
"example": "My Webhook",
28911+
"description": "The name of the webhook"
28912+
},
28913+
"store_id": {
28914+
"type": "integer",
28915+
"format": "int32",
28916+
"example": 123456,
28917+
"description": "Store ID"
2888528918
}
2888628919
}
2888728920
}
@@ -29558,7 +29591,7 @@
2955829591
"sales_orders_imported",
2955929592
"track"
2956029593
],
29561-
"description": "The possible webook event values"
29594+
"description": "The possible webhook event values"
2956229595
}
2956329596
]
2956429597
},
@@ -29593,6 +29626,17 @@
2959329626
]
2959429627
},
2959529628
"description": "Array of custom webhook headers"
29629+
},
29630+
"name": {
29631+
"type": "string",
29632+
"example": "My Webhook",
29633+
"description": "The name of the webhook"
29634+
},
29635+
"store_id": {
29636+
"type": "integer",
29637+
"format": "int32",
29638+
"example": 123456,
29639+
"description": "Store ID"
2959629640
}
2959729641
}
2959829642
}
@@ -30238,6 +30282,17 @@
3023830282
]
3023930283
},
3024030284
"description": "Array of custom webhook headers"
30285+
},
30286+
"name": {
30287+
"type": "string",
30288+
"example": "My Updated Webhook",
30289+
"description": "The name of the webhook"
30290+
},
30291+
"store_id": {
30292+
"type": "integer",
30293+
"format": "int32",
30294+
"example": 123456,
30295+
"description": "Store ID"
3024130296
}
3024230297
}
3024330298
}
@@ -152722,7 +152777,7 @@
152722152777
"sales_orders_imported",
152723152778
"track"
152724152779
],
152725-
"description": "The possible webook event values"
152780+
"description": "The possible webhook event values"
152726152781
}
152727152782
]
152728152783
},
@@ -152757,6 +152812,17 @@
152757152812
]
152758152813
},
152759152814
"description": "Array of custom webhook headers"
152815+
},
152816+
"name": {
152817+
"type": "string",
152818+
"example": "My Webhook",
152819+
"description": "The name of the webhook"
152820+
},
152821+
"store_id": {
152822+
"type": "integer",
152823+
"format": "int32",
152824+
"example": 123456,
152825+
"description": "Store ID"
152760152826
}
152761152827
}
152762152828
}
@@ -152813,7 +152879,7 @@
152813152879
"sales_orders_imported",
152814152880
"track"
152815152881
],
152816-
"description": "The possible webook event values"
152882+
"description": "The possible webhook event values"
152817152883
}
152818152884
]
152819152885
},
@@ -152848,6 +152914,17 @@
152848152914
]
152849152915
},
152850152916
"description": "Array of custom webhook headers"
152917+
},
152918+
"name": {
152919+
"type": "string",
152920+
"example": "My Webhook",
152921+
"description": "The name of the webhook"
152922+
},
152923+
"store_id": {
152924+
"type": "integer",
152925+
"format": "int32",
152926+
"example": 123456,
152927+
"description": "Store ID"
152851152928
}
152852152929
}
152853152930
},
@@ -152863,7 +152940,7 @@
152863152940
"sales_orders_imported",
152864152941
"track"
152865152942
],
152866-
"description": "The possible webook event values"
152943+
"description": "The possible webhook event values"
152867152944
},
152868152945
"webhook_header": {
152869152946
"title": "webhook_header",
@@ -152926,7 +153003,7 @@
152926153003
"sales_orders_imported",
152927153004
"track"
152928153005
],
152929-
"description": "The possible webook event values"
153006+
"description": "The possible webhook event values"
152930153007
}
152931153008
]
152932153009
},
@@ -152975,6 +153052,17 @@
152975153052
]
152976153053
},
152977153054
"description": "Array of custom webhook headers"
153055+
},
153056+
"name": {
153057+
"type": "string",
153058+
"example": "My New Webhook",
153059+
"description": "The name of the webhook"
153060+
},
153061+
"store_id": {
153062+
"type": "integer",
153063+
"format": "int32",
153064+
"example": 123456,
153065+
"description": "Store ID"
152978153066
}
152979153067
}
152980153068
},
@@ -153038,7 +153126,7 @@
153038153126
"sales_orders_imported",
153039153127
"track"
153040153128
],
153041-
"description": "The possible webook event values"
153129+
"description": "The possible webhook event values"
153042153130
}
153043153131
]
153044153132
},
@@ -153073,6 +153161,17 @@
153073153161
]
153074153162
},
153075153163
"description": "Array of custom webhook headers"
153164+
},
153165+
"name": {
153166+
"type": "string",
153167+
"example": "My Webhook",
153168+
"description": "The name of the webhook"
153169+
},
153170+
"store_id": {
153171+
"type": "integer",
153172+
"format": "int32",
153173+
"example": 123456,
153174+
"description": "Store ID"
153076153175
}
153077153176
}
153078153177
}
@@ -153138,7 +153237,7 @@
153138153237
"sales_orders_imported",
153139153238
"track"
153140153239
],
153141-
"description": "The possible webook event values"
153240+
"description": "The possible webhook event values"
153142153241
}
153143153242
]
153144153243
},
@@ -153173,6 +153272,17 @@
153173153272
]
153174153273
},
153175153274
"description": "Array of custom webhook headers"
153275+
},
153276+
"name": {
153277+
"type": "string",
153278+
"example": "My Webhook",
153279+
"description": "The name of the webhook"
153280+
},
153281+
"store_id": {
153282+
"type": "integer",
153283+
"format": "int32",
153284+
"example": 123456,
153285+
"description": "Store ID"
153176153286
}
153177153287
}
153178153288
}
@@ -153229,6 +153339,17 @@
153229153339
]
153230153340
},
153231153341
"description": "Array of custom webhook headers"
153342+
},
153343+
"name": {
153344+
"type": "string",
153345+
"example": "My Updated Webhook",
153346+
"description": "The name of the webhook"
153347+
},
153348+
"store_id": {
153349+
"type": "integer",
153350+
"format": "int32",
153351+
"example": 123456,
153352+
"description": "Store ID"
153232153353
}
153233153354
}
153234153355
},

‎openapi.yaml‎

Lines changed: 30 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
openapi: 3.0.0
22
info:
33
title: ShipEngine API
4-
version: 1.1.202510231110
4+
version: 1.1.202511061111
55
termsOfService: 'https://www.shipengine.com/terms-of-service/'
66
x-logo:
77
url: 'https://shipengine.github.io/img/shipengine-logo-square.png'
@@ -1554,7 +1554,7 @@ paths:
15541554
$ref: '#/components/responses/500_error_response'
15551555
post:
15561556
summary: Create a Webhook
1557-
description: Create a webook for specific events in the environment.
1557+
description: Create a webhook for specific events in the environment.
15581558
tags:
15591559
- webhooks
15601560
operationId: create_webhook
@@ -7660,6 +7660,15 @@ components:
76607660
allOf:
76617661
- $ref: '#/components/schemas/webhook_header'
76627662
description: Array of custom webhook headers
7663+
name:
7664+
type: string
7665+
example: My Webhook
7666+
description: The name of the webhook
7667+
store_id:
7668+
type: integer
7669+
format: int32
7670+
example: 123456
7671+
description: Store ID
76637672
webhook_event:
76647673
title: webhook_event
76657674
type: string
@@ -7671,7 +7680,7 @@ components:
76717680
- report_complete
76727681
- sales_orders_imported
76737682
- track
7674-
description: The possible webook event values
7683+
description: The possible webhook event values
76757684
webhook_header:
76767685
title: webhook_header
76777686
type: object
@@ -7718,6 +7727,15 @@ components:
77187727
allOf:
77197728
- $ref: '#/components/schemas/webhook_header'
77207729
description: Array of custom webhook headers
7730+
name:
7731+
type: string
7732+
example: My New Webhook
7733+
description: The name of the webhook
7734+
store_id:
7735+
type: integer
7736+
format: int32
7737+
example: 123456
7738+
description: Store ID
77217739
create_webhook_response_body:
77227740
title: create_webhook_response_body
77237741
type: object
@@ -7757,6 +7775,15 @@ components:
77577775
allOf:
77587776
- $ref: '#/components/schemas/webhook_header'
77597777
description: Array of custom webhook headers
7778+
name:
7779+
type: string
7780+
example: My Updated Webhook
7781+
description: The name of the webhook
7782+
store_id:
7783+
type: integer
7784+
format: int32
7785+
example: 123456
7786+
description: Store ID
77607787
add_funds_to_insurance_request_body:
77617788
title: add_funds_to_insurance_request_body
77627789
type: object

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "shipengine-openapi",
3-
"version": "1.20.7",
3+
"version": "1.20.8",
44
"description": "The official OpenAPI 3.0 definitions for ShipEngine™",
55
"main": "openapi.json",
66
"repository": {

0 commit comments

Comments
 (0)