/
APIGatewayDocumentManagement.json
292 lines (292 loc) · 34.2 KB
/
APIGatewayDocumentManagement.json
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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
{
"swagger" : "2.0",
"info" : {
"description" : "API Gateway Document Management Service allows you to store/manage the Documents associated to API in the API Gateway. Any user with the 'Manage APIs' functional privilege can manage the documents in the API Gateway. By default, the users who are part of either API-Gateway-Providers or API-Gateway-Administrators groups will have this privilege.\n\nAny document can be stored and attached to any of these APIs types - REST APIs, SOAP APIs, WebSocket APIs and OData APIs. ",
"version" : "10.11",
"title" : "API Gateway Document Management Service"
},
"host" : "localhost:5555",
"basePath" : "/rest/apigateway",
"schemes" : [ "http" ],
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"paths" : {
"/documents" : {
"post" : {
"operationId" : "storeDocument",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The request payload to store the document in API Gateway.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/Document"
},
"x-examples" : {
"application/json" : "{\r\n\t\"displayName\": \"APIGatewayPortsInfoDocument\",\r\n\t\"fileName\": \"APIGatewayPorts.json\",\r\n\t\"fileContent\": \"data:;base64,{
  "swagger" : "2.0",
  "info" : {
    "description" : "This swagger doc contains API Definition of the ports CRUD operations.",
    "version" : "10.1",
    "title" : "Ports configurations."
  },
  "host" : "localhost:5555",
  "basePath" : "/rest/apigateway",
  "schemes" : [ "http" ],
  "consumes" : [ "plain/text" ],
  "produces" : [ "application/json" ],
  "paths" : {
    "/ports" : {
      "post" : {
        "operationId" : "createPort",
        "consumes" : [ "application/json" ],
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "in" : "body",
          "name" : "body",
          "description" : "port payload",
          "required" : true,
          "schema" : {
            "$ref" : "#/definitions/Port"
          }
        } ],
        "responses" : {
          "201" : {
            "description" : "Created",
            "schema" : {
              "$ref" : "#/definitions/Port"
            }
          },
          "400" : {
            "description" : "Bad request"
          },
          "401" : {
            "description" : "Access Denied"
          }
        },
        "security" : [ {
          "Basic" : [ ]
        } ]
      },
      "put" : {
        "operationId" : "updatePort",
        "consumes" : [ "application/json" ],
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "in" : "body",
          "name" : "body",
          "description" : "",
          "required" : true,
          "schema" : {
            "$ref" : "#/definitions/Port"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "",
            "schema" : {
              "$ref" : "#/definitions/Port"
            }
          },
          "500" : {
            "description" : ""
          },
          "401" : {
            "description" : ""
          },
          "400" : {
            "description" : ""
          }
        },
        "security" : [ {
          "Basic" : [ ]
        } ]
      },
      "delete" : {
        "operationId" : "deletePort",
        "consumes" : [ "application/json" ],
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "listenerKey",
          "in" : "query",
          "required" : true,
          "type" : "string",
          "x-example" : "HTTPListener@5555"
        }, {
          "name" : "pkg",
          "in" : "query",
          "required" : true,
          "type" : "string",
          "x-example" : "WmRoot"
        } ],
        "responses" : {
          "401" : {
            "description" : ""
          },
          "204" : {
            "description" : ""
          },
          "404" : {
            "description" : ""
          }
        },
        "security" : [ {
          "Basic" : [ ]
        } ]
      }
    },
    "/ports/enable" : {
      "put" : {
        "operationId" : "enablePort",
        "consumes" : [ "application/json" ],
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "in" : "body",
          "name" : "body",
          "description" : "",
          "required" : true,
          "schema" : {
            "$ref" : "#/definitions/PortEnableDisable"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "",
            "schema" : {
              "$ref" : "#/definitions/PortEnableDisable"
            }
          },
          "500" : {
            "description" : ""
          },
          "401" : {
            "description" : ""
          },
          "400" : {
            "description" : ""
          }
        },
        "security" : [ {
          "Basic" : [ ]
        } ]
      }
    },
    "/ports/disable" : {
      "put" : {
        "operationId" : "ddisablePort",
        "consumes" : [ "application/json" ],
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "in" : "body",
          "name" : "body",
          "description" : "",
          "required" : true,
          "schema" : {
            "$ref" : "#/definitions/PortEnableDisable"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "",
            "schema" : {
              "$ref" : "#/definitions/PortEnableDisable"
            }
          },
          "500" : {
            "description" : ""
          },
          "401" : {
            "description" : ""
          },
          "400" : {
            "description" : ""
          }
        },
        "security" : [ {
          "Basic" : [ ]
        } ]
      }
    }
  },
  "securityDefinitions" : {
    "Basic" : {
      "description" : "API Gateway Administrator and API Gateway provider",
      "type" : "basic"
    }
  },
  "definitions" : {
    "Port" : {
      "type" : "object",
      "properties" : {
        "port" : {
          "type" : "integer",
          "format" : "int32"
        },
        "protocol" : {
          "type" : "string"
        },
        "pkg" : {
          "type" : "string"
        },
        "enabled" : {
          "type" : "string"
        },
        "key" : {
          "type" : "string"
        },
        "uniqueID" : {
          "type" : "string"
        },
        "portAlias" : {
          "type" : "string"
        },
        "portDescription" : {
          "type" : "string"
        },
        "factoryKey" : {
          "type" : "string"
        },
        "configURL" : {
          "type" : "string"
        },
        "provider" : {
          "type" : "string"
        },
        "listenerType" : {
          "type" : "string"
        },
        "clientAuth" : {
          "type" : "string"
        },
        "idProvider" : {
          "type" : "object"
        },
        "ssl" : {
          "type" : "string"
        },
        "maxQueue" : {
          "type" : "string"
        },
        "keepAliveTimeout" : {
          "type" : "string"
        },
        "threadPool" : {
          "type" : "string"
        },
        "minThread" : {
          "type" : "string"
        },
        "maxThread" : {
          "type" : "string"
        },
        "threadPriority" : {
          "type" : "string"
        },
        "usedThreadCount" : {
          "type" : "string"
        },
        "internalPort" : {
          "type" : "string"
        },
        "curDelay" : {
          "type" : "string"
        },
        "stepsize" : {
          "type" : "string"
        },
        "suspended" : {
          "type" : "string"
        },
        "jsseEnabledProtocols" : {
          "type" : "object"
        },
        "status" : {
          "type" : "string"
        },
        "listening" : {
          "type" : "string"
        },
        "accessMode" : {
          "type" : "string"
        },
        "hasAccessList" : {
          "type" : "string"
        },
        "ipAccessMode" : {
          "type" : "string"
        },
        "hasIPAccessList" : {
          "type" : "string"
        }
      },
      "description" : "This defines the various fields that related to a particular port."
    },
    "PortEnableDisable" : {
      "type" : "object",
      "properties" : {
        "listenerKey" : {
          "type" : "string"
        },
        "pkg" : {
          "type" : "string"
        },
        "requestServiceStatus" : {
          "type" : "string"
        },
        "get$resourceID" : {
          "type" : "string"
        },
        "message" : {
          "type" : "string"
        }
      }
    }
  }
}\"\r\n}"
}
} ],
"responses" : {
"200" : {
"description" : "This status code indicates that the given document has been stored successfully in API Gateway.",
"examples" : {
"application/json" : "{\r\n\t\"id\": \"be9147a8-6e53-4472-b1bd-16337a84d314\"\r\n}"
},
"schema" : {
"$ref" : "#/definitions/DocumentResponse"
}
},
"400" : {
"description" : "This status code indicates invalid request or bad input."
},
"401" : {
"description" : "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API."
},
"404" : {
"description" : "This status code indicates that the requested resource is not found."
},
"405" : {
"description" : "This status code indicates that the requested HTTP method is not supported for the resource."
},
"500" : {
"description" : "This status code indicates an error occurred while storing the given document in API Gateway."
}
},
"security" : [ {
"Basic" : [ ]
} ]
}
},
"/documents/{documentId}" : {
"get" : {
"description" : "Retrieves the requested document from API Gateway",
"operationId" : "getDocument",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "documentId",
"in" : "path",
"description" : "The unique identifier of the document for retrieving from API Gateway.",
"required" : true,
"type" : "string",
"x-example" : "353bd366-47d4-4703-aecf-9cb40cdcc864"
} ],
"responses" : {
"200" : {
"description" : "This status code indicates that the given document has been retrieved successfully from API Gateway.",
"examples" : {
"application/json" : "{\r\n\t\"documents\": [{\r\n\t\t\"id\": \"c98c7290-bc68-4da3-a39e-545c714e75bc\",\r\n\t\t\"fileName\": \"SamplePowerpoint.pptx\",\r\n\t\t\"displayName\": \"How to upload documents to the store?\",\r\n\t\t\"fileContent\": \"data:application/vnd.openxmlformats-officedocument.presentationml.presentation;base64,UEsDBBQABgAIAAAAIQD93q/s6gEAAFIPAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAACAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAADMl990JrRLqv6+ONgR6nB3mzU7T/S6zeFFiF7yGWlYgyJtgnR813PvL8QsEZ/QW5+BJw0oMXXv4aH5oxlxCPLnIolA8a5hyjt9KsZloQZYhki/OENKCucg0qojmgSOpU1V9qrRlQLtjiqvVkK62BtGvsTT/zw7D4Aydg3ku5PObCsWzs3TDNTxzwWIaKWuQcnvnrahleR9U26jd3PYPAAD//wMAUEsDBBQABgAIAAAAIQBL9T3svwAAADcBAAAgAAAAcHB0L3NsaWRlcy9fcmVscy9zbGlkZTIueG1sLnJlbHOEj8EKwjAQRO+C/xD2blI9iEhTLyIInkQ/YEm2bbBNQjaK/XtzrCB4nB3mzU59eI+DeFFiF7yGtaxAkDfBOt9puN9Oqx0IzugtDsGThokYDs1yUV9pwFxC3LvIolA8a+hzjnul2PQ0IssQyRenDWnEXGTqVETzwI7Upqq2Ks0Z0HwxxdlqSGe7BnGbYmn+zw5t6wwdg3mO5POPCsWDs3TBKTxzwWLqKGuQcn7nudjI8j6oplZfc5sPAAAA//8DAFBLAwQUAAYACAAAACEAS/U97L8AAAA3AQAAIAAAAHBwdC9zbGlkZXMvX3JlbHMvc2xpZGUzLnhtbC5yZWxzhI/BCsIwEETvgv8Q9m5SPYhIUy8iCJ5EP2BJtm2wTUI2iv17c6wgeJwd5s1OfXiPg3hRYhe8hrWsQJA3wTrfabjfTqsdCM7oLQ7Bk4aJGA7NclFfacBcQty7yKJQPGvoc457pdj0NCLLEMkXpw1pxFxk6lRE88CO1KaqtirNGdB8McXZakhnuwZxm2Jp/s8ObesMHYN5juTzjwrFg7N0wSk8c8Fi6ihrkHJ+57nYyPI+qKZWX3ObDwAAAP//AwBQSwMEFAAGAAgAAAAhAEv1Pey/AAAANwEAACAAAABwcHQvc2xpZGVzL19yZWxzL3NsaWRlNS54bWwucmVsc4SPwQrCMBBE74L/EPZuUj2ISFMvIgieRDAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAALyVz06EMBDG7ya+A+ldCuw/NVv2Ykz2YGJ0fYAKAzSWtmnrKm9vw67Ibjb10nAhmaH95pePmWG9+W55tAdtmBQEpXGCIhCFLJmoCXrbPd7coshYKkrKpQKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooo\"\r\n\t}]\r\n}"
},
"schema" : {
"$ref" : "#/definitions/Document"
}
},
"400" : {
"description" : "This status code indicates invalid request or bad input."
},
"401" : {
"description" : "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API."
},
"404" : {
"description" : "This status code indicates that the requested resource is not found."
},
"405" : {
"description" : "This status code indicates that the requested HTTP method is not supported for the resource."
},
"500" : {
"description" : "This status code indicates an error occurred while retrieving the given document from API Gateway."
}
},
"security" : [ {
"Basic" : [ ]
} ]
},
"put" : {
"operationId" : "updateDocumentContent",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "documentId",
"in" : "path",
"description" : "The unique identifier of the document to update",
"required" : true,
"type" : "string",
"x-example" : "353bd366-47d4-4703-aecf-9cb40cdcc864"
}, {
"in" : "body",
"name" : "body",
"description" : "The request payload to update the document in API Gateway.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/Document"
},
"x-examples" : {
"application/json" : "{\r\n\t\"displayName\": \"APIGatewayPortsInfoDocumentUpdated\",\r\n\t\"fileName\": \"APIGatewayPorts.json\",\r\n\t\"fileContent\": \"data:;base64,{
  "swagger" : "2.0",
  "info" : {
    "description" : "This swagger doc contains API Definition of the ports CRUD operations.",
    "version" : "10.1",
    "title" : "Ports configurations."
  },
  "host" : "localhost:5555",
  "basePath" : "/rest/apigateway",
  "schemes" : [ "http" ],
  "consumes" : [ "plain/text" ],
  "produces" : [ "application/json" ],
  "paths" : {
    "/ports" : {
      "post" : {
        "operationId" : "createPort",
        "consumes" : [ "application/json" ],
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "in" : "body",
          "name" : "body",
          "description" : "port payload",
          "required" : true,
          "schema" : {
            "$ref" : "#/definitions/Port"
          }
        } ],
        "responses" : {
          "201" : {
            "description" : "Created",
            "schema" : {
              "$ref" : "#/definitions/Port"
            }
          },
          "400" : {
            "description" : "Bad request"
          },
          "401" : {
            "description" : "Access Denied"
          }
        },
        "security" : [ {
          "Basic" : [ ]
        } ]
      },
      "put" : {
        "operationId" : "updatePort",
        "consumes" : [ "application/json" ],
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "in" : "body",
          "name" : "body",
          "description" : "",
          "required" : true,
          "schema" : {
            "$ref" : "#/definitions/Port"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "",
            "schema" : {
              "$ref" : "#/definitions/Port"
            }
          },
          "500" : {
            "description" : ""
          },
          "401" : {
            "description" : ""
          },
          "400" : {
            "description" : ""
          }
        },
        "security" : [ {
          "Basic" : [ ]
        } ]
      },
      "delete" : {
        "operationId" : "deletePort",
        "consumes" : [ "application/json" ],
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "listenerKey",
          "in" : "query",
          "required" : true,
          "type" : "string",
          "x-example" : "HTTPListener@5555"
        }, {
          "name" : "pkg",
          "in" : "query",
          "required" : true,
          "type" : "string",
          "x-example" : "WmRoot"
        } ],
        "responses" : {
          "401" : {
            "description" : ""
          },
          "204" : {
            "description" : ""
          },
          "404" : {
            "description" : ""
          }
        },
        "security" : [ {
          "Basic" : [ ]
        } ]
      }
    },
    "/ports/enable" : {
      "put" : {
        "operationId" : "enablePort",
        "consumes" : [ "application/json" ],
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "in" : "body",
          "name" : "body",
          "description" : "",
          "required" : true,
          "schema" : {
            "$ref" : "#/definitions/PortEnableDisable"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "",
            "schema" : {
              "$ref" : "#/definitions/PortEnableDisable"
            }
          },
          "500" : {
            "description" : ""
          },
          "401" : {
            "description" : ""
          },
          "400" : {
            "description" : ""
          }
        },
        "security" : [ {
          "Basic" : [ ]
        } ]
      }
    },
    "/ports/disable" : {
      "put" : {
        "operationId" : "ddisablePort",
        "consumes" : [ "application/json" ],
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "in" : "body",
          "name" : "body",
          "description" : "",
          "required" : true,
          "schema" : {
            "$ref" : "#/definitions/PortEnableDisable"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "",
            "schema" : {
              "$ref" : "#/definitions/PortEnableDisable"
            }
          },
          "500" : {
            "description" : ""
          },
          "401" : {
            "description" : ""
          },
          "400" : {
            "description" : ""
          }
        },
        "security" : [ {
          "Basic" : [ ]
        } ]
      }
    }
  },
  "securityDefinitions" : {
    "Basic" : {
      "description" : "API Gateway Administrator and API Gateway provider",
      "type" : "basic"
    }
  },
  "definitions" : {
    "Port" : {
      "type" : "object",
      "properties" : {
        "port" : {
          "type" : "integer",
          "format" : "int32"
        },
        "protocol" : {
          "type" : "string"
        },
        "pkg" : {
          "type" : "string"
        },
        "enabled" : {
          "type" : "string"
        },
        "key" : {
          "type" : "string"
        },
        "uniqueID" : {
          "type" : "string"
        },
        "portAlias" : {
          "type" : "string"
        },
        "portDescription" : {
          "type" : "string"
        },
        "factoryKey" : {
          "type" : "string"
        },
        "configURL" : {
          "type" : "string"
        },
        "provider" : {
          "type" : "string"
        },
        "listenerType" : {
          "type" : "string"
        },
        "clientAuth" : {
          "type" : "string"
        },
        "idProvider" : {
          "type" : "object"
        },
        "ssl" : {
          "type" : "string"
        },
        "maxQueue" : {
          "type" : "string"
        },
        "keepAliveTimeout" : {
          "type" : "string"
        },
        "threadPool" : {
          "type" : "string"
        },
        "minThread" : {
          "type" : "string"
        },
        "maxThread" : {
          "type" : "string"
        },
        "threadPriority" : {
          "type" : "string"
        },
        "usedThreadCount" : {
          "type" : "string"
        },
        "internalPort" : {
          "type" : "string"
        },
        "curDelay" : {
          "type" : "string"
        },
        "stepsize" : {
          "type" : "string"
        },
        "suspended" : {
          "type" : "string"
        },
        "jsseEnabledProtocols" : {
          "type" : "object"
        },
        "status" : {
          "type" : "string"
        },
        "listening" : {
          "type" : "string"
        },
        "accessMode" : {
          "type" : "string"
        },
        "hasAccessList" : {
          "type" : "string"
        },
        "ipAccessMode" : {
          "type" : "string"
        },
        "hasIPAccessList" : {
          "type" : "string"
        }
      },
      "description" : "This defines the various fields that related to a particular port."
    },
    "PortEnableDisable" : {
      "type" : "object",
      "properties" : {
        "listenerKey" : {
          "type" : "string"
        },
        "pkg" : {
          "type" : "string"
        },
        "requestServiceStatus" : {
          "type" : "string"
        },
        "get$resourceID" : {
          "type" : "string"
        },
        "message" : {
          "type" : "string"
        }
      }
    }
  }
}\"\r\n}"
}
} ],
"responses" : {
"200" : {
"description" : "This status code indicates that the given document has been updated successfully in API Gateway.",
"examples" : {
"application/json" : "{\r\n\t\"id\": \"be9147a8-6e53-4472-b1bd-16337a84d314\"\r\n}"
},
"schema" : {
"$ref" : "#/definitions/DocumentResponse"
}
},
"400" : {
"description" : "This status code indicates invalid request or bad input."
},
"401" : {
"description" : "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API."
},
"404" : {
"description" : "This status code indicates that the requested resource is not found."
},
"405" : {
"description" : "This status code indicates that the requested HTTP method is not supported for the resource."
},
"500" : {
"description" : "This status code indicates an error occurred while updating the given document in API Gateway."
}
},
"security" : [ {
"Basic" : [ ]
} ]
},
"delete" : {
"description" : "Deletes the stored document from API Gateway",
"operationId" : "deleteDocument",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "documentId",
"in" : "path",
"description" : "Id of the document for deletion",
"required" : true,
"type" : "string",
"x-example" : "353bd366-47d4-4703-aecf-9cb40cdcc864"
} ],
"responses" : {
"200" : {
"description" : "This status code indicates that the given document has been deleted successfully from API Gateway."
},
"400" : {
"description" : "This status code indicates invalid request or bad input."
},
"401" : {
"description" : "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API."
},
"404" : {
"description" : "This status code indicates that the requested resource is not found."
},
"405" : {
"description" : "This status code indicates that the requested HTTP method is not supported for the resource."
},
"500" : {
"description" : "This status code indicates an error occurred while deleting the given document from API Gateway."
}
},
"security" : [ {
"Basic" : [ ]
} ]
},
"patch" : {
"operationId" : "patchDocument",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The request payload to patch the document in API Gateway.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/Document"
},
"x-examples" : {
"application/json" : "{\r\n\t\"displayName\": \"APIGatewayPortsInfoDocument Updated\"\r\n}"
}
}, {
"name" : "documentId",
"in" : "path",
"description" : "The unique identifier of the document to be patched.",
"required" : true,
"type" : "string",
"x-example" : "353bd366-47d4-4703-aecf-9cb40cdcc864"
} ],
"responses" : {
"200" : {
"description" : "This status code indicates that the given document has been patched successfully in API Gateway.",
"examples" : {
"application/json" : "{\r\n\t\"id\": \"be9147a8-6e53-4472-b1bd-16337a84d314\"\r\n}"
},
"schema" : {
"$ref" : "#/definitions/DocumentResponse"
}
},
"400" : {
"description" : "This status code indicates invalid request or bad input."
},
"401" : {
"description" : "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API."
},
"404" : {
"description" : "This status code indicates that the requested resource is not found."
},
"405" : {
"description" : "This status code indicates that the requested HTTP method is not supported for the resource."
},
"500" : {
"description" : "This status code indicates an error occurred while patching the given document in API Gateway."
}
},
"security" : [ {
"Basic" : [ ]
} ]
}
}
},
"securityDefinitions" : {
"Basic" : {
"description" : "API Gateway Administrator and API Gateway provider",
"type" : "basic"
}
},
"definitions" : {
"Document" : {
"type" : "object",
"properties" : {
"displayName" : {
"type" : "string",
"description" : "The display name of the attached document."
},
"fileContent" : {
"type" : "string",
"description" : "The complete file content in data URL format."
},
"fileName" : {
"type" : "string",
"description" : "The original name of the file uploaded to API Gateway."
},
"id" : {
"type" : "string",
"description" : "The unique identifier of the document as stored in API Gateway.",
"readOnly" : true
}
},
"description" : "This model is used to store any document in API Gateway."
},
"DocumentResponse" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "The unique identifier of the document as stored in API Gateway.",
"readOnly" : true
}
},
"description" : "This defines the response for documents."
}
}
}