carrier-specification/schema.json at develop · MyParcelCOM/carrier-specification · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
{
  "openapi": "3.1.0",
  "info": {
    "$ref": "./specification/info.json"
  },
  "servers": [
    {
      "url": "https://carrier.myparcel.com"
    }
  ],
  "paths": {
    "$ref": "./specification/paths.json"
  },
  "components": {
    "schemas": {
      "$ref": "./specification/schemas.json"
    },
    "parameters": {
      "$ref": "./specification/parameters.json"
    },
    "securitySchemes": {
      "secret": {
        "type": "apiKey",
        "name": "X-MYPARCELCOM-SECRET",
        "in": "header"
      },
      "credentials": {
        "type": "apiKey",
        "name": "X-MYPARCELCOM-CREDENTIALS",
        "in": "header"
      }
    }
  },
  "security": [
    {
      "secret": [],
      "credentials": []
    }
  ],
  "tags": {
    "$ref": "./specification/tags.json"
  },
  "externalDocs": {
    "url": "https://docs.myparcel.com/carrier-integration-program/",
    "description": "The documentation describing the MyParcel.com carrier integration process."
  }
}