Skip to content

Commit

Permalink
Update to latest openapi definition
Browse files Browse the repository at this point in the history
  • Loading branch information
@ShipEngineBuild
ShipEngineBuild committed Sep 4, 2024
1 parent a510e56 commit 48600c8
Show file tree
Hide file tree
Showing 4 changed files with 164 additions and 83 deletions.
14 changes: 7 additions & 7 deletions docs/index.html
View file

Large diffs are not rendered by default.

209 changes: 151 additions & 58 deletions openapi.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"openapi": "3.0.0",
"info": {
"title": "ShipEngine API",
"version": "1.1.202408290608",
"version": "1.1.202409030909",
"termsOfService": "https://www.shipengine.com/terms-of-service/",
"x-logo": {
"url": "https://shipengine.github.io/img/shipengine-logo-square.png",
Expand Down Expand Up @@ -80994,25 +80994,56 @@
"items": {
"type": "object",
"properties": {
"unit": {
"type": "string",
"example": "centimeter",
"description": "Unit of the dimensions of the packages"
},
"length": {
"type": "double",
"example": 60,
"description": "Package length"
},
"width": {
"type": "double",
"example": 60,
"description": "Package width"
},
"height": {
"type": "double",
"example": 60,
"description": "Package height"
"dimensions": {
"allOf": [
{
"title": "dimensions",
"type": "object",
"description": "The dimensions of a package",
"required": [
"unit",
"length",
"width",
"height"
],
"additionalProperties": false,
"properties": {
"unit": {
"default": "inch",
"allOf": [
{
"title": "dimension_unit",
"type": "string",
"enum": [
"inch",
"centimeter"
],
"description": "The dimension units that are supported by ShipEngine."
}
]
},
"length": {
"type": "number",
"minimum": 0,
"default": 0,
"description": "The length of the package, in the specified unit"
},
"width": {
"type": "number",
"minimum": 0,
"default": 0,
"description": "The width of the package, in the specified unit"
},
"height": {
"type": "number",
"minimum": 0,
"default": 0,
"description": "The height of the package, in the specified unit"
}
}
}
],
"description": "The package dimensions"
}
}
}
Expand Down Expand Up @@ -201516,25 +201547,56 @@
"items": {
"type": "object",
"properties": {
"unit": {
"type": "string",
"example": "centimeter",
"description": "Unit of the dimensions of the packages"
},
"length": {
"type": "double",
"example": 60,
"description": "Package length"
},
"width": {
"type": "double",
"example": 60,
"description": "Package width"
},
"height": {
"type": "double",
"example": 60,
"description": "Package height"
"dimensions": {
"allOf": [
{
"title": "dimensions",
"type": "object",
"description": "The dimensions of a package",
"required": [
"unit",
"length",
"width",
"height"
],
"additionalProperties": false,
"properties": {
"unit": {
"default": "inch",
"allOf": [
{
"title": "dimension_unit",
"type": "string",
"enum": [
"inch",
"centimeter"
],
"description": "The dimension units that are supported by ShipEngine."
}
]
},
"length": {
"type": "number",
"minimum": 0,
"default": 0,
"description": "The length of the package, in the specified unit"
},
"width": {
"type": "number",
"minimum": 0,
"default": 0,
"description": "The width of the package, in the specified unit"
},
"height": {
"type": "number",
"minimum": 0,
"default": 0,
"description": "The height of the package, in the specified unit"
}
}
}
],
"description": "The package dimensions"
}
}
}
Expand Down Expand Up @@ -201705,25 +201767,56 @@
"items": {
"type": "object",
"properties": {
"unit": {
"type": "string",
"example": "centimeter",
"description": "Unit of the dimensions of the packages"
},
"length": {
"type": "double",
"example": 60,
"description": "Package length"
},
"width": {
"type": "double",
"example": 60,
"description": "Package width"
},
"height": {
"type": "double",
"example": 60,
"description": "Package height"
"dimensions": {
"allOf": [
{
"title": "dimensions",
"type": "object",
"description": "The dimensions of a package",
"required": [
"unit",
"length",
"width",
"height"
],
"additionalProperties": false,
"properties": {
"unit": {
"default": "inch",
"allOf": [
{
"title": "dimension_unit",
"type": "string",
"enum": [
"inch",
"centimeter"
],
"description": "The dimension units that are supported by ShipEngine."
}
]
},
"length": {
"type": "number",
"minimum": 0,
"default": 0,
"description": "The length of the package, in the specified unit"
},
"width": {
"type": "number",
"minimum": 0,
"default": 0,
"description": "The width of the package, in the specified unit"
},
"height": {
"type": "number",
"minimum": 0,
"default": 0,
"description": "The height of the package, in the specified unit"
}
}
}
],
"description": "The package dimensions"
}
}
}
Expand Down
22 changes: 5 additions & 17 deletions openapi.yaml
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
openapi: 3.0.0
info:
title: ShipEngine API
version: 1.1.202408290608
version: 1.1.202409030909
termsOfService: 'https://www.shipengine.com/terms-of-service/'
x-logo:
url: 'https://shipengine.github.io/img/shipengine-logo-square.png'
Expand Down Expand Up @@ -12067,22 +12067,10 @@ components:
items:
type: object
properties:
unit:
type: string
example: centimeter
description: Unit of the dimensions of the packages
length:
type: double
example: 60
description: Package length
width:
type: double
example: 60
description: Package width
height:
type: double
example: 60
description: Package height
dimensions:
allOf:
- $ref: '#/components/schemas/dimensions'
description: The package dimensions
list_service_points_response_body:
title: list_service_points_response_body
type: object
Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "shipengine-openapi",
"version": "1.16.7",
"version": "1.16.8",
"description": "The official OpenAPI 3.0 definitions for ShipEngine™",
"main": "openapi.json",
"repository": {
Expand Down

0 comments on commit 48600c8

Please sign in to comment.