├── .gitattributes ├── .github └── workflows │ └── nodejs.yml ├── .gitignore ├── README.md ├── docs ├── img │ ├── favicon-16x16.png │ ├── favicon-194x194.png │ └── favicon-32x32.png └── index.html ├── openapi.json ├── openapi.yaml └── package.json /.gitattributes: -------------------------------------------------------------------------------- 1 | # Git attributes 2 | # https://git-scm.com/docs/gitattributes 3 | # https://git-scm.com/book/en/v2/Customizing-Git-Git-Attributes 4 | 5 | # Normalize line endings for all files that git determines to be text. 6 | # https://git-scm.com/docs/gitattributes#Documentation/gitattributes.txt-Settostringvalueauto 7 | * text=auto 8 | 9 | # Normalize line endings to LF on checkin, and do NOT convert to CRLF when checking-out on Windows. 10 | # https://git-scm.com/docs/gitattributes#_code_eol_code 11 | *.txt text eol=lf 12 | *.htm text eol=lf 13 | *.html text eol=lf 14 | *.md text eol=lf 15 | *.njk text eol=lf 16 | *.css text eol=lf 17 | *.scss text eol=lf 18 | *.map text eol=lf 19 | *.js text eol=lf 20 | *.jsx text eol=lf 21 | *.ts text eol=lf 22 | *.tsx text eol=lf 23 | *.json text eol=lf 24 | *.yml text eol=lf 25 | *.yaml text eol=lf 26 | *.xml text eol=lf 27 | *.svg text eol=lf 28 | -------------------------------------------------------------------------------- /.github/workflows/nodejs.yml: -------------------------------------------------------------------------------- 1 | name: Node/NPM CI 2 | 3 | on: 4 | push: 5 | branches: 6 | - master 7 | 8 | jobs: 9 | build: 10 | runs-on: ubuntu-latest 11 | strategy: 12 | matrix: 13 | node-version: [12.x] 14 | steps: 15 | - uses: actions/checkout@v1 16 | - name: Use Node.js ${{ matrix.node-version }} 17 | uses: actions/setup-node@v1 18 | with: 19 | node-version: ${{ matrix.node-version }} 20 | - name: npm login 21 | run: echo "//registry.npmjs.org/:_authToken=${{secrets.NPM_AUTH_TOKEN}}" > ~/.npmrc 22 | - name: npm publish 23 | run: npm publish 24 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Git ignore 2 | # https://git-scm.com/docs/gitignore 3 | 4 | # Private files 5 | .env 6 | 7 | # System files 8 | *~ 9 | *# 10 | .DS_STORE 11 | Thumbs.db 12 | 13 | # IDEs & Text Editors 14 | .idea 15 | .sublime-* 16 | .vscode/settings.json 17 | .netbeans 18 | nbproject 19 | 20 | # Temporary files 21 | .tmp 22 | .temp 23 | .node_history 24 | .lock-wscript 25 | 26 | # Logs 27 | logs 28 | *.log 29 | 30 | # Runtime data 31 | pids 32 | *.pid 33 | *.seed 34 | 35 | # Dependencies 36 | node_modules 37 | 38 | # Build output 39 | /dist 40 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ![OpenAPI Logo](https://shipengine.github.io/img/openapi-logo.png) ShipEngine™ OpenAPI Definition 2 | ============================================== 3 | 4 | This repo contains the official [OpenAPI 3.0](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md) definitions for the [ShipEngine API](https://shipengine.com). You can use these definitions with any of countless [OpenAPI tools](https://openapi.tools/) to generate sample code, tests, mock servers, etc. 5 | 6 | 7 | Which file to use 8 | ----------------------------------- 9 | Depending on your preferences and/or tooling, you may choose to use one or more of the following files: 10 | 11 | |Path |Description 12 | |:-------------------|:-------------------------------- 13 | |[`openapi.yaml`](openapi.yaml) |The entire ShipEngine OpenAPI definition, in a single YAML file. This file uses [`$ref` pointers](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#reference-object) to reduce duplication and keep the file small and fairly human-readable.

Some [OpenAPI tools](https://openapi.tools/) don't support YAML or don't support `$ref` pointers, so you may need to use the [`openapi.json` file](openapi.json) instead. 14 | |[`openapi.json`](openapi.json) |The entire ShipEngine OpenAPI definition, in a single JSON file. This file **does not** contain any `$ref` pointers, which means it should work with any [OpenAPI tool](https://openapi.tools/). 15 | 16 | 17 | Other API Definition Formats 18 | ---------------------------- 19 | 20 | ### ![Redoc Logo](https://shipengine.github.io/img/redoc-logo-small.png) 21 | View the ShipEngine API definition [online in your browser](https://shipengine.github.io/shipengine-openapi/). This web page is generated from the [OpenAPI definition](https://github.com/ShipEngine/shipengine-openapi) using [ReDoc](https://github.com/Redocly/redoc). 22 | 23 | 24 | ### ![Postman Logo](https://shipengine.github.io/img/postman-logo-small.png) Postman 25 | The official [Postman reference collection](https://documenter.getpostman.com/view/305204/SW7W5V6o) for ShipEngine. Just import it into [Postman](https://getpostman.com) and immediately begin interacting with the ShipEngine API. 26 | 27 | 28 | New to ShipEngine? Download our [walkthrough collection instead](https://documenter.getpostman.com/view/305204/SW7XbA6V). 29 | 30 | 31 | ### ![JSON Schema Logo](https://shipengine.github.io/img/json-schema-logo-small.png) JSON Schema 32 | If you need to validate API requests and responses, then you may want to use [our JSON Schema definitions](https://github.com/ShipEngine/shipengine-json-schema). 33 | -------------------------------------------------------------------------------- /docs/img/favicon-16x16.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/b80d3e3d815ef4fc4364a59e0907ba75cde26ed9/docs/img/favicon-16x16.png -------------------------------------------------------------------------------- /docs/img/favicon-194x194.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/b80d3e3d815ef4fc4364a59e0907ba75cde26ed9/docs/img/favicon-194x194.png -------------------------------------------------------------------------------- /docs/img/favicon-32x32.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/b80d3e3d815ef4fc4364a59e0907ba75cde26ed9/docs/img/favicon-32x32.png -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "shipengine-openapi", 3 | "version": "1.20.0", 4 | "description": "The official OpenAPI 3.0 definitions for ShipEngine™", 5 | "main": "openapi.json", 6 | "repository": { 7 | "type": "git", 8 | "url": "git+https://github.com/ShipEngine/shipengine-openapi.git" 9 | }, 10 | "keywords": [ 11 | "openapi", 12 | "shipengine", 13 | "json", 14 | "yaml", 15 | "swagger" 16 | ], 17 | "files": [ 18 | "openapi.json", 19 | "openapi.yaml" 20 | ], 21 | "author": { 22 | "name": "ShipEngine", 23 | "email": "support@shipengine.com", 24 | "url": "https://shipengine.com" 25 | }, 26 | "license": "MIT" 27 | } --------------------------------------------------------------------------------