github.com/go-swagger/go-swagger@v0.31.0/fixtures/bugs/2821/ServiceManagementBody.json (about) 1 { 2 "consumes": [ 3 "application/json" 4 ], 5 "produces": [ 6 "application/json" 7 ], 8 "schemes": [ 9 "http" 10 ], 11 "swagger": "2.0", 12 "info": { 13 "description": "API Gateway Service Management Service allows you to manage the APIs in the API Gateway. Any user with the 'Manage APIs' functional privilege can manage the APIs 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\nAPI Gateway supports four types of APIs - REST APIs, SOAP APIs, WebSocket APIs and OData APIs. REST APIs can be created by providing the swagger (file/url), openAPI (file/url), raml (file/url) or can be created from scratch. SOAP APIs can be created using the WSDL (file/url). If the API definitions has reference schemas, then an archive containing all the definitions can be provided as an input. WebSocket APIs can be created from scratch. OData APIs can be created using their service document or metadata document url.\n\nThis service provides you with the options to create, update, read and delete of all the above API types.\n\nAn API can either be in an Active or an InActive state. An Active state indicates that the API is available for consumers. The users can use this service to activate or deactivate the API. Post activation, API Gateway generates 'Gateway Endpoints' which can be used by the API consumers to access the API. Generally API consumers use their applications to consume the APIs.\n\nThis service can also be used to manage the API Scopes. An API Scope is a collection of resources or operations in the API. Users can create multiple scopes for a single API.\n\nOnce the API is created, users can enforce the access restrictions and other rules on the API by add the policies to the API. Policies can be attached to REST, SOAP and OData APIs. Refer to the Policy Management API documentation for more details on the policies. Refer to the Document Management API documentation for more details on attaching documents to an API.\n\nThis service can also be used to publish/unpublish the APIs to/from a service registry. An API in an active state can be registered (published) to one or more service registries.", 14 "title": "API Gateway Service Management Service", 15 "version": "10.7" 16 }, 17 "host": "localhost:5555", 18 "basePath": "/rest/apigateway", 19 "paths": { 20 "/apis": { 21 "get": { 22 "security": [ 23 { 24 "Basic": [] 25 } 26 ], 27 "description": "Get all APIs or subset of APIs", 28 "produces": [ 29 "application/json" 30 ], 31 "operationId": "getAPIs", 32 "parameters": [ 33 { 34 "type": "string", 35 "x-example": "353bd366-47d4-4703-aecf-9cb40cdcc864,353bd366-47d4-4703-aecf-9cb40cdcc345", 36 "description": "API Ids for the API to be retrieved", 37 "name": "apiIds", 38 "in": "query" 39 }, 40 { 41 "type": "integer", 42 "description": "Starting index from the list of APIs to be retrieved", 43 "name": "from", 44 "in": "query" 45 }, 46 { 47 "type": "integer", 48 "description": "Number of APIs to be retrieved", 49 "name": "size", 50 "in": "query" 51 } 52 ], 53 "responses": { 54 "200": { 55 "description": "Returns the list of all APIs", 56 "schema": { 57 "$ref": "#/definitions/APIResponsesModel" 58 }, 59 "examples": { 60 "application/json": "{\r\n \"apiResponse\": [\r\n {\r\n \"api\": {\r\n \"apiName\": \"ChuckNorrisAPI\",\r\n \"apiVersion\": \"v2\",\r\n \"apiDescription\": \"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\",\r\n \"isActive\": false,\r\n \"type\": \"REST\",\r\n \"publishedPortals\": [],\r\n \"systemVersion\": 2,\r\n \"id\": \"46df4227-a100-486c-9580-0bf388ec6ec7\"\r\n },\r\n \"responseStatus\": \"SUCCESS\"\r\n },\r\n {\r\n \"api\": {\r\n \"apiName\": \"ChuckNorrisAPI\",\r\n \"apiVersion\": \"1.0\",\r\n \"apiDescription\": \"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\",\r\n \"isActive\": false,\r\n \"type\": \"REST\",\r\n \"publishedPortals\": [],\r\n \"systemVersion\": 1,\r\n \"id\": \"25fb937a-8360-41ab-8be5-987b14fe631d\"\r\n },\r\n \"responseStatus\": \"SUCCESS\",\r\n \"teams\": [\r\n {\r\n \"id\": \"Administrators\",\r\n \"name\": \"Administrators\",\r\n \"canDelete\": \"false\"\r\n },\r\n {\r\n \"id\": \"Default\",\r\n \"name\": \"Default\",\r\n \"canDelete\": \"true\"\r\n }\r\n ]\r\n }\r\n ]\r\n}" 61 } 62 }, 63 "401": { 64 "description": "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API." 65 } 66 } 67 }, 68 "post": { 69 "security": [ 70 { 71 "Basic": [] 72 } 73 ], 74 "description": "This REST operation is used to create an API by importing a file, url or from scratch", 75 "consumes": [ 76 "application/json", 77 "multipart/form-data" 78 ], 79 "produces": [ 80 "application/json" 81 ], 82 "operationId": "createAPI", 83 "parameters": [ 84 { 85 "x-examples": { 86 "application/json": "{\r\n \"apiDefinition\": {\r\n \"type\": \"rest\",\r\n \"info\": {\r\n \"description\": \"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\",\r\n \"version\": \"1.0\",\r\n \"title\": \"ChuckNorrisAPI\"\r\n },\r\n \"host\": \"api.chucknorris.io\",\r\n \"basePath\": \"/jokes\",\r\n \"schemes\": [\r\n \"https\"\r\n ],\r\n \"security\": [],\r\n \"paths\": {\r\n \"/random\": {\r\n \"get\": {\r\n \"summary\": \"GET\",\r\n \"description\": \"\",\r\n \"operationId\": \"GET\",\r\n \"produces\": [\r\n \"application/json\"\r\n ],\r\n \"responses\": {},\r\n \"enabled\": true\r\n },\r\n \"enabled\": true\r\n }\r\n },\r\n \"securityDefinitions\": {},\r\n \"definitions\": {},\r\n \"baseUriParameters\": [],\r\n \"externalDocs\": [],\r\n \"servers\": [\r\n {\r\n \"url\": \"https://api.chucknorris.io/jokes\"\r\n }\r\n ],\r\n \"components\": {\r\n \"schemas\": {}\r\n }\r\n },\r\n \"nativeEndpoint\": [\r\n {\r\n \"passSecurityHeaders\": true,\r\n \"uri\": \"https://api.chucknorris.io/jokes\",\r\n \"connectionTimeoutDuration\": 0,\r\n \"alias\": false\r\n }\r\n ],\r\n \"apiName\": \"ChuckNorris\",\r\n \"apiVersion\": \"1.0\",\r\n \"apiDescription\": \"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\",\r\n \"maturityState\": \"Beta\",\r\n \"isActive\": false,\r\n \"type\": \"REST\",\r\n \"owner\": \"Administrator\",\r\n \"policies\": [\r\n \"08afbfa9-78e1-4c23-bb19-c0012464047e\"\r\n ],\r\n \"scopes\": [],\r\n \"publishedPortals\": [],\r\n \"creationDate\": \"2018-09-03 11:56:21 GMT\",\r\n \"systemVersion\": 1,\r\n \"id\": \"badc18e6-446f-4aa3-96cd-33e46bd40fb5\",\r\n \r\n\t\"teams\": [\r\n\t\t{\r\n\t\t\t\"id\": \"Default\"\r\n\t\t}\r\n\t]\r\n }" 87 }, 88 "description": "API request payload", 89 "name": "body", 90 "in": "body", 91 "required": true, 92 "schema": { 93 "$ref": "#/definitions/InputAPI" 94 } 95 } 96 ], 97 "responses": { 98 "200": { 99 "description": "Returns the created API object", 100 "schema": { 101 "$ref": "#/definitions/APIResponseCreate" 102 }, 103 "examples": { 104 "application/json": "{\r\n \"apiResponse\": {\r\n \"api\": {\r\n \"apiDefinition\": {\r\n \"type\": \"rest\",\r\n \"info\": {\r\n \"description\": \"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\",\r\n \"version\": \"1.0\",\r\n \"title\": \"ChuckNorrisAPI\"\r\n },\r\n \"host\": \"api.chucknorris.io\",\r\n \"basePath\": \"/jokes\",\r\n \"schemes\": [\r\n \"https\"\r\n ],\r\n \"security\": [],\r\n \"paths\": {\r\n \"/random\": {\r\n \"get\": {\r\n \"summary\": \"GET\",\r\n \"description\": \"\",\r\n \"operationId\": \"GET\",\r\n \"produces\": [\r\n \"application/json\"\r\n ],\r\n \"responses\": {},\r\n \"enabled\": true\r\n },\r\n \"enabled\": true\r\n }\r\n },\r\n \"securityDefinitions\": {},\r\n \"definitions\": {},\r\n \"baseUriParameters\": [],\r\n \"externalDocs\": [],\r\n \"servers\": [\r\n {\r\n \"url\": \"https://api.chucknorris.io/jokes\"\r\n }\r\n ],\r\n \"components\": {\r\n \"schemas\": {}\r\n }\r\n },\r\n \"nativeEndpoint\": [\r\n {\r\n \"passSecurityHeaders\": true,\r\n \"uri\": \"https://api.chucknorris.io/jokes\",\r\n \"connectionTimeoutDuration\": 0,\r\n \"alias\": false\r\n }\r\n ],\r\n \"apiName\": \"ChuckNorris\",\r\n \"apiVersion\": \"1.0\",\r\n \"apiDescription\": \"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\",\r\n \"maturityState\": \"Beta\",\r\n \"isActive\": false,\r\n \"type\": \"REST\",\r\n \"owner\": \"Administrator\",\r\n \"policies\": [\r\n \"08afbfa9-78e1-4c23-bb19-c0012464047e\"\r\n ],\r\n \"scopes\": [],\r\n \"publishedPortals\": [],\r\n \"creationDate\": \"2018-09-03 11:56:21 GMT\",\r\n \"systemVersion\": 1,\r\n \"id\": \"badc18e6-446f-4aa3-96cd-33e46bd40fb5\"\r\n },\r\n \"responseStatus\": \"SUCCESS\",\r\n \"versions\": [\r\n {\r\n \"versionNumber\": \"1.0\",\r\n \"apiId\": \"badc18e6-446f-4aa3-96cd-33e46bd40fb5\"\r\n }\r\n ],\r\n \"teams\": [\r\n {\r\n \"id\": \"Administrators\",\r\n \"name\": \"Administrators\",\r\n \"canDelete\": \"false\"\r\n },\r\n {\r\n \"id\": \"Default\",\r\n \"name\": \"Default\",\r\n \"canDelete\": \"true\"\r\n }\r\n ] }\r\n}" 105 } 106 }, 107 "400": { 108 "description": "This status code shows when the user missed the mandatory fields like type, file/url/apiDefinition in the request or provide a invalid request body" 109 }, 110 "401": { 111 "description": "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API." 112 } 113 } 114 }, 115 "delete": { 116 "security": [ 117 { 118 "Basic": [] 119 } 120 ], 121 "description": "Delete the inactive APIs", 122 "produces": [ 123 "application/json" 124 ], 125 "operationId": "deleteAPIs", 126 "parameters": [ 127 { 128 "type": "string", 129 "x-example": "353bd366-47d4-4703-aecf-9cb40cdcc864,353bd366-47d4-4703-aecf-9cb40cdcc854", 130 "description": "API Ids for the APIs to be deleted. Multiple API ids combined by comma", 131 "name": "apiIds", 132 "in": "query", 133 "required": true 134 }, 135 { 136 "type": "boolean", 137 "default": true, 138 "x-example": true, 139 "description": "Flag for force delete. Required when API is associated with some applications", 140 "name": "forceDelete", 141 "in": "query" 142 } 143 ], 144 "responses": { 145 "200": { 146 "description": "Returns the apiId along with the error when unsuccessful", 147 "schema": { 148 "type": "array", 149 "items": { 150 "$ref": "#/definitions/APIResponseDelete" 151 } 152 } 153 }, 154 "204": { 155 "description": "Success" 156 }, 157 "400": { 158 "description": "This response code returns when the mandatory parameter apiIds is missing in the query parameter" 159 }, 160 "401": { 161 "description": "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API." 162 } 163 } 164 } 165 }, 166 "/apis/{apiId}": { 167 "get": { 168 "security": [ 169 { 170 "Basic": [] 171 } 172 ], 173 "description": "Retrieve an API based on the API id.", 174 "produces": [ 175 "application/json" 176 ], 177 "operationId": "getAPI", 178 "parameters": [ 179 { 180 "type": "string", 181 "x-example": "353bd366-47d4-4703-aecf-9cb40cdcc864", 182 "description": "API Id for the API to be retrieved", 183 "name": "apiId", 184 "in": "path", 185 "required": true 186 }, 187 { 188 "type": "string", 189 "x-example": "raml", 190 "description": "Output format of the API. If the value is 'swagger', you get a API definition in swagger format. If the value is 'raml', you get a raml document. If the value is 'openapi', you get a open API document. If the value is 'odata', you get a zip file holding the OData metadata and service document.", 191 "name": "format", 192 "in": "query" 193 }, 194 { 195 "type": "string", 196 "x-example": "http://hostname:5555/gateway/servicename/1.0", 197 "description": "User selected endpoint for API definition in swagger/raml format.", 198 "name": "url", 199 "in": "query" 200 } 201 ], 202 "responses": { 203 "200": { 204 "description": "If the format is swagger, returns the swagger content in json and raml returns the raml content in yaml. If the format is openapi, returns the open api content in json. If the format is odata, you get a zip file holding the OData metadata and service document.", 205 "schema": { 206 "$ref": "#/definitions/APIResponseGetAPI" 207 }, 208 "examples": { 209 "application/json": "{\r\n \"apiResponse\": {\r\n \"api\": {\r\n \"apiDefinition\": {\r\n \"type\": \"rest\",\r\n \"info\": {\r\n \"description\": \"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\",\r\n \"version\": \"1.0\",\r\n \"title\": \"ChuckNorrisAPI\"\r\n },\r\n \"host\": \"api.chucknorris.io\",\r\n \"basePath\": \"/jokes\",\r\n \"schemes\": [\r\n \"https\"\r\n ],\r\n \"security\": [],\r\n \"paths\": {\r\n \"/random\": {\r\n \"get\": {\r\n \"summary\": \"GET\",\r\n \"description\": \"\",\r\n \"operationId\": \"GET\",\r\n \"produces\": [\r\n \"application/json\"\r\n ],\r\n \"responses\": {},\r\n \"enabled\": true\r\n },\r\n \"enabled\": true\r\n }\r\n },\r\n \"securityDefinitions\": {},\r\n \"definitions\": {},\r\n \"baseUriParameters\": [],\r\n \"externalDocs\": [],\r\n \"servers\": [\r\n {\r\n \"url\": \"https://api.chucknorris.io/jokes\"\r\n }\r\n ],\r\n \"components\": {\r\n \"schemas\": {}\r\n }\r\n },\r\n \"nativeEndpoint\": [\r\n {\r\n \"passSecurityHeaders\": true,\r\n \"uri\": \"https://api.chucknorris.io/jokes\",\r\n \"connectionTimeoutDuration\": 0,\r\n \"alias\": false\r\n }\r\n ],\r\n \"apiName\": \"ChuckNorris\",\r\n \"apiVersion\": \"1.0\",\r\n \"apiDescription\": \"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\",\r\n \"maturityState\": \"Beta\",\r\n \"isActive\": false,\r\n \"type\": \"REST\",\r\n \"owner\": \"Administrator\",\r\n \"policies\": [\r\n \"08afbfa9-78e1-4c23-bb19-c0012464047e\"\r\n ],\r\n \"scopes\": [],\r\n \"publishedPortals\": [],\r\n \"creationDate\": \"2018-09-03 11:56:21 GMT\",\r\n \"systemVersion\": 1,\r\n \"id\": \"badc18e6-446f-4aa3-96cd-33e46bd40fb5\"\r\n },\r\n \"responseStatus\": \"SUCCESS\",\r\n \"versions\": [\r\n {\r\n \"versionNumber\": \"1.0\",\r\n \"apiId\": \"badc18e6-446f-4aa3-96cd-33e46bd40fb5\"\r\n \r\n }\r\n ],\r\n \"teams\": [\r\n {\r\n \"id\": \"Administrators\",\r\n \"name\": \"Administrators\",\r\n \"canDelete\": \"false\"\r\n },\r\n {\r\n \"id\": \"Default\",\r\n \"name\": \"Default\",\r\n \"canDelete\": \"true\"\r\n }\r\n ] }\r\n}" 210 } 211 }, 212 "401": { 213 "description": "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API." 214 }, 215 "404": { 216 "description": "This status code indicates that the apiId specified is not found in the API Gateway" 217 } 218 } 219 }, 220 "put": { 221 "security": [ 222 { 223 "Basic": [] 224 } 225 ], 226 "description": "This REST operation is used to update an API by importing a file, url or inline.\n\nWhile updating the API, visibility of the operations can be set by enabling or disabling the operations. Disabled operations will not be exposed to the customers. By default, all the operations are exposed to the consumers.\n\nWhen updating the API using file or url, API Gateway overwrite the resources/operations for the API. But it will retain the maturity state, scopes, visibility and if API mocking is enabled, then default mocked responses, mocked conditions and IS services will also be retained.", 227 "consumes": [ 228 "application/json", 229 "multipart/form-data" 230 ], 231 "produces": [ 232 "application/json" 233 ], 234 "operationId": "updateAPI", 235 "parameters": [ 236 { 237 "type": "string", 238 "x-example": "353bd366-47d4-4703-aecf-9cb40cdcc864", 239 "description": "API Id for the API to be updated", 240 "name": "apiId", 241 "in": "path", 242 "required": true 243 }, 244 { 245 "type": "boolean", 246 "default": false, 247 "x-example": true, 248 "description": "When an API is updated using a URL / file, the existing tags will be overwritten if this value is true.", 249 "name": "overwriteTags", 250 "in": "query" 251 }, 252 { 253 "x-examples": { 254 "application/json": "{\r\n \"apiDefinition\": {\r\n \"type\": \"rest\",\r\n \"info\": {\r\n \"description\": \"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\",\r\n \"version\": \"1.0\",\r\n \"title\": \"ChuckNorrisAPI\"\r\n },\r\n \"host\": \"api.chucknorris.io\",\r\n \"basePath\": \"/jokes\",\r\n \"schemes\": [\r\n \"https\"\r\n ],\r\n \"security\": [],\r\n \"paths\": {\r\n \"/random\": {\r\n \"get\": {\r\n \"summary\": \"GET\",\r\n \"description\": \"\",\r\n \"operationId\": \"GET\",\r\n \"produces\": [\r\n \"application/json\"\r\n ],\r\n \"responses\": {},\r\n \"enabled\": true\r\n },\r\n \"enabled\": true\r\n }\r\n },\r\n \"securityDefinitions\": {},\r\n \"definitions\": {},\r\n \"baseUriParameters\": [],\r\n \"externalDocs\": [],\r\n \"servers\": [\r\n {\r\n \"url\": \"https://api.chucknorris.io/jokes\"\r\n }\r\n ],\r\n \"components\": {\r\n \"schemas\": {}\r\n }\r\n },\r\n \"nativeEndpoint\": [\r\n {\r\n \"passSecurityHeaders\": true,\r\n \"uri\": \"https://api.chucknorris.io/jokes\",\r\n \"connectionTimeoutDuration\": 0,\r\n \"alias\": false\r\n }\r\n ],\r\n \"apiName\": \"ChuckNorris\",\r\n \"apiVersion\": \"1.0\",\r\n \"apiDescription\": \"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\",\r\n \"maturityState\": \"Beta\",\r\n \"isActive\": false,\r\n \"type\": \"REST\",\r\n \"owner\": \"Administrator\",\r\n \"policies\": [\r\n \"08afbfa9-78e1-4c23-bb19-c0012464047e\"\r\n ],\r\n \"scopes\": [],\r\n \"publishedPortals\": [],\r\n \"creationDate\": \"2018-09-03 11:56:21 GMT\",\r\n \"systemVersion\": 1,\r\n \"id\": \"badc18e6-446f-4aa3-96cd-33e46bd40fb5\"\r\n }" 255 }, 256 "description": "API request payload", 257 "name": "body", 258 "in": "body", 259 "required": true, 260 "schema": { 261 "$ref": "#/definitions/GatewayAPI" 262 } 263 } 264 ], 265 "responses": { 266 "200": { 267 "description": "Returns the updated API object", 268 "schema": { 269 "$ref": "#/definitions/APIResponseCreate" 270 }, 271 "examples": { 272 "application/json": "{\r\n \"apiResponse\": {\r\n \"api\": {\r\n \"apiDefinition\": {\r\n \"type\": \"rest\",\r\n \"info\": {\r\n \"description\": \"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\",\r\n \"version\": \"1.0\",\r\n \"title\": \"ChuckNorrisAPI\"\r\n },\r\n \"host\": \"api.chucknorris.io\",\r\n \"basePath\": \"/jokes\",\r\n \"schemes\": [\r\n \"https\"\r\n ],\r\n \"security\": [],\r\n \"paths\": {\r\n \"/random\": {\r\n \"get\": {\r\n \"summary\": \"GET\",\r\n \"description\": \"\",\r\n \"operationId\": \"GET\",\r\n \"produces\": [\r\n \"application/json\"\r\n ],\r\n \"responses\": {},\r\n \"enabled\": true\r\n },\r\n \"enabled\": true\r\n }\r\n },\r\n \"securityDefinitions\": {},\r\n \"definitions\": {},\r\n \"baseUriParameters\": [],\r\n \"externalDocs\": [],\r\n \"servers\": [\r\n {\r\n \"url\": \"https://api.chucknorris.io/jokes\"\r\n }\r\n ],\r\n \"components\": {\r\n \"schemas\": {}\r\n }\r\n },\r\n \"nativeEndpoint\": [\r\n {\r\n \"passSecurityHeaders\": true,\r\n \"uri\": \"https://api.chucknorris.io/jokes\",\r\n \"connectionTimeoutDuration\": 0,\r\n \"alias\": false\r\n }\r\n ],\r\n \"apiName\": \"ChuckNorris\",\r\n \"apiVersion\": \"1.0\",\r\n \"apiDescription\": \"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\",\r\n \"maturityState\": \"Beta\",\r\n \"isActive\": false,\r\n \"type\": \"REST\",\r\n \"owner\": \"Administrator\",\r\n \"policies\": [\r\n \"08afbfa9-78e1-4c23-bb19-c0012464047e\"\r\n ],\r\n \"scopes\": [],\r\n \"publishedPortals\": [],\r\n \"creationDate\": \"2018-09-03 11:56:21 GMT\",\r\n \"systemVersion\": 1,\r\n \"id\": \"badc18e6-446f-4aa3-96cd-33e46bd40fb5\"\r\n },\r\n \"responseStatus\": \"SUCCESS\",\r\n \"versions\": [\r\n {\r\n \"versionNumber\": \"1.0\",\r\n \"apiId\": \"badc18e6-446f-4aa3-96cd-33e46bd40fb5\"\r\n }\r\n ]\r\n }\r\n}" 273 } 274 }, 275 "400": { 276 "description": "This status code shows when the user missed the mandatory fields like type, file/url/apiDefinition in the request or provide a invalid request body" 277 }, 278 "401": { 279 "description": "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API." 280 }, 281 "404": { 282 "description": "This status code indicates that the apiId specified is not found in the API Gateway" 283 } 284 } 285 }, 286 "delete": { 287 "security": [ 288 { 289 "Basic": [] 290 } 291 ], 292 "description": "Delete the inactive API", 293 "operationId": "deleteAPI", 294 "parameters": [ 295 { 296 "type": "string", 297 "x-example": "353bd366-47d4-4703-aecf-9cb40cdcc864", 298 "description": "API Id for the API to be deleted", 299 "name": "apiId", 300 "in": "path", 301 "required": true 302 }, 303 { 304 "type": "boolean", 305 "default": true, 306 "x-example": true, 307 "description": "Flag for force delete. Required when API is associated with some applications", 308 "name": "forceDelete", 309 "in": "query" 310 } 311 ], 312 "responses": { 313 "200": { 314 "description": "Returns the apiId along with the error when unsuccessful", 315 "schema": { 316 "$ref": "#/definitions/APIResponseDelete" 317 } 318 }, 319 "204": { 320 "description": "Success" 321 }, 322 "400": { 323 "description": "This response code returns when the deleted API is published to API portal or in active state" 324 }, 325 "401": { 326 "description": "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API" 327 }, 328 "404": { 329 "description": "This status code indicates that the apiId specified is not found in the API Gateway" 330 } 331 } 332 } 333 }, 334 "/apis/{apiId}/activate": { 335 "put": { 336 "security": [ 337 { 338 "Basic": [] 339 } 340 ], 341 "description": "Activate an API so that API is exposed to consumers", 342 "produces": [ 343 "application/json" 344 ], 345 "operationId": "activateAPI", 346 "parameters": [ 347 { 348 "type": "string", 349 "x-example": "353bd366-47d4-4703-aecf-9cb40cdcc864", 350 "description": "API Id for the API to be activated", 351 "name": "apiId", 352 "in": "path", 353 "required": true 354 } 355 ], 356 "responses": { 357 "200": { 358 "description": "Returns the API object after successful activation", 359 "schema": { 360 "$ref": "#/definitions/APIResponse" 361 }, 362 "examples": { 363 "application/json": "{\r\n \"apiResponse\": {\r\n \"api\": {\r\n \"apiDefinition\": {\r\n \"type\": \"rest\",\r\n \"info\": {\r\n \"description\": \"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\",\r\n \"version\": \"1.0\",\r\n \"title\": \"ChuckNorrisAPI\"\r\n },\r\n \"host\": \"api.chucknorris.io\",\r\n \"basePath\": \"/jokes\",\r\n \"schemes\": [\r\n \"https\"\r\n ],\r\n \"security\": [],\r\n \"paths\": {\r\n \"/random\": {\r\n \"get\": {\r\n \"summary\": \"GET\",\r\n \"description\": \"\",\r\n \"operationId\": \"GET\",\r\n \"produces\": [\r\n \"application/json\"\r\n ],\r\n \"responses\": {},\r\n \"enabled\": true\r\n },\r\n \"enabled\": true\r\n }\r\n },\r\n \"securityDefinitions\": {},\r\n \"definitions\": {},\r\n \"baseUriParameters\": [],\r\n \"externalDocs\": [],\r\n \"servers\": [\r\n {\r\n \"url\": \"https://api.chucknorris.io/jokes\"\r\n }\r\n ],\r\n \"components\": {\r\n \"schemas\": {}\r\n }\r\n },\r\n \"nativeEndpoint\": [\r\n {\r\n \"passSecurityHeaders\": true,\r\n \"uri\": \"https://api.chucknorris.io/jokes\",\r\n \"connectionTimeoutDuration\": 0,\r\n \"alias\": false\r\n }\r\n ],\r\n \"apiName\": \"ChuckNorris\",\r\n \"apiVersion\": \"1.0\",\r\n \"apiDescription\": \"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\",\r\n \"maturityState\": \"Beta\",\r\n \"isActive\": false,\r\n \"type\": \"REST\",\r\n \"owner\": \"Administrator\",\r\n \"policies\": [\r\n \"08afbfa9-78e1-4c23-bb19-c0012464047e\"\r\n ],\r\n \"scopes\": [],\r\n \"publishedPortals\": [],\r\n \"creationDate\": \"2018-09-03 11:56:21 GMT\",\r\n \"systemVersion\": 1,\r\n \"id\": \"badc18e6-446f-4aa3-96cd-33e46bd40fb5\"\r\n },\r\n \"responseStatus\": \"SUCCESS\",\r\n \"versions\": [\r\n {\r\n \"versionNumber\": \"1.0\",\r\n \"apiId\": \"badc18e6-446f-4aa3-96cd-33e46bd40fb5\"\r\n }\r\n ]\r\n }\r\n}" 364 } 365 }, 366 "400": { 367 "description": "This status code shows when the API is already in activated state or when no operations/resources are present or none are enabled" 368 }, 369 "401": { 370 "description": "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API." 371 }, 372 "404": { 373 "description": "This status code indicates that the apiId specified is not found in the API Gateway" 374 } 375 } 376 } 377 }, 378 "/apis/{apiId}/applications": { 379 "get": { 380 "security": [ 381 { 382 "Basic": [] 383 } 384 ], 385 "description": "Retrieves the list of registered applications of an API", 386 "produces": [ 387 "application/json" 388 ], 389 "operationId": "getApplications", 390 "parameters": [ 391 { 392 "type": "string", 393 "x-example": "353bd366-47d4-4703-aecf-9cb40cdcc864", 394 "description": "API Id for the API to find the associated applications", 395 "name": "apiId", 396 "in": "path", 397 "required": true 398 } 399 ], 400 "responses": { 401 "200": { 402 "description": "Returns the list of associated applications", 403 "schema": { 404 "type": "array", 405 "items": { 406 "$ref": "#/definitions/Application" 407 } 408 }, 409 "examples": { 410 "application/json": "{\r\n \"applications\": [\r\n {\r\n \"name\": \"app1\",\r\n \"description\": null,\r\n \"contactEmails\": [],\r\n \"identifiers\": [],\r\n \"siteURLs\": [],\r\n \"version\": \"1.0\",\r\n \"id\": \"ae48cd69-421e-4bdf-a4d0-e86996a78f68\",\r\n \"created\": \"2017-03-13 13:12:03 GMT\",\r\n \"lastupdated\": null,\r\n \"consumingAPIs\": [\r\n \"25fb937a-8360-41ab-8be5-987b14fe631d\"\r\n ],\r\n \"accessTokens\": {\r\n \"apiAccessKey_credentials\": {\r\n \"apiAccessKey\": \"cec4b46b-3569-4f73-a561-172dd67c182a\",\r\n \"expirationInterval\": null\r\n },\r\n \"oauth_credentials\": {\r\n \"clientID\": \"40b78ed3-d171-4bd3-99db-51dd2fa71753\",\r\n \"clientSecret\": \"024b9525-6526-45c8-a66c-d192442064e1\",\r\n \"clientName\": \"app1-6b753c2a-0567-462d-a4ea-1b143ab7a381\",\r\n \"scopes\": [\r\n \"25fb937a-8360-41ab-8be5-987b14fe631d\"\r\n ],\r\n \"token_lifetime\": \"3600\",\r\n \"token_refresh_limit\": \"0\",\r\n \"redirect_uris\": [\r\n \"https://placeholder_redirect_uri\"\r\n ],\r\n \"Type\": \"confidential\"\r\n }\r\n }\r\n }\r\n ]\r\n}" 411 } 412 }, 413 "401": { 414 "description": "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API." 415 }, 416 "404": { 417 "description": "This status code indicates that the apiId specified is not found in the API Gateway" 418 } 419 } 420 } 421 }, 422 "/apis/{apiId}/deactivate": { 423 "put": { 424 "security": [ 425 { 426 "Basic": [] 427 } 428 ], 429 "description": "Deactivate an API so that API is not exposed to consumers", 430 "produces": [ 431 "application/json" 432 ], 433 "operationId": "deactivateAPI", 434 "parameters": [ 435 { 436 "type": "string", 437 "x-example": "353bd366-47d4-4703-aecf-9cb40cdcc864", 438 "description": "API Id for the API to be deactivated", 439 "name": "apiId", 440 "in": "path", 441 "required": true 442 } 443 ], 444 "responses": { 445 "200": { 446 "description": "Returns the API object after successful deactivation", 447 "schema": { 448 "$ref": "#/definitions/APIResponse" 449 }, 450 "examples": { 451 "application/json": "{\r\n \"apiResponse\": {\r\n \"api\": {\r\n \"apiDefinition\": {\r\n \"type\": \"rest\",\r\n \"info\": {\r\n \"description\": \"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\",\r\n \"version\": \"1.0\",\r\n \"title\": \"ChuckNorrisAPI\"\r\n },\r\n \"host\": \"api.chucknorris.io\",\r\n \"basePath\": \"/jokes\",\r\n \"schemes\": [\r\n \"https\"\r\n ],\r\n \"security\": [],\r\n \"paths\": {\r\n \"/random\": {\r\n \"get\": {\r\n \"summary\": \"GET\",\r\n \"description\": \"\",\r\n \"operationId\": \"GET\",\r\n \"produces\": [\r\n \"application/json\"\r\n ],\r\n \"responses\": {},\r\n \"enabled\": true\r\n },\r\n \"enabled\": true\r\n }\r\n },\r\n \"securityDefinitions\": {},\r\n \"definitions\": {},\r\n \"baseUriParameters\": [],\r\n \"externalDocs\": [],\r\n \"servers\": [\r\n {\r\n \"url\": \"https://api.chucknorris.io/jokes\"\r\n }\r\n ],\r\n \"components\": {\r\n \"schemas\": {}\r\n }\r\n },\r\n \"nativeEndpoint\": [\r\n {\r\n \"passSecurityHeaders\": true,\r\n \"uri\": \"https://api.chucknorris.io/jokes\",\r\n \"connectionTimeoutDuration\": 0,\r\n \"alias\": false\r\n }\r\n ],\r\n \"apiName\": \"ChuckNorris\",\r\n \"apiVersion\": \"1.0\",\r\n \"apiDescription\": \"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\",\r\n \"maturityState\": \"Beta\",\r\n \"isActive\": false,\r\n \"type\": \"REST\",\r\n \"owner\": \"Administrator\",\r\n \"policies\": [\r\n \"08afbfa9-78e1-4c23-bb19-c0012464047e\"\r\n ],\r\n \"scopes\": [],\r\n \"publishedPortals\": [],\r\n \"creationDate\": \"2018-09-03 11:56:21 GMT\",\r\n \"systemVersion\": 1,\r\n \"id\": \"badc18e6-446f-4aa3-96cd-33e46bd40fb5\"\r\n },\r\n \"responseStatus\": \"SUCCESS\",\r\n \"versions\": [\r\n {\r\n \"versionNumber\": \"1.0\",\r\n \"apiId\": \"badc18e6-446f-4aa3-96cd-33e46bd40fb5\"\r\n }\r\n ]\r\n }\r\n}" 452 } 453 }, 454 "400": { 455 "description": "This status code shows when the API is already in de-activated state" 456 }, 457 "401": { 458 "description": "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API." 459 }, 460 "404": { 461 "description": "This status code indicates that the apiId specified is not found in the API Gateway" 462 } 463 } 464 } 465 }, 466 "/apis/{apiId}/gatewayEndpoints": { 467 "put": { 468 "security": [ 469 { 470 "Basic": [] 471 } 472 ], 473 "description": "This operation can be used to create / update / delete a custom gateway endpoing of an API", 474 "consumes": [ 475 "application/json" 476 ], 477 "produces": [ 478 "application/json" 479 ], 480 "operationId": "gatewayEndpoints", 481 "parameters": [ 482 { 483 "type": "string", 484 "x-example": "353bd366-47d4-4703-aecf-9cb40cdcc864", 485 "description": "API Id for the API to be updated", 486 "name": "apiId", 487 "in": "path", 488 "required": true 489 }, 490 { 491 "x-examples": { 492 "application/json": "{\r\n\t \"gatewayEndpoints\": {\r\n\t \"add\": { \r\n\t \"endpointName\" : \"name\", \r\n\t \"gatewayEndpoint\":\"/prefix/${apiName}/${apiVersion}\" \r\n\t },\r\n\t \"update\": { \r\n\t \"oldEndpointName\" : \"oldName\", \r\n\t \"newEndpointName\" : \"newName\", \r\n\t \"gatewayEndpoint\" :\"/newPrefix/chocolateApi/${apiVersion}\" \r\n\t },\r\n\t \"remove\": { \r\n\t \"endpointName\":\"nameOfAnExistingEndpoint\"\r\n\t }\r\n\t }\r\n\t }" 493 }, 494 "description": "API Gateway endpoints request payload", 495 "name": "body", 496 "in": "body", 497 "required": true, 498 "schema": { 499 "$ref": "#/definitions/InputGatewayEndpoints" 500 } 501 } 502 ], 503 "responses": { 504 "200": { 505 "description": "Returns status of the operation along with request payload", 506 "schema": { 507 "$ref": "#/definitions/APIResponse" 508 } 509 }, 510 "400": { 511 "description": "This status code shows when the user provide an invalid request body" 512 }, 513 "401": { 514 "description": "" 515 }, 516 "404": { 517 "description": "This status code indicates that the apiId specified is not found in the API Gateway" 518 } 519 } 520 } 521 }, 522 "/apis/{apiId}/globalPolicies": { 523 "get": { 524 "security": [ 525 { 526 "Basic": [] 527 } 528 ], 529 "description": "Retrieves the list of active global policies applicable to this API", 530 "produces": [ 531 "application/json" 532 ], 533 "operationId": "getAssociatedGlobalPolicies", 534 "parameters": [ 535 { 536 "type": "string", 537 "x-example": "353bd366-47d4-4703-aecf-9cb40cdcc864", 538 "description": "API Id for the API to find the list of applicable global policies", 539 "name": "apiId", 540 "in": "path", 541 "required": true 542 } 543 ], 544 "responses": { 545 "200": { 546 "description": "Returns the list of global policy names", 547 "schema": { 548 "$ref": "#/definitions/APIResponseGetGlobalPolicies" 549 }, 550 "examples": { 551 "application/json": "{\r\n \"globalPolicies\": [\r\n \"GlobalLogInvocationPolicy\"\r\n ]\r\n}" 552 } 553 }, 554 "401": { 555 "description": "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API." 556 }, 557 "404": { 558 "description": "This status code indicates that the apiId specified is not found in the API Gateway" 559 } 560 } 561 } 562 }, 563 "/apis/{apiId}/implementation": { 564 "put": { 565 "security": [ 566 { 567 "Basic": [] 568 } 569 ], 570 "description": "This operation can be used to update an API with its implementation endpoints details and optionally the corresponding maturity state after the implementation has been completed", 571 "consumes": [ 572 "multipart/form-data" 573 ], 574 "produces": [ 575 "application/json" 576 ], 577 "operationId": "notifyAPIImplementation", 578 "parameters": [ 579 { 580 "type": "string", 581 "x-example": "353bd366-47d4-4703-aecf-9cb40cdcc864", 582 "description": "API Id for the API to be updated", 583 "name": "apiId", 584 "in": "path", 585 "required": true 586 }, 587 { 588 "x-examples": { 589 "application/json": "{ \r\n\t\"nativeBaseURLs\" : [\"https://localhost:5556/restv2/calc/v1\", \"http://localhost:5555/restv2/calc/v1\"], \r\n\t\"maturityState\" : \"Implemented\"\r\n}" 590 }, 591 "description": "API publish request payload", 592 "name": "body", 593 "in": "body", 594 "required": true, 595 "schema": { 596 "$ref": "#/definitions/InputAPIImplementation" 597 } 598 } 599 ], 600 "responses": { 601 "200": { 602 "description": "Returns the updated API object", 603 "schema": { 604 "$ref": "#/definitions/APIResponse" 605 } 606 }, 607 "400": { 608 "description": "This status code shows when the user missed the mandatory fields like type, file/url/apiDefinition in the request or provide a invalid request body" 609 }, 610 "401": { 611 "description": "" 612 }, 613 "404": { 614 "description": "This status code indicates that the apiId specified is not found in the API Gateway" 615 } 616 } 617 } 618 }, 619 "/apis/{apiId}/mock/disable": { 620 "put": { 621 "security": [ 622 { 623 "Basic": [] 624 } 625 ], 626 "description": "Once API is disabled from mocking capability, at runtime all the API invocations are redirected to the native service instead of sending the mocked response", 627 "produces": [ 628 "application/json" 629 ], 630 "operationId": "disableMockAPI", 631 "parameters": [ 632 { 633 "type": "string", 634 "x-example": "353bd366-47d4-4703-aecf-9cb40cdcc864", 635 "description": "API Id for the API to be deactivated", 636 "name": "apiId", 637 "in": "path", 638 "required": true 639 } 640 ], 641 "responses": { 642 "200": { 643 "description": "Returns the API object after successful disabling mocking of an API", 644 "schema": { 645 "$ref": "#/definitions/APIResponse" 646 }, 647 "examples": { 648 "application/json": "{\r\n \"apiResponse\": {\r\n \"api\": {\r\n \"apiDefinition\": {\r\n \"type\": \"rest\",\r\n \"info\": {\r\n \"description\": \"API to demonstrate mocking functionality in international developers day\",\r\n \"version\": \"v1\",\r\n \"title\": \"API_MOCKING\"\r\n },\r\n \"host\": \"localhost\",\r\n \"schemes\": [\r\n \"http\"\r\n ],\r\n \"consumes\": [\r\n \"application/json\"\r\n ],\r\n \"security\": [],\r\n \"paths\": {\r\n \"/conditionBasedMockedResponse\": {\r\n \"post\": {\r\n \"summary\": \"Configure condition and mocked response\",\r\n \"operationId\": \"conditionBasedMockedResponse\",\r\n \"produces\": [\r\n \"text/plain\"\r\n ],\r\n \"responses\": {\r\n \"200\": {\r\n \"description\": \"200 response\",\r\n \"content\": {\r\n \"text/plain\": {\r\n \"example\": \"No condition evaluates to true. \\nSo API-Gateway sent this default response.\"\r\n }\r\n }\r\n }\r\n },\r\n \"mockedResponses\": {\r\n \"200\": {\r\n \"responseBody\": {\r\n \"text/plain\": \"No condition evaluates to true. \\nSo API-Gateway sent this default response.\"\r\n }\r\n }\r\n },\r\n \"enabled\": true\r\n },\r\n \"parameters\": [],\r\n \"displayName\": \"/conditionBasedMockedResponse\",\r\n \"enabled\": true\r\n },\r\n \"/customESBMockedResponse\": {\r\n \"post\": {\r\n \"summary\": \"Configure custom ESB mocked response\",\r\n \"operationId\": \"customESBMockedResponse\",\r\n \"produces\": [\r\n \"application/json\"\r\n ],\r\n \"responses\": {\r\n \"200\": {\r\n \"description\": \"200 response\"\r\n }\r\n },\r\n \"mockedResponses\": {\r\n \"200\": {\r\n \"responseBody\": {\r\n \"application/json\": \"\"\r\n }\r\n }\r\n },\r\n \"enabled\": true\r\n },\r\n \"parameters\": [],\r\n \"displayName\": \"/customESBMockedResponse\",\r\n \"enabled\": true\r\n },\r\n \"/dynamicMockedResponse\": {\r\n \"post\": {\r\n \"summary\": \"Dynamic mocked response set\",\r\n \"operationId\": \"dynamicMockedResponse\",\r\n \"produces\": [\r\n \"application/json\"\r\n ],\r\n \"responses\": {\r\n \"200\": {\r\n \"description\": \"200 response\"\r\n }\r\n },\r\n \"mockedResponses\": {\r\n \"200\": {\r\n \"responseBody\": {\r\n \"application/json\": \"\"\r\n }\r\n }\r\n },\r\n \"enabled\": true\r\n },\r\n \"parameters\": [],\r\n \"displayName\": \"/dynamicMockedResponse\",\r\n \"enabled\": true\r\n },\r\n \"/staticMockedResponse\": {\r\n \"post\": {\r\n \"summary\": \"Default mocked response from example\",\r\n \"operationId\": \"generateFromExample\",\r\n \"produces\": [\r\n \"application/json\",\r\n \"application/xml\"\r\n ],\r\n \"responses\": {\r\n \"200\": {\r\n \"description\": \"200 response generated from example\",\r\n \"content\": {\r\n \"application/json\": {\r\n \"example\": \"{\\\"resource\\\" : \\\"/generateFromExample\\\",\\\"description\\\" : \\\"Default mocked response from example for status code 200\\\"}\"\r\n },\r\n \"application/xml\": {\r\n \"example\": \"\u003croot\u003e\u003cresource\u003e/generateFromExample\u003c/resource\u003e\u003cdescription\u003eDefault mocked response from example for status code 200\u003c/description\u003e\u003c/root\u003e\"\r\n }\r\n }\r\n },\r\n \"201\": {\r\n \"description\": \"201 response generated from schema\",\r\n \"content\": {\r\n \"application/json\": {\r\n \"schema\": {\r\n \"$ref\": \"#/components/schemas/Pet\"\r\n }\r\n },\r\n \"application/xml\": {\r\n \"schema\": {\r\n \"$ref\": \"#/components/schemas/Pet\"\r\n }\r\n }\r\n }\r\n }\r\n },\r\n \"mockedResponses\": {\r\n \"200\": {\r\n \"responseBody\": {\r\n \"application/json\": \"{\\\"resource\\\" : \\\"/generateFromExample\\\",\\\"description\\\" : \\\"Default mocked response from example for status code 200\\\"}\",\r\n \"application/xml\": \"\u003croot\u003e\u003cresource\u003e/generateFromExample\u003c/resource\u003e\u003cdescription\u003eDefault mocked response from example for status code 200\u003c/description\u003e\u003c/root\u003e\"\r\n }\r\n },\r\n \"201\": {\r\n \"responseBody\": {\r\n \"application/json\": \"{\\\"birthday\\\":2059397944,\\\"name\\\":\\\"\\\"}\",\r\n \"application/xml\": \"\u003cbirthday\u003e921604684\u003c/birthday\u003e\u003cname/\u003e\"\r\n }\r\n }\r\n },\r\n \"enabled\": true\r\n },\r\n \"parameters\": [],\r\n \"displayName\": \"/staticMockedResponse\",\r\n \"enabled\": true\r\n }\r\n },\r\n \"securityDefinitions\": {},\r\n \"definitions\": {},\r\n \"baseUriParameters\": [],\r\n \"externalDocs\": [],\r\n \"servers\": [\r\n {\r\n \"url\": \"http://localhost\"\r\n }\r\n ],\r\n \"components\": {\r\n \"schemas\": {\r\n \"Pet\": {\r\n \"required\": [\r\n \"name\"\r\n ],\r\n \"type\": \"object\",\r\n \"properties\": {\r\n \"birthday\": {\r\n \"type\": \"integer\",\r\n \"format\": \"int32\"\r\n },\r\n \"name\": {\r\n \"type\": \"string\"\r\n }\r\n }\r\n }\r\n }\r\n }\r\n },\r\n \"nativeEndpoint\": [\r\n {\r\n \"passSecurityHeaders\": true,\r\n \"uri\": \"http://localhost\",\r\n \"connectionTimeoutDuration\": 0,\r\n \"alias\": false\r\n }\r\n ],\r\n \"apiName\": \"APIMocking\",\r\n \"apiVersion\": \"v1\",\r\n \"apiDescription\": \"API to demonstrate mocking functionality in international developers day\",\r\n \"maturityState\": \"Beta\",\r\n \"isActive\": false,\r\n \"type\": \"REST\",\r\n \"owner\": \"Administrator\",\r\n \"policies\": [\r\n \"19773e29-2838-4efc-aa04-793b48f4d22b\"\r\n ],\r\n \"scopes\": [],\r\n \"publishedPortals\": [],\r\n \"creationDate\": \"2018-11-01 13:44:58 GMT\",\r\n \"systemVersion\": 1,\r\n \"mockService\": {\r\n \"enableMock\": false\r\n },\r\n \"id\": \"afd8eb5e-bba8-447b-8e28-76aac23ba074\"\r\n },\r\n \"responseStatus\": \"SUCCESS\",\r\n \"versions\": [\r\n {\r\n \"versionNumber\": \"v1\",\r\n \"apiId\": \"afd8eb5e-bba8-447b-8e28-76aac23ba074\"\r\n }\r\n ]\r\n }\r\n}" 649 } 650 }, 651 "400": { 652 "description": "This status code shows when the API is already in activated state or in mocked state" 653 }, 654 "401": { 655 "description": "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API." 656 }, 657 "404": { 658 "description": "This status code indicates that the apiId specified is not found in the API Gateway" 659 } 660 } 661 } 662 }, 663 "/apis/{apiId}/mock/enable": { 664 "put": { 665 "security": [ 666 { 667 "Basic": [] 668 } 669 ], 670 "description": "In API Gateway, you can mock an API implementation. API Gateway lets you mock an API by simulating the native service. API Mocking is useful feature in API first approach, where in the provider may choose to expose the mocked API to the consumers when the actual API doesn't exist or isn't complete. \n In API Gateway, when you enable mocking for an API, a default mock response is created for each combination of resource, operation, status code and content-type based on the example and schema set in the API definition. As an API Provider, you can add or modify the default mock responses.\n\nYou can specify conditions at the operation level and configure IS services at the API level for a mocked API in the update API operation. At runtime, when the mocked API is invoked instead of calling the native service, API Gateway returns the mocked response to the consumer based on the below priorities:\n1. If any of the conditions for the invoked operation satisfies, API Gateway returns the associated mocked response.\n2. If no condition is specified or none of the condition for the invoked operation is satisfied, then API Gateway will return \na. the response from an IS service, if an IS service is configured b. default mocked response, if no IS services are configured", 671 "produces": [ 672 "application/json" 673 ], 674 "operationId": "enableMockAPI", 675 "parameters": [ 676 { 677 "type": "string", 678 "x-example": "353bd366-47d4-4703-aecf-9cb40cdcc864", 679 "description": "API Id for the API to be activated", 680 "name": "apiId", 681 "in": "path", 682 "required": true 683 }, 684 { 685 "type": "boolean", 686 "default": false, 687 "x-example": true, 688 "description": "Flag to retain generated mocked responses. When this is set to true, default mocked responses will be retained. If it's set to false, new default mocked responses will be generated using the examples, schema in the API", 689 "name": "retainDefaultMockResponses", 690 "in": "query" 691 } 692 ], 693 "responses": { 694 "200": { 695 "description": "Returns the API object after successfully enabling mocking of an API", 696 "schema": { 697 "$ref": "#/definitions/APIResponse" 698 }, 699 "examples": { 700 "application/json": "{\r\n \"apiResponse\": {\r\n \"api\": {\r\n \"apiDefinition\": {\r\n \"type\": \"rest\",\r\n \"info\": {\r\n \"description\": \"API to demonstrate mocking functionality in international developers day\",\r\n \"version\": \"v1\",\r\n \"title\": \"API_MOCKING\"\r\n },\r\n \"host\": \"localhost\",\r\n \"schemes\": [\r\n \"http\"\r\n ],\r\n \"consumes\": [\r\n \"application/json\"\r\n ],\r\n \"security\": [],\r\n \"paths\": {\r\n \"/conditionBasedMockedResponse\": {\r\n \"post\": {\r\n \"summary\": \"Configure condition and mocked response\",\r\n \"operationId\": \"conditionBasedMockedResponse\",\r\n \"produces\": [\r\n \"text/plain\"\r\n ],\r\n \"responses\": {\r\n \"200\": {\r\n \"description\": \"200 response\",\r\n \"content\": {\r\n \"text/plain\": {\r\n \"example\": \"No condition evaluates to true. \\nSo API-Gateway sent this default response.\"\r\n }\r\n }\r\n }\r\n },\r\n \"mockedResponses\": {\r\n \"200\": {\r\n \"responseBody\": {\r\n \"text/plain\": \"No condition evaluates to true. \\nSo API-Gateway sent this default response.\"\r\n }\r\n }\r\n },\r\n \"enabled\": true\r\n },\r\n \"parameters\": [],\r\n \"displayName\": \"/conditionBasedMockedResponse\",\r\n \"enabled\": true\r\n },\r\n \"/customESBMockedResponse\": {\r\n \"post\": {\r\n \"summary\": \"Configure custom ESB mocked response\",\r\n \"operationId\": \"customESBMockedResponse\",\r\n \"produces\": [\r\n \"application/json\"\r\n ],\r\n \"responses\": {\r\n \"200\": {\r\n \"description\": \"200 response\"\r\n }\r\n },\r\n \"mockedResponses\": {\r\n \"200\": {\r\n \"responseBody\": {\r\n \"application/json\": \"\"\r\n }\r\n }\r\n },\r\n \"enabled\": true\r\n },\r\n \"parameters\": [],\r\n \"displayName\": \"/customESBMockedResponse\",\r\n \"enabled\": true\r\n },\r\n \"/dynamicMockedResponse\": {\r\n \"post\": {\r\n \"summary\": \"Dynamic mocked response set\",\r\n \"operationId\": \"dynamicMockedResponse\",\r\n \"produces\": [\r\n \"application/json\"\r\n ],\r\n \"responses\": {\r\n \"200\": {\r\n \"description\": \"200 response\"\r\n }\r\n },\r\n \"mockedResponses\": {\r\n \"200\": {\r\n \"responseBody\": {\r\n \"application/json\": \"\"\r\n }\r\n }\r\n },\r\n \"enabled\": true\r\n },\r\n \"parameters\": [],\r\n \"displayName\": \"/dynamicMockedResponse\",\r\n \"enabled\": true\r\n },\r\n \"/staticMockedResponse\": {\r\n \"post\": {\r\n \"summary\": \"Default mocked response from example\",\r\n \"operationId\": \"generateFromExample\",\r\n \"produces\": [\r\n \"application/json\",\r\n \"application/xml\"\r\n ],\r\n \"responses\": {\r\n \"200\": {\r\n \"description\": \"200 response generated from example\",\r\n \"content\": {\r\n \"application/json\": {\r\n \"example\": \"{\\\"resource\\\" : \\\"/generateFromExample\\\",\\\"description\\\" : \\\"Default mocked response from example for status code 200\\\"}\"\r\n },\r\n \"application/xml\": {\r\n \"example\": \"\u003croot\u003e\u003cresource\u003e/generateFromExample\u003c/resource\u003e\u003cdescription\u003eDefault mocked response from example for status code 200\u003c/description\u003e\u003c/root\u003e\"\r\n }\r\n }\r\n },\r\n \"201\": {\r\n \"description\": \"201 response generated from schema\",\r\n \"content\": {\r\n \"application/json\": {\r\n \"schema\": {\r\n \"$ref\": \"#/components/schemas/Pet\"\r\n }\r\n },\r\n \"application/xml\": {\r\n \"schema\": {\r\n \"$ref\": \"#/components/schemas/Pet\"\r\n }\r\n }\r\n }\r\n }\r\n },\r\n \"mockedResponses\": {\r\n \"200\": {\r\n \"responseBody\": {\r\n \"application/json\": \"{\\\"resource\\\" : \\\"/generateFromExample\\\",\\\"description\\\" : \\\"Default mocked response from example for status code 200\\\"}\",\r\n \"application/xml\": \"\u003croot\u003e\u003cresource\u003e/generateFromExample\u003c/resource\u003e\u003cdescription\u003eDefault mocked response from example for status code 200\u003c/description\u003e\u003c/root\u003e\"\r\n }\r\n },\r\n \"201\": {\r\n \"responseBody\": {\r\n \"application/json\": \"{\\\"birthday\\\":2059397944,\\\"name\\\":\\\"\\\"}\",\r\n \"application/xml\": \"\u003cbirthday\u003e921604684\u003c/birthday\u003e\u003cname/\u003e\"\r\n }\r\n }\r\n },\r\n \"enabled\": true\r\n },\r\n \"parameters\": [],\r\n \"displayName\": \"/staticMockedResponse\",\r\n \"enabled\": true\r\n }\r\n },\r\n \"securityDefinitions\": {},\r\n \"definitions\": {},\r\n \"baseUriParameters\": [],\r\n \"externalDocs\": [],\r\n \"servers\": [\r\n {\r\n \"url\": \"http://localhost\"\r\n }\r\n ],\r\n \"components\": {\r\n \"schemas\": {\r\n \"Pet\": {\r\n \"required\": [\r\n \"name\"\r\n ],\r\n \"type\": \"object\",\r\n \"properties\": {\r\n \"birthday\": {\r\n \"type\": \"integer\",\r\n \"format\": \"int32\"\r\n },\r\n \"name\": {\r\n \"type\": \"string\"\r\n }\r\n }\r\n }\r\n }\r\n }\r\n },\r\n \"nativeEndpoint\": [\r\n {\r\n \"passSecurityHeaders\": true,\r\n \"uri\": \"http://localhost\",\r\n \"connectionTimeoutDuration\": 0,\r\n \"alias\": false\r\n }\r\n ],\r\n \"apiName\": \"APIMocking\",\r\n \"apiVersion\": \"v1\",\r\n \"apiDescription\": \"API to demonstrate mocking functionality in international developers day\",\r\n \"maturityState\": \"Beta\",\r\n \"isActive\": false,\r\n \"type\": \"REST\",\r\n \"owner\": \"Administrator\",\r\n \"policies\": [\r\n \"19773e29-2838-4efc-aa04-793b48f4d22b\"\r\n ],\r\n \"scopes\": [],\r\n \"publishedPortals\": [],\r\n \"creationDate\": \"2018-11-01 13:44:58 GMT\",\r\n \"systemVersion\": 1,\r\n \"mockService\": {\r\n \"enableMock\": true\r\n },\r\n \"id\": \"afd8eb5e-bba8-447b-8e28-76aac23ba074\"\r\n },\r\n \"responseStatus\": \"SUCCESS\",\r\n \"versions\": [\r\n {\r\n \"versionNumber\": \"v1\",\r\n \"apiId\": \"afd8eb5e-bba8-447b-8e28-76aac23ba074\"\r\n }\r\n ]\r\n }\r\n}" 701 } 702 }, 703 "400": { 704 "description": "This status code shows when the API is already in activated state or when invalid json or xml is provided in the example part of the operation" 705 }, 706 "401": { 707 "description": "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API." 708 }, 709 "404": { 710 "description": "This status code indicates that the apiId specified is not found in the API Gateway" 711 } 712 } 713 } 714 }, 715 "/apis/{apiId}/providerspecification": { 716 "get": { 717 "security": [ 718 { 719 "Basic": [] 720 } 721 ], 722 "description": "Downloads the provider specification of REST and SOAP based APIs. Provider specification is nothing but, the specification file (in swagger or wsdl format) with out the concrete API Gateway endpoint and contains all resources/methods/operation irrespective of whether they are exposed to consumer", 723 "produces": [ 724 "application/json" 725 ], 726 "operationId": "downloadProviderSpecification", 727 "parameters": [ 728 { 729 "type": "string", 730 "x-example": "353bd366-47d4-4703-aecf-9cb40cdcc864", 731 "description": "API Id for the API to retrieve the versions", 732 "name": "apiId", 733 "in": "path", 734 "required": true 735 }, 736 { 737 "enum": [ 738 "swagger", 739 "wsdl" 740 ], 741 "type": "string", 742 "x-example": "swagger", 743 "description": "Output format of the API specification. For REST APIs the value is 'swagger'; for SOAP APIs use the value as 'wsdl'", 744 "name": "format", 745 "in": "query", 746 "required": true 747 } 748 ], 749 "responses": { 750 "200": { 751 "description": "If the format is swagger, returns the swagger content in json. If the format is wsdl, returns the wsdl content in xml.", 752 "schema": { 753 "$ref": "#/definitions/APIResponseGetAPI" 754 } 755 }, 756 "401": { 757 "description": "" 758 }, 759 "404": { 760 "description": "This status code indicates that the apiId specified is not found in the API Gateway" 761 } 762 } 763 } 764 }, 765 "/apis/{apiId}/publish": { 766 "put": { 767 "security": [ 768 { 769 "Basic": [] 770 } 771 ], 772 "description": "This REST operation is used to publish API to the registered API Portal", 773 "consumes": [ 774 "application/json" 775 ], 776 "produces": [ 777 "application/json" 778 ], 779 "operationId": "publishAPI", 780 "parameters": [ 781 { 782 "type": "string", 783 "x-example": "353bd366-47d4-4703-aecf-9cb40cdcc864", 784 "description": "API Id for the API to be published", 785 "name": "apiId", 786 "in": "path", 787 "required": true 788 }, 789 { 790 "x-examples": { 791 "application/json": "{\r\n\t\"portalGatewayId\" : \"69bac781-6c60-4db3-86f7-50af3ec4963a\",\r\n\t\"communities\" : [\"3bdf8005-5685-3ef5-b132-de4681963fb6\"],\r\n\t\"endpoints\" : [\"https://api.chucknorris.io/jokes\"]\r\n}" 792 }, 793 "description": "API publish request payload", 794 "name": "body", 795 "in": "body", 796 "required": true, 797 "schema": { 798 "$ref": "#/definitions/InputPublish" 799 } 800 } 801 ], 802 "responses": { 803 "200": { 804 "description": "Returns the API object after successful publish", 805 "schema": { 806 "$ref": "#/definitions/APIResponseCreate" 807 }, 808 "examples": { 809 "application/json": "{\r\n \"apiResponse\": {\r\n \"api\": {\r\n \"apiDefinition\": {\r\n \"type\": \"rest\",\r\n \"info\": {\r\n \"vendorExtensions\": {},\r\n \"description\": \"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\",\r\n \"version\": \"1.0\",\r\n \"title\": \"ChuckNorrisAPI\"\r\n },\r\n \"host\": \"api.chucknorris.io\",\r\n \"basePath\": \"/jokes\",\r\n \"schemes\": [\r\n \"https\"\r\n ],\r\n \"paths\": {\r\n \"/random\": {\r\n \"get\": {\r\n \"summary\": \"GET\",\r\n \"description\": \"\",\r\n \"operationId\": \"GET\",\r\n \"produces\": [\r\n \"application/json\"\r\n ],\r\n \"parameters\": [],\r\n \"responses\": {},\r\n \"enabled\": true\r\n },\r\n \"enabled\": true\r\n }\r\n },\r\n \"definitions\": {}\r\n },\r\n \"nativeEndpoint\": [\r\n {\r\n \"passSecurityHeaders\": true,\r\n \"uri\": \"https://api.chucknorris.io/jokes\",\r\n \"connectionTimeoutDuration\": 0,\r\n \"alias\": false\r\n }\r\n ],\r\n \"apiName\": \"ChuckNorrisAPI\",\r\n \"apiVersion\": \"1.0\",\r\n \"apiDescription\": \"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\",\r\n \"maturityState\": \"Beta\",\r\n \"isActive\": false,\r\n \"type\": \"REST\",\r\n \"owner\": \"Administrator\",\r\n \"policies\": [\r\n \"879068cd-8628-4f2a-b903-4e6613ca12ba\"\r\n ],\r\n \"referencedFiles\": {\r\n \"ChuckNorrisAPI.json\": \"{\\r\\n \\\"swagger\\\": \\\"2.0\\\",\\r\\n \\\"info\\\": {\\r\\n \\\"description\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"title\\\": \\\"ChuckNorrisAPI\\\",\\r\\n \\\"version\\\": \\\"1.0\\\"\\r\\n },\\r\\n \\\"host\\\": \\\"api.chucknorris.io\\\",\\r\\n \\\"basePath\\\": \\\"/jokes\\\",\\r\\n \\\"schemes\\\": [\\r\\n \\\"https\\\"\\r\\n ],\\r\\n \\\"paths\\\": {\\r\\n \\\"/random\\\": {\\r\\n \\\"get\\\": {\\r\\n \\\"summary\\\": \\\"GET\\\",\\r\\n \\\"deprecated\\\": false,\\r\\n \\\"produces\\\": [\\r\\n \\\"application/json\\\"\\r\\n ],\\r\\n \\\"description\\\": \\\"\\\",\\r\\n \\\"operationId\\\": \\\"GET\\\"\\r\\n }\\r\\n }\\r\\n }\\r\\n}\\r\\n\"\r\n },\r\n \"scopes\": [],\r\n \"publishedPortals\": [],\r\n \"creationDate\": \"2017-03-13 09:38:30 GMT\",\r\n \"systemVersion\": 1,\r\n \"id\": \"25fb937a-8360-41ab-8be5-987b14fe631d\",\r\n \"oauth2ScopeName\": \"25fb937a-8360-41ab-8be5-987b14fe631d\"\r\n },\r\n \"responseStatus\": \"SUCCESS\"\r\n }\r\n}" 810 } 811 }, 812 "400": { 813 "description": "This status code shows when the user missed the mandatory portalGatewayId or invalid portalGatewayId in the request body" 814 }, 815 "401": { 816 "description": "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API." 817 }, 818 "404": { 819 "description": "This status code indicates that the apiId specified is not found in the API Gateway" 820 } 821 } 822 } 823 }, 824 "/apis/{apiId}/scopes": { 825 "get": { 826 "security": [ 827 { 828 "Basic": [] 829 } 830 ], 831 "description": "An API Scope is a collection of resources or operations in an API. Users can create multiple scopes for a single API. Policies can be attached to an API level or scope level. This method retrieves the scopes of an API.\n\nYou can create, modify or delete the scopes in the update API operation using PUT /api/{apiId}", 832 "produces": [ 833 "application/json" 834 ], 835 "operationId": "getScopes", 836 "parameters": [ 837 { 838 "type": "string", 839 "x-example": "353bd366-47d4-4703-aecf-9cb40cdcc864", 840 "description": "API Id for the API to retrieve the versions", 841 "name": "apiId", 842 "in": "path", 843 "required": true 844 } 845 ], 846 "responses": { 847 "200": { 848 "description": "Returns API scopes", 849 "schema": { 850 "type": "array", 851 "items": { 852 "$ref": "#/definitions/ScopeResourceIndex" 853 } 854 }, 855 "examples": { 856 "application/json": "{\r\n \"scopeReferences\": [\r\n {\r\n \"references\": [\r\n {\r\n \"resourcePath\": \"/random\",\r\n \"supportedOperations\": []\r\n }\r\n ],\r\n \"scope\": {\r\n \"name\": \"Get_Scopes\",\r\n \"description\": \"Dummy description of the scope\",\r\n \"policies\": [\r\n \"db1a42f4-e038-4a1b-82f4-8fee6fbd5687\"\r\n ]\r\n }\r\n }\r\n ]\r\n}" 857 } 858 }, 859 "401": { 860 "description": "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API." 861 }, 862 "404": { 863 "description": "This status code indicates that the apiId specified is not found in the API Gateway" 864 } 865 } 866 } 867 }, 868 "/apis/{apiId}/scopes/{scopeName}": { 869 "get": { 870 "security": [ 871 { 872 "Basic": [] 873 } 874 ], 875 "description": "Retrieve scopes of an API based on the scope name", 876 "produces": [ 877 "application/json" 878 ], 879 "operationId": "getScopeByScopeName", 880 "parameters": [ 881 { 882 "type": "string", 883 "x-example": "353bd366-47d4-4703-aecf-9cb40cdcc864", 884 "description": "API Id for the API to retrieve the versions", 885 "name": "apiId", 886 "in": "path", 887 "required": true 888 }, 889 { 890 "type": "string", 891 "x-example": "getScope", 892 "description": "Name of the scope", 893 "name": "scopeName", 894 "in": "path", 895 "required": true 896 } 897 ], 898 "responses": { 899 "200": { 900 "description": "Returns API scopes", 901 "schema": { 902 "type": "array", 903 "items": { 904 "$ref": "#/definitions/ScopeResourceIndex" 905 } 906 }, 907 "examples": { 908 "application/json": "{\r\n \"scopeReferences\": [\r\n {\r\n \"references\": [\r\n {\r\n \"resourcePath\": \"/random\",\r\n \"supportedOperations\": []\r\n }\r\n ],\r\n \"scope\": {\r\n \"name\": \"Get_Scopes\",\r\n \"description\": \"Dummy description of the scope\",\r\n \"policies\": [\r\n \"db1a42f4-e038-4a1b-82f4-8fee6fbd5687\"\r\n ]\r\n }\r\n }\r\n ]\r\n}" 909 } 910 }, 911 "401": { 912 "description": "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API." 913 }, 914 "404": { 915 "description": "This status code indicates that the apiId specified is not found in the API Gateway or scopeName is not found in the list of scopes" 916 } 917 } 918 } 919 }, 920 "/apis/{apiId}/source": { 921 "get": { 922 "security": [ 923 { 924 "Basic": [] 925 } 926 ], 927 "description": "Download the API definition that was used to create the API. This is applicable only for SOAP APIs.", 928 "produces": [ 929 "multipart/mixed" 930 ], 931 "operationId": "getSource", 932 "parameters": [ 933 { 934 "type": "string", 935 "x-example": "353bd366-47d4-4703-aecf-9cb40cdcc864", 936 "description": "API Id for the API to download the source content", 937 "name": "apiId", 938 "in": "path", 939 "required": true 940 } 941 ], 942 "responses": { 943 "200": { 944 "description": "Returns the source files along with the root file name", 945 "schema": { 946 "type": "array", 947 "items": { 948 "$ref": "#/definitions/Multipart" 949 } 950 }, 951 "examples": { 952 "multipart/mixed": "Message-ID: \u003c296841806.5.1489555643275.JavaMail.MRIZ@MCMRIZ01\u003e\r\nMIME-Version: 1.0\r\nContent-Type: multipart/mixed; \r\n\tboundary=\"----=_Part_4_1098332532.1489555643274\"\r\n\r\n------=_Part_4_1098332532.1489555643274\r\ncontent-type: application/zip\r\nContent-Disposition: attachment; filename=\"echoService.zip\"\r\n\r\nfile content in zip format\r\n------=_Part_4_1098332532.1489555643274\r\ncontent-type: text/plain\r\nContent-Disposition: inline; name=\"rootFileName\"\r\n\r\necho.wsdl\r\n------=_Part_4_1098332532.1489555643274--" 953 } 954 }, 955 "400": { 956 "description": "This status code returns when the specified API is not a SOAP API" 957 }, 958 "401": { 959 "description": "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API." 960 }, 961 "404": { 962 "description": "This status code indicates that the apiId specified is not found in the API Gateway" 963 } 964 } 965 } 966 }, 967 "/apis/{apiId}/unpublish": { 968 "put": { 969 "security": [ 970 { 971 "Basic": [] 972 } 973 ], 974 "description": "Unpublish API from the registered API Portal", 975 "produces": [ 976 "application/json" 977 ], 978 "operationId": "unpublishAPI", 979 "parameters": [ 980 { 981 "type": "string", 982 "x-example": "353bd366-47d4-4703-aecf-9cb40cdcc864", 983 "description": "API Id for the API to be unpublished", 984 "name": "apiId", 985 "in": "path", 986 "required": true 987 } 988 ], 989 "responses": { 990 "200": { 991 "description": "Returns the API object after successful unpublish", 992 "schema": { 993 "$ref": "#/definitions/APIResponseCreate" 994 }, 995 "examples": { 996 "application/json": "{\r\n \"apiResponse\": {\r\n \"api\": {\r\n \"apiDefinition\": {\r\n \"type\": \"rest\",\r\n \"info\": {\r\n \"vendorExtensions\": {},\r\n \"description\": \"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\",\r\n \"version\": \"1.0\",\r\n \"title\": \"ChuckNorrisAPI\"\r\n },\r\n \"host\": \"api.chucknorris.io\",\r\n \"basePath\": \"/jokes\",\r\n \"schemes\": [\r\n \"https\"\r\n ],\r\n \"paths\": {\r\n \"/random\": {\r\n \"get\": {\r\n \"summary\": \"GET\",\r\n \"description\": \"\",\r\n \"operationId\": \"GET\",\r\n \"produces\": [\r\n \"application/json\"\r\n ],\r\n \"parameters\": [],\r\n \"responses\": {},\r\n \"enabled\": true\r\n },\r\n \"enabled\": true\r\n }\r\n },\r\n \"definitions\": {}\r\n },\r\n \"nativeEndpoint\": [\r\n {\r\n \"passSecurityHeaders\": true,\r\n \"uri\": \"https://api.chucknorris.io/jokes\",\r\n \"connectionTimeoutDuration\": 0,\r\n \"alias\": false\r\n }\r\n ],\r\n \"apiName\": \"ChuckNorrisAPI\",\r\n \"apiVersion\": \"1.0\",\r\n \"apiDescription\": \"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\",\r\n \"maturityState\": \"Beta\",\r\n \"isActive\": false,\r\n \"type\": \"REST\",\r\n \"owner\": \"Administrator\",\r\n \"policies\": [\r\n \"879068cd-8628-4f2a-b903-4e6613ca12ba\"\r\n ],\r\n \"referencedFiles\": {\r\n \"ChuckNorrisAPI.json\": \"{\\r\\n \\\"swagger\\\": \\\"2.0\\\",\\r\\n \\\"info\\\": {\\r\\n \\\"description\\\": \\\"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\\\",\\r\\n \\\"title\\\": \\\"ChuckNorrisAPI\\\",\\r\\n \\\"version\\\": \\\"1.0\\\"\\r\\n },\\r\\n \\\"host\\\": \\\"api.chucknorris.io\\\",\\r\\n \\\"basePath\\\": \\\"/jokes\\\",\\r\\n \\\"schemes\\\": [\\r\\n \\\"https\\\"\\r\\n ],\\r\\n \\\"paths\\\": {\\r\\n \\\"/random\\\": {\\r\\n \\\"get\\\": {\\r\\n \\\"summary\\\": \\\"GET\\\",\\r\\n \\\"deprecated\\\": false,\\r\\n \\\"produces\\\": [\\r\\n \\\"application/json\\\"\\r\\n ],\\r\\n \\\"description\\\": \\\"\\\",\\r\\n \\\"operationId\\\": \\\"GET\\\"\\r\\n }\\r\\n }\\r\\n }\\r\\n}\\r\\n\"\r\n },\r\n \"scopes\": [],\r\n \"publishedPortals\": [],\r\n \"creationDate\": \"2017-03-13 09:38:30 GMT\",\r\n \"systemVersion\": 1,\r\n \"id\": \"25fb937a-8360-41ab-8be5-987b14fe631d\",\r\n \"oauth2ScopeName\": \"25fb937a-8360-41ab-8be5-987b14fe631d\"\r\n },\r\n \"responseStatus\": \"SUCCESS\"\r\n }\r\n}" 997 } 998 }, 999 "400": { 1000 "description": "This status code shows when the user missed the mandatory portalGatewayId or invalid portalGatewayId in the request body" 1001 }, 1002 "401": { 1003 "description": "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API." 1004 }, 1005 "404": { 1006 "description": "This status code indicates that the apiId specified is not found in the API Gateway" 1007 } 1008 } 1009 } 1010 }, 1011 "/apis/{apiId}/versions": { 1012 "get": { 1013 "security": [ 1014 { 1015 "Basic": [] 1016 } 1017 ], 1018 "description": "Retrieve all the versions of the API", 1019 "produces": [ 1020 "application/json" 1021 ], 1022 "operationId": "getVersions", 1023 "parameters": [ 1024 { 1025 "type": "string", 1026 "x-example": "353bd366-47d4-4703-aecf-9cb40cdcc864", 1027 "description": "API Id for the API to retrieve the versions", 1028 "name": "apiId", 1029 "in": "path", 1030 "required": true 1031 } 1032 ], 1033 "responses": { 1034 "200": { 1035 "description": "Returns the API versions", 1036 "schema": { 1037 "$ref": "#/definitions/APIResponseGetAPIs" 1038 }, 1039 "examples": { 1040 "application/json": "{\r\n \"apiResponse\": {\r\n \"api\": {\r\n \"apiDefinition\": {\r\n \"type\": \"rest\",\r\n \"info\": {\r\n \"description\": \"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\",\r\n \"version\": \"1.0\",\r\n \"title\": \"ChuckNorrisAPI\"\r\n },\r\n \"host\": \"api.chucknorris.io\",\r\n \"basePath\": \"/jokes\",\r\n \"schemes\": [\r\n \"https\"\r\n ],\r\n \"security\": [],\r\n \"paths\": {\r\n \"/random\": {\r\n \"get\": {\r\n \"summary\": \"GET\",\r\n \"description\": \"\",\r\n \"operationId\": \"GET\",\r\n \"produces\": [\r\n \"application/json\"\r\n ],\r\n \"responses\": {},\r\n \"enabled\": true\r\n },\r\n \"enabled\": true\r\n }\r\n },\r\n \"securityDefinitions\": {},\r\n \"definitions\": {},\r\n \"baseUriParameters\": [],\r\n \"externalDocs\": [],\r\n \"servers\": [\r\n {\r\n \"url\": \"https://api.chucknorris.io/jokes\"\r\n }\r\n ],\r\n \"components\": {\r\n \"schemas\": {}\r\n }\r\n },\r\n \"nativeEndpoint\": [\r\n {\r\n \"passSecurityHeaders\": true,\r\n \"uri\": \"https://api.chucknorris.io/jokes\",\r\n \"connectionTimeoutDuration\": 0,\r\n \"alias\": false\r\n }\r\n ],\r\n \"apiName\": \"ChuckNorris\",\r\n \"apiVersion\": \"1.0\",\r\n \"apiDescription\": \"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\",\r\n \"maturityState\": \"Beta\",\r\n \"isActive\": false,\r\n \"type\": \"REST\",\r\n \"owner\": \"Administrator\",\r\n \"policies\": [\r\n \"08afbfa9-78e1-4c23-bb19-c0012464047e\"\r\n ],\r\n \"scopes\": [],\r\n \"publishedPortals\": [],\r\n \"creationDate\": \"2018-09-03 11:56:21 GMT\",\r\n \"systemVersion\": 1,\r\n \"id\": \"badc18e6-446f-4aa3-96cd-33e46bd40fb5\"\r\n },\r\n \"responseStatus\": \"SUCCESS\",\r\n \"versions\": [\r\n {\r\n \"versionNumber\": \"1.0\",\r\n \"apiId\": \"badc18e6-446f-4aa3-96cd-33e46bd40fb5\"\r\n }\r\n ]\r\n }\r\n}" 1041 } 1042 }, 1043 "401": { 1044 "description": "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API." 1045 }, 1046 "404": { 1047 "description": "This status code indicates that the apiId specified is not found in the API Gateway" 1048 } 1049 } 1050 }, 1051 "post": { 1052 "security": [ 1053 { 1054 "Basic": [] 1055 } 1056 ], 1057 "description": "Create a new version of an API and retain applications if required", 1058 "consumes": [ 1059 "application/json" 1060 ], 1061 "produces": [ 1062 "application/json" 1063 ], 1064 "operationId": "createVersion", 1065 "parameters": [ 1066 { 1067 "type": "string", 1068 "x-example": "353bd366-47d4-4703-aecf-9cb40cdcc864", 1069 "description": "API Id for the API to be versioned", 1070 "name": "apiId", 1071 "in": "path", 1072 "required": true 1073 }, 1074 { 1075 "x-examples": { 1076 "application/json": "{\r\n\t\"newApiVersion\" : \"v2\",\r\n\t\"retainApplications\" : true\r\n}" 1077 }, 1078 "description": "Create version request payload", 1079 "name": "body", 1080 "in": "body", 1081 "required": true, 1082 "schema": { 1083 "$ref": "#/definitions/InputVersion" 1084 } 1085 } 1086 ], 1087 "responses": { 1088 "200": { 1089 "description": "Return the newly created version of the API", 1090 "schema": { 1091 "$ref": "#/definitions/APIResponse" 1092 }, 1093 "examples": { 1094 "application/json": "{\r\n \"apiResponse\": {\r\n \"api\": {\r\n \"apiDefinition\": {\r\n \"type\": \"rest\",\r\n \"info\": {\r\n \"description\": \"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\",\r\n \"version\": \"1.0\",\r\n \"title\": \"ChuckNorrisAPI\"\r\n },\r\n \"host\": \"api.chucknorris.io\",\r\n \"basePath\": \"/jokes\",\r\n \"schemes\": [\r\n \"https\"\r\n ],\r\n \"security\": [],\r\n \"paths\": {\r\n \"/random\": {\r\n \"get\": {\r\n \"summary\": \"GET\",\r\n \"description\": \"\",\r\n \"operationId\": \"GET\",\r\n \"produces\": [\r\n \"application/json\"\r\n ],\r\n \"responses\": {},\r\n \"enabled\": true\r\n },\r\n \"enabled\": true\r\n }\r\n },\r\n \"securityDefinitions\": {},\r\n \"definitions\": {},\r\n \"baseUriParameters\": [],\r\n \"externalDocs\": [],\r\n \"servers\": [\r\n {\r\n \"url\": \"https://api.chucknorris.io/jokes\"\r\n }\r\n ],\r\n \"components\": {\r\n \"schemas\": {}\r\n }\r\n },\r\n \"nativeEndpoint\": [\r\n {\r\n \"passSecurityHeaders\": true,\r\n \"uri\": \"https://api.chucknorris.io/jokes\",\r\n \"connectionTimeoutDuration\": 0,\r\n \"alias\": false\r\n }\r\n ],\r\n \"apiName\": \"ChuckNorris\",\r\n \"apiVersion\": \"1.0\",\r\n \"apiDescription\": \"Chuck Norris facts are satirical factoids about martial artist and actor Chuck Norris that have become an Internet phenomenon and as a result have become widespread in popular culture. The 'facts' are normally absurd hyperbolic claims about Norris' toughness, attitude, virility, sophistication, and masculinity.\",\r\n \"maturityState\": \"Beta\",\r\n \"isActive\": false,\r\n \"type\": \"REST\",\r\n \"owner\": \"Administrator\",\r\n \"policies\": [\r\n \"08afbfa9-78e1-4c23-bb19-c0012464047e\"\r\n ],\r\n \"scopes\": [],\r\n \"publishedPortals\": [],\r\n \"creationDate\": \"2018-09-03 11:56:21 GMT\",\r\n \"systemVersion\": 1,\r\n \"id\": \"badc18e6-446f-4aa3-96cd-33e46bd40fb5\"\r\n },\r\n \"responseStatus\": \"SUCCESS\",\r\n \"versions\": [\r\n {\r\n \"versionNumber\": \"1.0\",\r\n \"apiId\": \"badc18e6-446f-4aa3-96cd-33e46bd40fb5\"\r\n }\r\n ]\r\n }\r\n}" 1095 } 1096 }, 1097 "400": { 1098 "description": "This status code returns when the specified api is not the latest version or if the newApiVersion is empty" 1099 }, 1100 "401": { 1101 "description": "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API." 1102 }, 1103 "404": { 1104 "description": "Not Found" 1105 } 1106 } 1107 } 1108 }, 1109 "/integrationServer/publish": { 1110 "get": { 1111 "security": [ 1112 { 1113 "Basic": [] 1114 } 1115 ], 1116 "description": "Retrieve the integration server publish information for the API. Only REST and SOAP APIs are supported.", 1117 "produces": [ 1118 "application/json" 1119 ], 1120 "operationId": "getIntegrationServerPublishInfo", 1121 "parameters": [ 1122 { 1123 "type": "string", 1124 "x-example": "353bd366-47d4-4703-aecf-9cb40cdcc864", 1125 "description": "API Id of the API for which IntegrationServerPublishInfo is to be fetched", 1126 "name": "apiId", 1127 "in": "query", 1128 "required": true 1129 } 1130 ], 1131 "responses": { 1132 "200": { 1133 "description": "Returns the integration server publish info for the API", 1134 "schema": { 1135 "$ref": "#/definitions/ServiceRegistryPublishGetResponse" 1136 } 1137 }, 1138 "401": { 1139 "description": "" 1140 }, 1141 "404": { 1142 "description": "This status code indicates that Publish Info for the apiId specified is not found in API Gateway" 1143 } 1144 } 1145 }, 1146 "put": { 1147 "security": [ 1148 { 1149 "Basic": [] 1150 } 1151 ], 1152 "description": "Publish one or more APIs to one or more integration servers. Only REST and SOAP APIs are supported.", 1153 "produces": [ 1154 "application/json" 1155 ], 1156 "operationId": "publishToIntegrationServer", 1157 "parameters": [ 1158 { 1159 "description": "Integration server publish payload", 1160 "name": "body", 1161 "in": "body", 1162 "required": true, 1163 "schema": { 1164 "$ref": "#/definitions/InputIntegrationServerPublish" 1165 } 1166 } 1167 ], 1168 "responses": { 1169 "200": { 1170 "description": "Returns the status of the publish operations given in the request.", 1171 "schema": { 1172 "$ref": "#/definitions/ServiceRegistryPublishPutResponse" 1173 } 1174 }, 1175 "400": { 1176 "description": "This status code indicates an invalid request body" 1177 }, 1178 "401": { 1179 "description": "" 1180 }, 1181 "404": { 1182 "description": "This status code indicates that API with given apiId is not found in API Gateway" 1183 } 1184 } 1185 } 1186 }, 1187 "/scopes": { 1188 "get": { 1189 "security": [ 1190 { 1191 "Basic": [] 1192 } 1193 ], 1194 "description": "This method retrieves a list of available OAuth scope mappings in API Gateway. OAuth scope mappings map the authorization server scope with APIs or API scopes", 1195 "produces": [ 1196 "application/json" 1197 ], 1198 "operationId": "getOAuthScopes", 1199 "responses": { 1200 "200": { 1201 "description": "This status code indicates that a list of the available OAuth scopes are retrieved successfully.", 1202 "schema": { 1203 "$ref": "#/definitions/GatewayScope" 1204 }, 1205 "examples": { 1206 "application/json": "{\r\n\t\"scopes\": [\r\n\t\t{\r\n\t\t\t\"id\": \"ef084e4a-c30b-40f5-8ed9-2a6b7fb6ca34\",\r\n\t\t\t\"scopeName\": \"scopeMapping2\",\r\n\t\t\t\"scopeDescription\": \"scopeMapping2 description\",\r\n\t\t\t\"audience\": \"audienceName\",\r\n\t\t\t\"apiScopes\": [\r\n\t\t\t\t\"911c700d-1344-4d3e-9495-4f4e93cc8cce\"\r\n\t\t\t],\r\n\t\t\t\"requiredAuthScopes\": [\r\n\t\t\t\t{\r\n\t\t\t\t\t\"authServerAlias\": \"local\",\r\n\t\t\t\t\t\"scopeName\": \"scope1\"\r\n\t\t\t\t}\r\n\t\t\t]\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"id\": \"9f8f2cbb-e993-4935-aa3c-ee513c9badbb\",\r\n\t\t\t\"scopeName\": \"scopeMapping1\",\r\n\t\t\t\"scopeDescription\": \"scopeMapping1 description\",\r\n\t\t\t\"audience\": \"audienceName\",\r\n\t\t\t\"apiScopes\": [\r\n\t\t\t\t\"911c700d-1344-4d3e-9495-4f4e93cc8cce\"\r\n\t\t\t],\r\n\t\t\t\"requiredAuthScopes\": [\r\n\t\t\t\t{\r\n\t\t\t\t\t\"authServerAlias\": \"local\",\r\n\t\t\t\t\t\"scopeName\": \"scope1\"\r\n\t\t\t\t}\r\n\t\t\t]\r\n\t\t}\r\n\t]\r\n}" 1207 } 1208 }, 1209 "401": { 1210 "description": "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API." 1211 } 1212 } 1213 }, 1214 "post": { 1215 "security": [ 1216 { 1217 "Basic": [] 1218 } 1219 ], 1220 "description": "Use this method to create an OAuth scope mapping", 1221 "consumes": [ 1222 "application/json" 1223 ], 1224 "produces": [ 1225 "application/json" 1226 ], 1227 "operationId": "createOAuthScope", 1228 "parameters": [ 1229 { 1230 "x-examples": { 1231 "application/json": "{\r\n\t\"scopeName\": \"scopeMapping\",\r\n\t\"scopeDescription\": \"scopeMapping description\",\r\n\t\"apiScopes\": [\r\n\t\t\"911c700d-1344-4d3e-9495-4f4e93cc8cce\"\r\n\t],\r\n\t\"requiredAuthScopes\": [\r\n\t\t{\r\n\t\t\t\"authServerAlias\": \"local\",\r\n\t\t\t\"scopeName\": \"scope1\"\r\n\t\t}\r\n\t],\r\n\t\"audience\": \"audienceName\"\r\n}" 1232 }, 1233 "description": "This parameter describes the request payload of an OAuth scope that is to be created in API Gateway.", 1234 "name": "body", 1235 "in": "body", 1236 "required": true, 1237 "schema": { 1238 "$ref": "#/definitions/GatewayScope" 1239 } 1240 } 1241 ], 1242 "responses": { 1243 "201": { 1244 "description": "This status code indicates that the OAuth scope has been successfully created in API Gateway.", 1245 "schema": { 1246 "$ref": "#/definitions/GatewayScope" 1247 }, 1248 "examples": { 1249 "application/json": "{\r\n\t\"scope\": {\r\n\t\t\"id\": \"d550df0c-78c4-4139-918c-f354f77ccf9c\",\r\n\t\t\"scopeName\": \"scopeMapping\",\r\n\t\t\"scopeDescription\": \"scopeMapping description\",\r\n\t\t\"audience\": \"audienceName\",\r\n\t\t\"apiScopes\": [\r\n\t\t\t\"911c700d-1344-4d3e-9495-4f4e93cc8cce\"\r\n\t\t],\r\n\t\t\"requiredAuthScopes\": [\r\n\t\t\t{\r\n\t\t\t\t\"authServerAlias\": \"local\",\r\n\t\t\t\t\"scopeName\": \"scope1\"\r\n\t\t\t}\r\n\t\t]\r\n\t}\r\n}" 1250 } 1251 }, 1252 "400": { 1253 "description": "This status code indicates that the input values given in the request body is wrong." 1254 }, 1255 "401": { 1256 "description": "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API." 1257 } 1258 } 1259 } 1260 }, 1261 "/scopes/{oauthScopeId}": { 1262 "get": { 1263 "security": [ 1264 { 1265 "Basic": [] 1266 } 1267 ], 1268 "description": "This method retrieves the requested OAuth scope mapping. OAuth scope mappings map the authorization server scope with APIs or API scopes", 1269 "produces": [ 1270 "application/json" 1271 ], 1272 "operationId": "getOAuthScope", 1273 "parameters": [ 1274 { 1275 "type": "string", 1276 "description": "The path parameter specifies the id of an OAuth scope mapping that is to be retrieved from API Gateway.", 1277 "name": "oauthScopeId", 1278 "in": "path", 1279 "required": true 1280 } 1281 ], 1282 "responses": { 1283 "200": { 1284 "description": "This status code indicates that the details of the specified OAuth scope are retrieved successfully.", 1285 "schema": { 1286 "$ref": "#/definitions/GatewayScope" 1287 }, 1288 "examples": { 1289 "application/json": "{\r\n\t\"scope\": {\r\n\t\t\"id\": \"51143fe6-7790-4c58-aa66-e4f2f0f2e3cd\",\r\n\t\t\"scopeName\": \"scopeMapping1\",\r\n\t\t\"scopeDescription\": \"scopeMapping1\",\r\n\t\t\"audience\": \"\",\r\n\t\t\"apiScopes\": [\r\n\t\t\t\"911c700d-1344-4d3e-9495-4f4e93cc8cce\"\r\n\t\t],\r\n\t\t\"requiredAuthScopes\": [\r\n\t\t\t{\r\n\t\t\t\t\"authServerAlias\": \"local\",\r\n\t\t\t\t\"scopeName\": \"scope1\"\r\n\t\t\t}\r\n\t\t]\r\n\t}\r\n}" 1290 } 1291 }, 1292 "401": { 1293 "description": "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API." 1294 }, 1295 "404": { 1296 "description": "This status code indicates that an OAuth scope with the given ID could not be found in API Gateway." 1297 } 1298 } 1299 }, 1300 "put": { 1301 "security": [ 1302 { 1303 "Basic": [] 1304 } 1305 ], 1306 "description": "Use this method to update an OAuth scope mapping", 1307 "consumes": [ 1308 "application/json" 1309 ], 1310 "produces": [ 1311 "application/json" 1312 ], 1313 "operationId": "updateOAuthScope", 1314 "parameters": [ 1315 { 1316 "x-examples": { 1317 "application/json": "{\r\n\t\"scopeName\": \"scopeMapping1\",\r\n\t\"scopeDescription\": \"scopeMapping1 description\",\r\n\t\"apiScopes\": [\r\n\t\t\"911c700d-1344-4d3e-9495-4f4e93cc8cce\"\r\n\t],\r\n\t\"requiredAuthScopes\": [\r\n\t\t{\r\n\t\t\t\"authServerAlias\": \"local\",\r\n\t\t\t\"scopeName\": \"scope1\"\r\n\t\t}\r\n\t],\r\n\t\"audience\": \"\"\r\n}" 1318 }, 1319 "description": "This parameter describes the request payload of an OAuth scope that is to be updated in API Gateway.", 1320 "name": "body", 1321 "in": "body", 1322 "required": true, 1323 "schema": { 1324 "$ref": "#/definitions/GatewayScope" 1325 } 1326 }, 1327 { 1328 "type": "string", 1329 "description": "The path parameter specifies the id of an OAuth scope mapping that is to be updated in API Gateway.", 1330 "name": "oauthScopeId", 1331 "in": "path", 1332 "required": true 1333 } 1334 ], 1335 "responses": { 1336 "200": { 1337 "description": "This status code indicates that the OAuth scope has been successfully updated in API Gateway.", 1338 "schema": { 1339 "$ref": "#/definitions/GatewayScope" 1340 }, 1341 "examples": { 1342 "application/json": "{\r\n\t\"scope\": {\r\n\t\t\"id\": \"51143fe6-7790-4c58-aa66-e4f2f0f2e3cd\",\r\n\t\t\"scopeName\": \"scopeMapping1\",\r\n\t\t\"scopeDescription\": \"scopeMapping1\",\r\n\t\t\"audience\": \"\",\r\n\t\t\"apiScopes\": [\r\n\t\t\t\"911c700d-1344-4d3e-9495-4f4e93cc8cce\"\r\n\t\t],\r\n\t\t\"requiredAuthScopes\": [\r\n\t\t\t{\r\n\t\t\t\t\"authServerAlias\": \"local\",\r\n\t\t\t\t\"scopeName\": \"scope1\"\r\n\t\t\t}\r\n\t\t]\r\n\t}\r\n}" 1343 } 1344 }, 1345 "400": { 1346 "description": "This status code indicates that the input values given in the request body is wrong." 1347 }, 1348 "401": { 1349 "description": "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API." 1350 } 1351 } 1352 }, 1353 "delete": { 1354 "security": [ 1355 { 1356 "Basic": [] 1357 } 1358 ], 1359 "description": "This method deletes the requested OAuth scope mapping.", 1360 "produces": [ 1361 "application/json" 1362 ], 1363 "operationId": "deleteOAuthScope", 1364 "parameters": [ 1365 { 1366 "type": "string", 1367 "description": "The path parameter specifies the id of an OAuth scope mapping that is to be deleted from API Gateway.", 1368 "name": "oauthScopeId", 1369 "in": "path", 1370 "required": true 1371 } 1372 ], 1373 "responses": { 1374 "204": { 1375 "description": "This status code indicates that the specified OAuth scope has been successfully deleted from API Gateway." 1376 }, 1377 "401": { 1378 "description": "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API." 1379 }, 1380 "404": { 1381 "description": "This status code indicates that an OAuth scope with the given ID could not be found in API Gateway." 1382 } 1383 } 1384 } 1385 }, 1386 "/serviceRegistry/publish": { 1387 "get": { 1388 "security": [ 1389 { 1390 "Basic": [] 1391 } 1392 ], 1393 "description": "Retrieve the service registry publish information for the API", 1394 "produces": [ 1395 "application/json" 1396 ], 1397 "operationId": "getServiceRegistryPublishInfo", 1398 "parameters": [ 1399 { 1400 "type": "string", 1401 "x-example": "353bd366-47d4-4703-aecf-9cb40cdcc864", 1402 "description": "API Id of the API for which ServiceRegistryPublishInfo is to be fetched", 1403 "name": "apiId", 1404 "in": "query", 1405 "required": true 1406 } 1407 ], 1408 "responses": { 1409 "200": { 1410 "description": "Returns the service registry publish info for the API", 1411 "schema": { 1412 "$ref": "#/definitions/ServiceRegistryPublishGetResponse" 1413 }, 1414 "examples": { 1415 "application/json": "{\r\n \"publishInfo\": {\r\n \"apiId\": \"afe8b72e-e1a5-47c6-9b43-e7f12858c091\",\r\n \"serviceRegistryPublishInfo\": [\r\n {\r\n \"serviceRegistryId\": \"aec973cd-1e4c-4a93-93a4-950e32d39156\",\r\n \"status\": \"PUBLISHED\",\r\n \"name\": \"MyServiceConsul\",\r\n \"gatewayEndpoints\": [\r\n {\r\n \"gatewayEndpoint\": \"http://localhost:5555/ws/calc/1\",\r\n \"status\": \"PUBLISHED\"\r\n },\r\n {\r\n \"gatewayEndpoint\": \"http://localhost:1111/ws/calc/1\",\r\n \"status\": \"NEW\"\r\n }\r\n ]\r\n }\r\n ]\r\n }\r\n}" 1416 } 1417 }, 1418 "401": { 1419 "description": "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API." 1420 }, 1421 "404": { 1422 "description": "This status code indicates that Publish Info for the apiId specified is not found in API Gateway" 1423 } 1424 } 1425 }, 1426 "put": { 1427 "security": [ 1428 { 1429 "Basic": [] 1430 } 1431 ], 1432 "description": "Publish one or more APIs to one or more service registries", 1433 "produces": [ 1434 "application/json" 1435 ], 1436 "operationId": "publishToServiceRegistry", 1437 "parameters": [ 1438 { 1439 "x-examples": { 1440 "application/json": "{\r\n \"publishInfo\": {\r\n \"serviceRegistryPublishInfo\": [\r\n {\r\n \"gatewayEndpoints\": [\r\n {\r\n \"gatewayEndpoint\": \"http://localhost:5555/ws/calc/1\"\r\n }\r\n ],\r\n \"serviceRegistryId\": \"aec973cd-1e4c-4a93-93a4-950e32d39156\"\r\n }\r\n ],\r\n \"apiId\": \"afe8b72e-e1a5-47c6-9b43-e7f12858c091\"\r\n }\r\n}" 1441 }, 1442 "description": "Service registry publish payload", 1443 "name": "body", 1444 "in": "body", 1445 "required": true, 1446 "schema": { 1447 "$ref": "#/definitions/InputServiceRegistryPublish" 1448 } 1449 } 1450 ], 1451 "responses": { 1452 "200": { 1453 "description": "Returns the status of the publish operations given in the request.", 1454 "schema": { 1455 "$ref": "#/definitions/ServiceRegistryPublishPutResponse" 1456 }, 1457 "examples": { 1458 "application/json": "{\r\n \"publishResponse\": {\r\n \"apiId\": \"afe8b72e-e1a5-47c6-9b43-e7f12858c091\",\r\n \"apiName\": \"CalcService\",\r\n \"apiVersion\": \"10.3\",\r\n \"serviceRegistryPublishResponses\": [\r\n {\r\n \"serviceRegistryId\": \"aec973cd-1e4c-4a93-93a4-950e32d39156\",\r\n \"serviceRegistryName\": \"MyServiceConsul\",\r\n \"status\": \"PUBLISHED\",\r\n \"gatewayEndpoints\": [\r\n {\r\n \"gatewayEndpoint\": \"http://localhost:5555/ws/calc/1\",\r\n \"status\": \"PUBLISHED\",\r\n }\r\n ],\r\n \"success\": true,\r\n \"description\": \"Publish successful\"\r\n }\r\n ]\r\n }\r\n}" 1459 } 1460 }, 1461 "400": { 1462 "description": "This status code indicates an invalid request body" 1463 }, 1464 "401": { 1465 "description": "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API." 1466 }, 1467 "404": { 1468 "description": "This status code indicates that API with given apiId is not found in API Gateway" 1469 } 1470 } 1471 } 1472 }, 1473 "/serviceRegistry/unpublish": { 1474 "put": { 1475 "security": [ 1476 { 1477 "Basic": [] 1478 } 1479 ], 1480 "description": "Unpublish one or more APIs from one or more service registries", 1481 "produces": [ 1482 "application/json" 1483 ], 1484 "operationId": "unpublishFromServiceRegistry", 1485 "parameters": [ 1486 { 1487 "x-examples": { 1488 "application/json": "{\r\n \"unpublishInfo\": {\r\n \"serviceRegistryIds\": [\r\n \"aec973cd-1e4c-4a93-93a4-950e32d39156\"\r\n ],\r\n \"apiId\": \"afe8b72e-e1a5-47c6-9b43-e7f12858c091\"\r\n },\r\n \"forceUnpublish\": false\r\n}ds" 1489 }, 1490 "description": "Service registry unpublish payload", 1491 "name": "body", 1492 "in": "body", 1493 "required": true, 1494 "schema": { 1495 "$ref": "#/definitions/InputServiceRegistryUnpublish" 1496 } 1497 } 1498 ], 1499 "responses": { 1500 "200": { 1501 "description": "Returns the service registry unpublish response", 1502 "schema": { 1503 "$ref": "#/definitions/ServiceRegistryUnpublishPutResponse" 1504 }, 1505 "examples": { 1506 "application/json": "{\r\n \"unpublishResponse\": {\r\n \"apiId\": \"afe8b72e-e1a5-47c6-9b43-e7f12858c091\",\r\n \"apiName\": \"CalcService\",\r\n \"apiVersion\": \"10.3\",\r\n \"serviceRegistryUnpublishResponses\": [\r\n {\r\n \"serviceRegistryId\": \"aec973cd-1e4c-4a93-93a4-950e32d39156\",\r\n \"serviceRegistryName\": \"MyServiceConsul\",\r\n \"success\": true,\r\n \"description\": \" Unpublish successful\"\r\n }\r\n ]\r\n }\r\n}" 1507 } 1508 }, 1509 "401": { 1510 "description": "This status code indicates that either user didn't provide right credentials or user doesn't have required privileges to access this API." 1511 } 1512 } 1513 } 1514 } 1515 }, 1516 "definitions": { 1517 "API": { 1518 "type": "object", 1519 "properties": { 1520 "apiTags": { 1521 "type": "array", 1522 "items": { 1523 "type": "string" 1524 } 1525 }, 1526 "description": { 1527 "type": "string" 1528 }, 1529 "serviceRegistryDisplayName": { 1530 "type": "string" 1531 }, 1532 "tags": { 1533 "type": "array", 1534 "items": { 1535 "$ref": "#/definitions/Tag" 1536 } 1537 }, 1538 "title": { 1539 "type": "string" 1540 }, 1541 "type": { 1542 "type": "string" 1543 }, 1544 "uri": { 1545 "type": "array", 1546 "uniqueItems": true, 1547 "items": { 1548 "type": "string" 1549 } 1550 }, 1551 "version": { 1552 "type": "string" 1553 } 1554 }, 1555 "discriminator": "type" 1556 }, 1557 "APIAccessKey": { 1558 "type": "object", 1559 "properties": { 1560 "apiAccessKey": { 1561 "description": "API access key", 1562 "type": "string" 1563 }, 1564 "expirationDate": { 1565 "description": "expiration date of the api key", 1566 "type": "string" 1567 }, 1568 "expirationInterval": { 1569 "description": "expiration interval of the api key", 1570 "type": "string" 1571 } 1572 } 1573 }, 1574 "APIResponse": { 1575 "type": "object", 1576 "properties": { 1577 "api": { 1578 "$ref": "#/definitions/GatewayAPI" 1579 }, 1580 "apiId": { 1581 "type": "string" 1582 }, 1583 "errorReason": { 1584 "type": "string" 1585 }, 1586 "gatewayEndPointList": { 1587 "type": "array", 1588 "items": { 1589 "$ref": "#/definitions/APIResponseGatewayEndpoint" 1590 } 1591 }, 1592 "gatewayEndPoints": { 1593 "type": "array", 1594 "items": { 1595 "type": "string" 1596 } 1597 }, 1598 "microgatewayEndPoints": { 1599 "type": "array", 1600 "items": { 1601 "type": "string" 1602 } 1603 }, 1604 "portalGatewayDataEntries": { 1605 "type": "object" 1606 }, 1607 "pubSOAPFlavor": { 1608 "type": "string" 1609 }, 1610 "reason": { 1611 "type": "object" 1612 }, 1613 "responseStatus": { 1614 "type": "string", 1615 "enum": [ 1616 "SUCCESS", 1617 "ERROR", 1618 "NOT_FOUND", 1619 "BAD_REQUEST", 1620 "PARTIAL_SUCCESS" 1621 ] 1622 }, 1623 "restrictViewAsset": { 1624 "type": "boolean" 1625 }, 1626 "rootFileLocation": { 1627 "type": "string" 1628 }, 1629 "teams": { 1630 "type": "array", 1631 "items": { 1632 "$ref": "#/definitions/Team" 1633 } 1634 } 1635 } 1636 }, 1637 "APIResponseCreate": { 1638 "type": "object", 1639 "properties": { 1640 "api": { 1641 "$ref": "#/definitions/GatewayAPI" 1642 }, 1643 "apiId": { 1644 "type": "string" 1645 }, 1646 "errorReason": { 1647 "type": "string" 1648 }, 1649 "responseStatus": { 1650 "type": "string", 1651 "enum": [ 1652 "SUCCESS", 1653 "ERROR", 1654 "NOT_FOUND", 1655 "BAD_REQUEST", 1656 "PARTIAL_SUCCESS" 1657 ] 1658 } 1659 } 1660 }, 1661 "APIResponseDelete": { 1662 "type": "object", 1663 "properties": { 1664 "apiId": { 1665 "type": "string" 1666 }, 1667 "errorReason": { 1668 "type": "string" 1669 }, 1670 "responseStatus": { 1671 "type": "string", 1672 "enum": [ 1673 "SUCCESS", 1674 "ERROR", 1675 "NOT_FOUND", 1676 "BAD_REQUEST", 1677 "PARTIAL_SUCCESS" 1678 ] 1679 } 1680 } 1681 }, 1682 "APIResponseGatewayEndpoint": { 1683 "type": "object", 1684 "properties": { 1685 "endpoint": { 1686 "type": "string" 1687 }, 1688 "endpointDisplayName": { 1689 "type": "string" 1690 }, 1691 "endpointName": { 1692 "type": "string" 1693 }, 1694 "endpointType": { 1695 "type": "string", 1696 "enum": [ 1697 "DEFAULT", 1698 "GLOBAL", 1699 "API_LEVEL", 1700 "MICRO_GATEWAY" 1701 ] 1702 }, 1703 "endpointUrls": { 1704 "type": "array", 1705 "items": { 1706 "type": "string" 1707 } 1708 } 1709 } 1710 }, 1711 "APIResponseGetAPI": { 1712 "type": "object", 1713 "properties": { 1714 "api": { 1715 "$ref": "#/definitions/GatewayAPI" 1716 }, 1717 "apiId": { 1718 "type": "string" 1719 }, 1720 "errorReason": { 1721 "type": "string" 1722 }, 1723 "gatewayEndPoints": { 1724 "type": "array", 1725 "items": { 1726 "type": "string" 1727 } 1728 }, 1729 "responseStatus": { 1730 "type": "string", 1731 "enum": [ 1732 "SUCCESS", 1733 "ERROR", 1734 "NOT_FOUND", 1735 "BAD_REQUEST", 1736 "PARTIAL_SUCCESS" 1737 ] 1738 }, 1739 "versions": { 1740 "type": "array", 1741 "items": { 1742 "$ref": "#/definitions/Version" 1743 } 1744 } 1745 } 1746 }, 1747 "APIResponseGetAPIs": { 1748 "description": "This model contains the basics details of an API.", 1749 "type": "object", 1750 "properties": { 1751 "active": { 1752 "type": "boolean" 1753 }, 1754 "apiId": { 1755 "type": "string" 1756 }, 1757 "apiName": { 1758 "description": "API Name", 1759 "type": "string" 1760 }, 1761 "apiVersion": { 1762 "description": "API Version", 1763 "type": "string" 1764 }, 1765 "errorReason": { 1766 "type": "string" 1767 }, 1768 "id": { 1769 "description": "API Id", 1770 "type": "string" 1771 }, 1772 "publishedPortals": { 1773 "description": "Published portals of an API", 1774 "type": "array", 1775 "items": { 1776 "type": "string" 1777 } 1778 }, 1779 "responseStatus": { 1780 "type": "string", 1781 "enum": [ 1782 "SUCCESS", 1783 "ERROR", 1784 "NOT_FOUND", 1785 "BAD_REQUEST", 1786 "PARTIAL_SUCCESS" 1787 ] 1788 }, 1789 "systemVersion": { 1790 "description": "System version of an API", 1791 "type": "integer", 1792 "format": "int32" 1793 }, 1794 "teams": { 1795 "description": "Contains teams belonging to an API.", 1796 "type": "array", 1797 "items": { 1798 "$ref": "#/definitions/Team" 1799 } 1800 }, 1801 "type": { 1802 "description": "API Type", 1803 "type": "string" 1804 } 1805 } 1806 }, 1807 "APIResponseGetGlobalPolicies": { 1808 "type": "object", 1809 "properties": { 1810 "globalPolicies": { 1811 "type": "array", 1812 "items": { 1813 "type": "string" 1814 } 1815 } 1816 } 1817 }, 1818 "APIResponseModel": { 1819 "description": "This model contains the basics details of an API.", 1820 "type": "object", 1821 "properties": { 1822 "api": { 1823 "$ref": "#/definitions/APIResponseGetAPIs" 1824 }, 1825 "responseStatus": { 1826 "description": "Response status", 1827 "type": "string", 1828 "enum": [ 1829 "CREATED", 1830 "SUCCESS", 1831 "ERROR", 1832 "UNEXPECTED_ERROR", 1833 "NOT_FOUND", 1834 "NO_CONTENT", 1835 "LOCKED", 1836 "UPDATED", 1837 "ACTIVATED", 1838 "DEACTIVATED", 1839 "PUBLISHED", 1840 "UNPUBLISHED" 1841 ] 1842 } 1843 } 1844 }, 1845 "APIResponsesModel": { 1846 "description": "This model contains the basics details of all APIs.", 1847 "type": "object", 1848 "properties": { 1849 "apiResponse": { 1850 "description": "API Response", 1851 "type": "array", 1852 "items": { 1853 "$ref": "#/definitions/APIResponseModel" 1854 } 1855 } 1856 } 1857 }, 1858 "AbstractParameter": { 1859 "type": "object", 1860 "properties": { 1861 "allowEmptyValue": { 1862 "description": "Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a parameter with an empty value", 1863 "type": "boolean" 1864 }, 1865 "description": { 1866 "description": "A brief description of the parameter. This could contain examples of use", 1867 "type": "string" 1868 }, 1869 "get$ref": { 1870 "description": "The available paths and operations for the API", 1871 "type": "string" 1872 }, 1873 "in": { 1874 "description": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\"", 1875 "type": "string" 1876 }, 1877 "name": { 1878 "description": "The name of the parameter. Parameter names are case sensitive", 1879 "type": "string" 1880 }, 1881 "required": { 1882 "description": "Determines whether this parameter is mandatory. If the parameter location is \"path\", this property is REQUIRED and its value MUST be true. Otherwise, the property MAY be included and its default value is false", 1883 "type": "boolean" 1884 }, 1885 "vendorExtensions": { 1886 "type": "object", 1887 "additionalProperties": { 1888 "type": "object" 1889 } 1890 } 1891 } 1892 }, 1893 "ActionImport": { 1894 "type": "object", 1895 "properties": { 1896 "action": { 1897 "type": "string" 1898 }, 1899 "enabled": { 1900 "type": "boolean" 1901 } 1902 } 1903 }, 1904 "Application": { 1905 "type": "object", 1906 "properties": { 1907 "accessTokens": { 1908 "$ref": "#/definitions/ApplicationToken" 1909 }, 1910 "applicationID": { 1911 "description": "unique identifier of an application", 1912 "type": "string" 1913 }, 1914 "authStrategyIds": { 1915 "description": "Contains a list of JWT/Oauth/OpenID authentication strategy ids associated to the application", 1916 "type": "array", 1917 "uniqueItems": true, 1918 "items": { 1919 "type": "string" 1920 } 1921 }, 1922 "contactEmails": { 1923 "description": "list of email contacts", 1924 "type": "array", 1925 "items": { 1926 "type": "string" 1927 } 1928 }, 1929 "creationDate": { 1930 "description": "application creation time", 1931 "type": "string" 1932 }, 1933 "description": { 1934 "description": "description of the application", 1935 "type": "string" 1936 }, 1937 "iconbyteArray": { 1938 "description": "application icon byte array", 1939 "type": "string" 1940 }, 1941 "identifiers": { 1942 "description": "list of all application identifiers", 1943 "type": "array", 1944 "items": { 1945 "$ref": "#/definitions/ApplicationIdentifier" 1946 } 1947 }, 1948 "isSuspended": { 1949 "description": "holds the suspended state of an application", 1950 "type": "boolean" 1951 }, 1952 "jsOrigins": { 1953 "description": "list of all javascript origins", 1954 "type": "array", 1955 "items": { 1956 "type": "string" 1957 } 1958 }, 1959 "lastModified": { 1960 "description": "last modified time of the application", 1961 "type": "string" 1962 }, 1963 "lastUpdated": { 1964 "description": "last modified time of the application in milliseconds", 1965 "type": "integer", 1966 "format": "int64" 1967 }, 1968 "name": { 1969 "description": "name of the application", 1970 "type": "string" 1971 }, 1972 "owner": { 1973 "description": "owner of the application", 1974 "type": "string" 1975 }, 1976 "primaryNode": { 1977 "$ref": "#/definitions/Node" 1978 }, 1979 "shell": { 1980 "type": "boolean" 1981 }, 1982 "siteURLs": { 1983 "description": "list of all site URLs", 1984 "type": "array", 1985 "items": { 1986 "type": "string" 1987 } 1988 }, 1989 "subscription": { 1990 "type": "boolean" 1991 }, 1992 "version": { 1993 "type": "string" 1994 } 1995 } 1996 }, 1997 "ApplicationIdentifier": { 1998 "type": "object", 1999 "properties": { 2000 "id": { 2001 "description": "unique identifier of the application identifier", 2002 "type": "string" 2003 }, 2004 "key": { 2005 "description": "identifier type", 2006 "type": "string" 2007 }, 2008 "name": { 2009 "description": "name of the identifier", 2010 "type": "string" 2011 }, 2012 "value": { 2013 "description": "list of identifier values", 2014 "type": "array", 2015 "items": { 2016 "type": "string" 2017 } 2018 } 2019 } 2020 }, 2021 "ApplicationToken": { 2022 "type": "object", 2023 "properties": { 2024 "apiAccessKey": { 2025 "$ref": "#/definitions/APIAccessKey" 2026 }, 2027 "oauth2Token": { 2028 "$ref": "#/definitions/OAuth2Token" 2029 } 2030 } 2031 }, 2032 "ArrayModel": { 2033 "allOf": [ 2034 { 2035 "$ref": "#/definitions/Model" 2036 }, 2037 { 2038 "type": "object", 2039 "properties": { 2040 "items": { 2041 "$ref": "#/definitions/Property" 2042 }, 2043 "maxItems": { 2044 "type": "integer", 2045 "format": "int32" 2046 }, 2047 "minItems": { 2048 "type": "integer", 2049 "format": "int32" 2050 } 2051 } 2052 } 2053 ] 2054 }, 2055 "ArrayProperty": { 2056 "allOf": [ 2057 { 2058 "$ref": "#/definitions/Property" 2059 }, 2060 { 2061 "type": "object", 2062 "properties": { 2063 "items": { 2064 "$ref": "#/definitions/Property" 2065 }, 2066 "maxItems": { 2067 "type": "integer", 2068 "format": "int32" 2069 }, 2070 "minItems": { 2071 "type": "integer", 2072 "format": "int32" 2073 }, 2074 "uniqueItems": { 2075 "type": "boolean" 2076 } 2077 } 2078 } 2079 ] 2080 }, 2081 "ArraySchema": { 2082 "allOf": [ 2083 { 2084 "$ref": "#/definitions/Schema" 2085 }, 2086 { 2087 "type": "object", 2088 "properties": { 2089 "items": { 2090 "$ref": "#/definitions/Schema" 2091 } 2092 } 2093 } 2094 ] 2095 }, 2096 "AuthServerScope": { 2097 "description": "Represents the oauth scope from an authorization server", 2098 "type": "object", 2099 "properties": { 2100 "authServerAlias": { 2101 "description": "Name of the authorization server", 2102 "type": "string" 2103 }, 2104 "scopeName": { 2105 "description": "OAuth scope name from authorization server definition", 2106 "type": "string" 2107 } 2108 } 2109 }, 2110 "AuthorizationValue": { 2111 "type": "object", 2112 "properties": { 2113 "keyName": { 2114 "type": "string" 2115 }, 2116 "type": { 2117 "type": "string" 2118 }, 2119 "value": { 2120 "type": "string" 2121 } 2122 } 2123 }, 2124 "BaseIntegerProperty": { 2125 "allOf": [ 2126 { 2127 "$ref": "#/definitions/Property" 2128 }, 2129 { 2130 "type": "object", 2131 "properties": { 2132 "exclusiveMaximum": { 2133 "type": "boolean" 2134 }, 2135 "exclusiveMinimum": { 2136 "type": "boolean" 2137 }, 2138 "maximum": { 2139 "type": "number" 2140 }, 2141 "minimum": { 2142 "type": "number" 2143 }, 2144 "multipleOf": { 2145 "type": "number" 2146 } 2147 } 2148 } 2149 ] 2150 }, 2151 "BodyParameter": { 2152 "allOf": [ 2153 { 2154 "$ref": "#/definitions/Parameter" 2155 }, 2156 { 2157 "type": "object", 2158 "properties": { 2159 "schema": { 2160 "type": "object", 2161 "additionalProperties": { 2162 "$ref": "#/definitions/Model" 2163 } 2164 } 2165 } 2166 } 2167 ] 2168 }, 2169 "BooleanProperty": { 2170 "allOf": [ 2171 { 2172 "$ref": "#/definitions/Property" 2173 }, 2174 { 2175 "type": "object", 2176 "properties": { 2177 "enum": { 2178 "type": "array", 2179 "items": { 2180 "type": "boolean" 2181 } 2182 } 2183 } 2184 } 2185 ] 2186 }, 2187 "BooleanSchema": { 2188 "allOf": [ 2189 { 2190 "$ref": "#/definitions/Schema" 2191 }, 2192 { 2193 "type": "object" 2194 } 2195 ] 2196 }, 2197 "Callback": { 2198 "type": "object", 2199 "properties": { 2200 "callbacksMap": { 2201 "description": "A Path Item Object used to define a callback request and expected responses", 2202 "type": "object", 2203 "additionalProperties": { 2204 "$ref": "#/definitions/Path" 2205 } 2206 }, 2207 "get$ref": { 2208 "type": "string" 2209 }, 2210 "vendorExtensions": { 2211 "type": "object", 2212 "additionalProperties": { 2213 "type": "object" 2214 } 2215 } 2216 } 2217 }, 2218 "CommandInfo": { 2219 "type": "object", 2220 "properties": { 2221 "commandClass": { 2222 "type": "string" 2223 }, 2224 "commandName": { 2225 "type": "string" 2226 } 2227 } 2228 }, 2229 "Components": { 2230 "type": "object", 2231 "properties": { 2232 "callbacks": { 2233 "description": "An object to hold reusable callback objects", 2234 "type": "object", 2235 "additionalProperties": { 2236 "$ref": "#/definitions/Callback" 2237 } 2238 }, 2239 "examples": { 2240 "description": "An object to hold reusable example objects", 2241 "type": "object", 2242 "additionalProperties": { 2243 "$ref": "#/definitions/Example" 2244 } 2245 }, 2246 "headers": { 2247 "description": "An object to hold reusable header objects", 2248 "type": "object", 2249 "additionalProperties": { 2250 "$ref": "#/definitions/Header" 2251 } 2252 }, 2253 "links": { 2254 "description": "An object to hold reusable link objects", 2255 "type": "object", 2256 "additionalProperties": { 2257 "$ref": "#/definitions/Link" 2258 } 2259 }, 2260 "parameters": { 2261 "description": "An object to hold reusable parameter objects", 2262 "type": "object", 2263 "additionalProperties": { 2264 "$ref": "#/definitions/Parameter" 2265 } 2266 }, 2267 "requestBodies": { 2268 "description": "An object to hold reusable requestBody objects", 2269 "type": "object", 2270 "additionalProperties": { 2271 "$ref": "#/definitions/RequestBody" 2272 } 2273 }, 2274 "responses": { 2275 "description": "An object to hold reusable response objects", 2276 "type": "object", 2277 "additionalProperties": { 2278 "$ref": "#/definitions/Response" 2279 } 2280 }, 2281 "schemas": { 2282 "description": "An object to hold reusable schema objects", 2283 "type": "object", 2284 "additionalProperties": { 2285 "$ref": "#/definitions/Schema" 2286 } 2287 }, 2288 "securitySchemes": { 2289 "description": "An object to hold reusable securityScheme objects", 2290 "type": "object", 2291 "additionalProperties": { 2292 "$ref": "#/definitions/SecurityScheme" 2293 } 2294 }, 2295 "vendorExtensions": { 2296 "type": "object", 2297 "additionalProperties": { 2298 "type": "object" 2299 } 2300 } 2301 } 2302 }, 2303 "ComposedModel": { 2304 "allOf": [ 2305 { 2306 "$ref": "#/definitions/Model" 2307 }, 2308 { 2309 "type": "object", 2310 "properties": { 2311 "allOf": { 2312 "type": "array", 2313 "items": { 2314 "$ref": "#/definitions/Model" 2315 } 2316 }, 2317 "anyOf": { 2318 "type": "array", 2319 "items": { 2320 "$ref": "#/definitions/Model" 2321 } 2322 }, 2323 "child": { 2324 "$ref": "#/definitions/Model" 2325 }, 2326 "interfaces": { 2327 "type": "array", 2328 "items": { 2329 "$ref": "#/definitions/Model" 2330 } 2331 }, 2332 "oneOf": { 2333 "type": "array", 2334 "items": { 2335 "$ref": "#/definitions/Model" 2336 } 2337 }, 2338 "parent": { 2339 "$ref": "#/definitions/Model" 2340 } 2341 } 2342 } 2343 ] 2344 }, 2345 "ComposedProperty": { 2346 "allOf": [ 2347 { 2348 "$ref": "#/definitions/Property" 2349 }, 2350 { 2351 "type": "object", 2352 "properties": { 2353 "allOf": { 2354 "type": "array", 2355 "items": { 2356 "$ref": "#/definitions/Property" 2357 } 2358 }, 2359 "anyOf": { 2360 "type": "array", 2361 "items": { 2362 "$ref": "#/definitions/Property" 2363 } 2364 }, 2365 "oneOf": { 2366 "type": "array", 2367 "items": { 2368 "$ref": "#/definitions/Property" 2369 } 2370 } 2371 } 2372 } 2373 ] 2374 }, 2375 "ComposedSchema": { 2376 "allOf": [ 2377 { 2378 "$ref": "#/definitions/Schema" 2379 }, 2380 { 2381 "type": "object", 2382 "properties": { 2383 "allOf": { 2384 "description": "Must be valid against all of the subschemas", 2385 "type": "array", 2386 "items": { 2387 "$ref": "#/definitions/Schema" 2388 } 2389 }, 2390 "anyOf": { 2391 "description": "Must be valid against any of the subschemas", 2392 "type": "array", 2393 "items": { 2394 "$ref": "#/definitions/Schema" 2395 } 2396 }, 2397 "oneOf": { 2398 "description": "Must be valid against exactly one of the subschemas", 2399 "type": "array", 2400 "items": { 2401 "$ref": "#/definitions/Schema" 2402 } 2403 } 2404 } 2405 } 2406 ] 2407 }, 2408 "Contact": { 2409 "type": "object", 2410 "properties": { 2411 "email": { 2412 "description": "The email address of the contact person/organization", 2413 "type": "string" 2414 }, 2415 "name": { 2416 "description": "The identifying name of the contact person/organization", 2417 "type": "string" 2418 }, 2419 "url": { 2420 "description": "The URL pointing to the contact information", 2421 "type": "string" 2422 } 2423 } 2424 }, 2425 "CookieParameter": { 2426 "allOf": [ 2427 { 2428 "$ref": "#/definitions/Parameter" 2429 }, 2430 { 2431 "type": "object" 2432 } 2433 ] 2434 }, 2435 "DataFlavor": { 2436 "type": "object", 2437 "properties": { 2438 "defaultRepresentationClassAsString": { 2439 "type": "string" 2440 }, 2441 "flavorJavaFileListType": { 2442 "type": "boolean" 2443 }, 2444 "flavorRemoteObjectType": { 2445 "type": "boolean" 2446 }, 2447 "flavorSerializedObjectType": { 2448 "type": "boolean" 2449 }, 2450 "flavorTextType": { 2451 "type": "boolean" 2452 }, 2453 "humanPresentableName": { 2454 "type": "string" 2455 }, 2456 "mimeType": { 2457 "type": "string" 2458 }, 2459 "mimeTypeSerializedObject": { 2460 "type": "boolean" 2461 }, 2462 "primaryType": { 2463 "type": "string" 2464 }, 2465 "representationClassByteBuffer": { 2466 "type": "boolean" 2467 }, 2468 "representationClassCharBuffer": { 2469 "type": "boolean" 2470 }, 2471 "representationClassInputStream": { 2472 "type": "boolean" 2473 }, 2474 "representationClassReader": { 2475 "type": "boolean" 2476 }, 2477 "representationClassRemote": { 2478 "type": "boolean" 2479 }, 2480 "representationClassSerializable": { 2481 "type": "boolean" 2482 }, 2483 "subType": { 2484 "type": "string" 2485 } 2486 } 2487 }, 2488 "DataHandler": { 2489 "type": "object", 2490 "properties": { 2491 "allCommands": { 2492 "type": "array", 2493 "items": { 2494 "$ref": "#/definitions/CommandInfo" 2495 } 2496 }, 2497 "content": { 2498 "type": "object" 2499 }, 2500 "contentType": { 2501 "type": "string" 2502 }, 2503 "dataSource": { 2504 "$ref": "#/definitions/DataSource" 2505 }, 2506 "inputStream": { 2507 "$ref": "#/definitions/InputStream" 2508 }, 2509 "name": { 2510 "type": "string" 2511 }, 2512 "outputStream": { 2513 "$ref": "#/definitions/OutputStream" 2514 }, 2515 "preferredCommands": { 2516 "type": "array", 2517 "items": { 2518 "$ref": "#/definitions/CommandInfo" 2519 } 2520 }, 2521 "transferDataFlavors": { 2522 "type": "array", 2523 "items": { 2524 "$ref": "#/definitions/DataFlavor" 2525 } 2526 } 2527 } 2528 }, 2529 "DataSource": { 2530 "type": "object", 2531 "properties": { 2532 "contentType": { 2533 "type": "string" 2534 }, 2535 "inputStream": { 2536 "$ref": "#/definitions/InputStream" 2537 }, 2538 "name": { 2539 "type": "string" 2540 }, 2541 "outputStream": { 2542 "$ref": "#/definitions/OutputStream" 2543 } 2544 } 2545 }, 2546 "DateTimeProperty": { 2547 "allOf": [ 2548 { 2549 "$ref": "#/definitions/Property" 2550 }, 2551 { 2552 "type": "object", 2553 "properties": { 2554 "enum": { 2555 "type": "array", 2556 "items": { 2557 "type": "object" 2558 } 2559 } 2560 } 2561 } 2562 ] 2563 }, 2564 "DecimalProperty": { 2565 "allOf": [ 2566 { 2567 "$ref": "#/definitions/Property" 2568 }, 2569 { 2570 "type": "object", 2571 "properties": { 2572 "exclusiveMaximum": { 2573 "type": "boolean" 2574 }, 2575 "exclusiveMinimum": { 2576 "type": "boolean" 2577 }, 2578 "maximum": { 2579 "type": "number" 2580 }, 2581 "minimum": { 2582 "type": "number" 2583 }, 2584 "multipleOf": { 2585 "type": "number" 2586 } 2587 } 2588 } 2589 ] 2590 }, 2591 "Endpoint": { 2592 "type": "object", 2593 "properties": { 2594 "alias": { 2595 "type": "boolean" 2596 }, 2597 "connectionTimeoutDuration": { 2598 "type": "integer", 2599 "format": "int32" 2600 }, 2601 "optimizationTechnique": { 2602 "type": "string" 2603 }, 2604 "passSecurityHeaders": { 2605 "type": "boolean" 2606 }, 2607 "uri": { 2608 "type": "string" 2609 } 2610 } 2611 }, 2612 "Endpoints": { 2613 "description": "This defines the service registry publish information for API Gateway's API endpoints", 2614 "type": "object", 2615 "properties": { 2616 "gatewayEndpoint": { 2617 "description": "API's access endpoint exposed in API Gateway.", 2618 "type": "string" 2619 }, 2620 "status": { 2621 "description": "Status of the API endpoint. Shows whether this endpoint is published to the service registry.Possible values are NEW, PUBLISHED and SUSPENDED. NEW represents the endpoint is not published to the service registry. PUBLISHED represents the endpoint is published to the service registry. SUSPENDED represents the endpoint is published to service registry, but is not currently active (for example: during deactivation of API or shutdown of API Gateway or disabling ports).", 2622 "type": "string", 2623 "enum": [ 2624 "NEW", 2625 "PUBLISHED", 2626 "SUSPENDED" 2627 ] 2628 } 2629 } 2630 }, 2631 "EntitySet": { 2632 "type": "object", 2633 "properties": { 2634 "enabled": { 2635 "type": "boolean" 2636 }, 2637 "entityType": { 2638 "type": "string" 2639 }, 2640 "parameters": { 2641 "type": "object", 2642 "additionalProperties": { 2643 "type": "array", 2644 "items": { 2645 "type": "string" 2646 } 2647 } 2648 } 2649 } 2650 }, 2651 "EntityType": { 2652 "type": "object", 2653 "properties": { 2654 "methods": { 2655 "type": "object", 2656 "additionalProperties": { 2657 "$ref": "#/definitions/MethodParameters" 2658 } 2659 }, 2660 "navigationProperties": { 2661 "type": "object", 2662 "additionalProperties": { 2663 "$ref": "#/definitions/EntitySet" 2664 } 2665 }, 2666 "properties": { 2667 "type": "object", 2668 "additionalProperties": { 2669 "type": "object" 2670 } 2671 } 2672 } 2673 }, 2674 "Enumeration": { 2675 "type": "object" 2676 }, 2677 "Example": { 2678 "type": "object", 2679 "properties": { 2680 "description": { 2681 "description": "Long description for the example", 2682 "type": "string" 2683 }, 2684 "externalValue": { 2685 "description": "A URL that points to the literal example. This provides the capability to reference examples that cannot easily be included in JSON or YAML documents. The value field and externalValue field are mutually exclusive", 2686 "type": "string" 2687 }, 2688 "get$ref": { 2689 "type": "string" 2690 }, 2691 "summary": { 2692 "description": "Short description for the example", 2693 "type": "string" 2694 }, 2695 "value": { 2696 "description": "Embedded literal example. The value field and externalValue field are mutually exclusive. To represent examples of media types that cannot naturally represented in JSON or YAML, use a string value to contain the example, escaping where necessary", 2697 "type": "object" 2698 }, 2699 "vendorExtensions": { 2700 "type": "object", 2701 "additionalProperties": { 2702 "type": "object" 2703 } 2704 } 2705 } 2706 }, 2707 "ExternalDocs": { 2708 "type": "object", 2709 "properties": { 2710 "description": { 2711 "description": "A short description of the target documentation", 2712 "type": "string" 2713 }, 2714 "url": { 2715 "description": "The URL for the target documentation", 2716 "type": "string" 2717 }, 2718 "vendorExtensions": { 2719 "type": "object", 2720 "additionalProperties": { 2721 "type": "object" 2722 } 2723 } 2724 } 2725 }, 2726 "FormParameter": { 2727 "allOf": [ 2728 { 2729 "$ref": "#/definitions/Parameter" 2730 }, 2731 { 2732 "type": "object" 2733 } 2734 ] 2735 }, 2736 "FunctionImport": { 2737 "type": "object", 2738 "properties": { 2739 "enabled": { 2740 "type": "boolean" 2741 }, 2742 "function": { 2743 "type": "string" 2744 } 2745 } 2746 }, 2747 "GatewayAPI": { 2748 "type": "object", 2749 "properties": { 2750 "apiDefinition": { 2751 "$ref": "#/definitions/API" 2752 }, 2753 "apiDescription": { 2754 "type": "string" 2755 }, 2756 "apiDocuments": { 2757 "type": "array", 2758 "items": { 2759 "type": "string" 2760 } 2761 }, 2762 "apiEndpointPrefix": { 2763 "type": "string" 2764 }, 2765 "apiGroups": { 2766 "type": "array", 2767 "items": { 2768 "type": "string" 2769 } 2770 }, 2771 "apiName": { 2772 "type": "string" 2773 }, 2774 "apiVersion": { 2775 "type": "string" 2776 }, 2777 "centraSiteURL": { 2778 "type": "string", 2779 "readOnly": true 2780 }, 2781 "creationDate": { 2782 "type": "string", 2783 "readOnly": true 2784 }, 2785 "gatewayEndpoints": { 2786 "type": "object", 2787 "additionalProperties": { 2788 "type": "string" 2789 }, 2790 "readOnly": true 2791 }, 2792 "id": { 2793 "type": "string" 2794 }, 2795 "isActive": { 2796 "type": "boolean", 2797 "readOnly": true 2798 }, 2799 "lastModified": { 2800 "type": "string", 2801 "readOnly": true 2802 }, 2803 "maturityState": { 2804 "type": "string" 2805 }, 2806 "mockService": { 2807 "$ref": "#/definitions/MockService" 2808 }, 2809 "nativeEndpoint": { 2810 "type": "array", 2811 "uniqueItems": true, 2812 "items": { 2813 "$ref": "#/definitions/Endpoint" 2814 }, 2815 "readOnly": true 2816 }, 2817 "nextVersion": { 2818 "type": "string", 2819 "readOnly": true 2820 }, 2821 "oauth2ScopeName": { 2822 "type": "string" 2823 }, 2824 "owner": { 2825 "type": "string", 2826 "readOnly": true 2827 }, 2828 "policies": { 2829 "type": "array", 2830 "items": { 2831 "type": "string" 2832 }, 2833 "readOnly": true 2834 }, 2835 "portalApiItemIdentifier": { 2836 "type": "string", 2837 "readOnly": true 2838 }, 2839 "prevVersion": { 2840 "type": "string", 2841 "readOnly": true 2842 }, 2843 "provider": { 2844 "type": "string", 2845 "readOnly": true 2846 }, 2847 "publishedPortals": { 2848 "type": "array", 2849 "items": { 2850 "type": "string" 2851 } 2852 }, 2853 "publishedToRegistry": { 2854 "type": "boolean" 2855 }, 2856 "rootFileName": { 2857 "type": "string", 2858 "readOnly": true 2859 }, 2860 "scopes": { 2861 "type": "array", 2862 "items": { 2863 "$ref": "#/definitions/Scope" 2864 } 2865 }, 2866 "systemVersion": { 2867 "type": "integer", 2868 "format": "int32", 2869 "readOnly": true 2870 }, 2871 "tracingEnabled": { 2872 "type": "boolean", 2873 "readOnly": true 2874 }, 2875 "type": { 2876 "type": "string" 2877 } 2878 } 2879 }, 2880 "GatewaySchema": { 2881 "allOf": [ 2882 { 2883 "$ref": "#/definitions/Schema" 2884 }, 2885 { 2886 "type": "object", 2887 "properties": { 2888 "schema": { 2889 "type": "string" 2890 } 2891 } 2892 } 2893 ] 2894 }, 2895 "GatewayScope": { 2896 "description": "Maps the authorization server scope with APIs or API scopes", 2897 "type": "object", 2898 "properties": { 2899 "apiScopes": { 2900 "description": "List of API IDs (or API Scope IDs) mapped the auth server scope", 2901 "type": "array", 2902 "items": { 2903 "type": "string" 2904 } 2905 }, 2906 "audience": { 2907 "description": "This field is optional. This value will be used in scope level audience matching", 2908 "type": "string" 2909 }, 2910 "id": { 2911 "description": "A unique ID for the OAuth scope mapping", 2912 "type": "string" 2913 }, 2914 "requiredAuthScopes": { 2915 "description": "List of oauth scope entries from the authorization server definition", 2916 "type": "array", 2917 "items": { 2918 "$ref": "#/definitions/AuthServerScope" 2919 } 2920 }, 2921 "scopeDescription": { 2922 "description": "Description for the OAuth scope mapping", 2923 "type": "string" 2924 }, 2925 "scopeName": { 2926 "description": "Name of the OAuth scope mapping", 2927 "type": "string" 2928 } 2929 } 2930 }, 2931 "Header": { 2932 "type": "object", 2933 "properties": { 2934 "_enum": { 2935 "type": "array", 2936 "items": { 2937 "type": "string" 2938 } 2939 }, 2940 "allowEmptyValue": { 2941 "description": "Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a parameter with an empty value", 2942 "type": "boolean" 2943 }, 2944 "allowReserved": { 2945 "description": "Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$\u0026'()*+,;= to be included without percent-encoding. This property only applies to parameters with an in value of query. The default value is false", 2946 "type": "boolean" 2947 }, 2948 "content": { 2949 "description": "A map containing the representations for the parameter. The key is the media type and the value describes it. The map MUST only contain one entry", 2950 "type": "object", 2951 "additionalProperties": { 2952 "$ref": "#/definitions/MediaType" 2953 } 2954 }, 2955 "default": { 2956 "type": "string" 2957 }, 2958 "deprecated": { 2959 "description": "Determines whether this parameter is mandatory. If the parameter location is \"path\", this property is REQUIRED and its value MUST be true. Otherwise, the property MAY be included and its default value is false", 2960 "type": "boolean" 2961 }, 2962 "description": { 2963 "description": "A brief description of the parameter. This could contain examples of use", 2964 "type": "string" 2965 }, 2966 "examples": { 2967 "description": "Examples of the media type. Each example SHOULD contain a value in the correct format as specified in the parameter encoding. The examples field is mutually exclusive of the example field. Furthermore, if referencing a schema which contains an example, the examples value SHALL override the example provided by the schema", 2968 "type": "object", 2969 "additionalProperties": { 2970 "$ref": "#/definitions/Example" 2971 } 2972 }, 2973 "explode": { 2974 "description": "When this is true, parameter values of type array or object generate separate parameters for each value of the array or key-value pair of the map. For other types of parameters this property has no effect. When style is form, the default value is true. For all other styles, the default value is false", 2975 "type": "boolean" 2976 }, 2977 "extendedExample": { 2978 "description": "Example of the media type. The example SHOULD match the specified schema and encoding properties if present. The example field is mutually exclusive of the examples field. Furthermore, if referencing a schema which contains an example, the example value SHALL override the example provided by the schema. To represent examples of media types that cannot naturally be represented in JSON or YAML, a string value can contain the example with escaping where necessary", 2979 "type": "object" 2980 }, 2981 "get$ref": { 2982 "description": "The available paths and operations for the API", 2983 "type": "string" 2984 }, 2985 "in": { 2986 "description": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\"", 2987 "type": "string" 2988 }, 2989 "name": { 2990 "description": "The name of the parameter. Parameter names are case sensitive", 2991 "type": "string" 2992 }, 2993 "parameterSchema": { 2994 "$ref": "#/definitions/Schema" 2995 }, 2996 "required": { 2997 "description": "Determines whether this parameter is mandatory. If the parameter location is \"path\", this property is REQUIRED and its value MUST be true. Otherwise, the property MAY be included and its default value is false", 2998 "type": "boolean" 2999 }, 3000 "style": { 3001 "description": "Describes how the parameter value will be serialized depending on the type of the parameter value. Default values (based on value of in): for query - form; for path - simple; for header - simple; for cookie - form", 3002 "type": "string", 3003 "enum": [ 3004 "MATRIX", 3005 "LABEL", 3006 "FORM", 3007 "SIMPLE", 3008 "SPACEDELIMITED", 3009 "PIPEDELIMITED", 3010 "DEEPOBJECT" 3011 ] 3012 }, 3013 "vendorExtensions": { 3014 "type": "object", 3015 "additionalProperties": { 3016 "type": "object" 3017 } 3018 }, 3019 "xpath": { 3020 "$ref": "#/definitions/Xpath" 3021 } 3022 } 3023 }, 3024 "HeaderParameter": { 3025 "allOf": [ 3026 { 3027 "$ref": "#/definitions/Parameter" 3028 }, 3029 { 3030 "type": "object" 3031 } 3032 ] 3033 }, 3034 "Info": { 3035 "type": "object", 3036 "properties": { 3037 "contact": { 3038 "$ref": "#/definitions/Contact" 3039 }, 3040 "description": { 3041 "description": "A short description of the application", 3042 "type": "string" 3043 }, 3044 "license": { 3045 "$ref": "#/definitions/Licence" 3046 }, 3047 "termsOfService": { 3048 "description": "A URL to the Terms of Service for the API", 3049 "type": "string" 3050 }, 3051 "title": { 3052 "description": "The title of the application", 3053 "type": "string" 3054 }, 3055 "vendorExtensions": { 3056 "type": "object", 3057 "additionalProperties": { 3058 "type": "object" 3059 } 3060 }, 3061 "version": { 3062 "description": "Version of the API", 3063 "type": "string" 3064 } 3065 } 3066 }, 3067 "InputAPI": { 3068 "type": "object", 3069 "required": [ 3070 "apiName", 3071 "type" 3072 ], 3073 "properties": { 3074 "apiDefinition": { 3075 "$ref": "#/definitions/API" 3076 }, 3077 "apiDescription": { 3078 "type": "string" 3079 }, 3080 "apiName": { 3081 "type": "string" 3082 }, 3083 "apiVersion": { 3084 "type": "string" 3085 }, 3086 "authorizationValue": { 3087 "$ref": "#/definitions/AuthorizationValue" 3088 }, 3089 "maturityState": { 3090 "type": "string" 3091 }, 3092 "rootFileName": { 3093 "description": "Required when creating an API by importing protected URL", 3094 "type": "string" 3095 }, 3096 "teams": { 3097 "description": "Contains teams to which the API must be assigned.", 3098 "type": "array", 3099 "items": { 3100 "$ref": "#/definitions/Team" 3101 } 3102 }, 3103 "type": { 3104 "type": "string" 3105 }, 3106 "url": { 3107 "description": "Required when creating an API by importing URL", 3108 "type": "string" 3109 } 3110 } 3111 }, 3112 "InputAPIImplementation": { 3113 "type": "object", 3114 "properties": { 3115 "maturityState": { 3116 "type": "string" 3117 }, 3118 "nativeBaseURLs": { 3119 "type": "array", 3120 "items": { 3121 "type": "string" 3122 } 3123 } 3124 } 3125 }, 3126 "InputForAddGatewayEndpoint": { 3127 "description": "To add a new Gateway endpoint of this API", 3128 "type": "object", 3129 "properties": { 3130 "endpointName": { 3131 "description": "Name of the endpoint", 3132 "type": "string" 3133 }, 3134 "gatewayEndpoint": { 3135 "description": "Gateway endpoint value", 3136 "type": "string" 3137 } 3138 } 3139 }, 3140 "InputForGatewayEndpoints": { 3141 "description": "To manage gateway endpoints of an API", 3142 "type": "object", 3143 "properties": { 3144 "add": { 3145 "$ref": "#/definitions/InputForAddGatewayEndpoint" 3146 }, 3147 "remove": { 3148 "$ref": "#/definitions/InputForRemoveGatewayEndpoint" 3149 }, 3150 "update": { 3151 "$ref": "#/definitions/InputForUpdateGatewayEndpoint" 3152 } 3153 } 3154 }, 3155 "InputForRemoveGatewayEndpoint": { 3156 "description": "To remove an existing Gateway endpoint of this API", 3157 "type": "object", 3158 "properties": { 3159 "endpointName": { 3160 "description": "Name of the endpoint", 3161 "type": "string" 3162 } 3163 } 3164 }, 3165 "InputForUpdateGatewayEndpoint": { 3166 "description": "To update an existing Gateway endpoint of this API", 3167 "type": "object", 3168 "properties": { 3169 "gatewayEndpoint": { 3170 "description": "Gateway endpoint value to be updated", 3171 "type": "string" 3172 }, 3173 "newEndpointName": { 3174 "description": "New name of the endpoint", 3175 "type": "string" 3176 }, 3177 "oldEndpointName": { 3178 "description": "Existing name of the endpoint", 3179 "type": "string" 3180 } 3181 } 3182 }, 3183 "InputGatewayEndpoints": { 3184 "type": "object", 3185 "properties": { 3186 "gatewayEndpoints": { 3187 "$ref": "#/definitions/InputForGatewayEndpoints" 3188 } 3189 } 3190 }, 3191 "InputIntegrationServerPublish": { 3192 "type": "object", 3193 "properties": { 3194 "publishInfo": { 3195 "$ref": "#/definitions/PublishPayload" 3196 }, 3197 "publishInfos": { 3198 "description": "This contains the publish information for multiple APIs. Required when publishing more than one API to one or more integration servers.", 3199 "type": "array", 3200 "items": { 3201 "$ref": "#/definitions/PublishPayload" 3202 } 3203 } 3204 } 3205 }, 3206 "InputPublish": { 3207 "type": "object", 3208 "properties": { 3209 "communities": { 3210 "type": "array", 3211 "items": { 3212 "type": "string" 3213 } 3214 }, 3215 "endpoints": { 3216 "type": "array", 3217 "items": { 3218 "type": "string" 3219 } 3220 }, 3221 "portalGatewayId": { 3222 "type": "string" 3223 } 3224 } 3225 }, 3226 "InputServiceRegistryPublish": { 3227 "type": "object", 3228 "properties": { 3229 "publishInfo": { 3230 "$ref": "#/definitions/PublishPayload" 3231 }, 3232 "publishInfos": { 3233 "description": "This contains the publish information for multiple APIs. Required when publishing more than one API to one or more service registries.", 3234 "type": "array", 3235 "items": { 3236 "$ref": "#/definitions/PublishPayload" 3237 } 3238 } 3239 } 3240 }, 3241 "InputServiceRegistryUnpublish": { 3242 "type": "object", 3243 "properties": { 3244 "unpublishInfo": { 3245 "$ref": "#/definitions/UnpublishInfo" 3246 }, 3247 "unpublishInfos": { 3248 "description": "This contains the unpublish information for multiple APIs. Required when publishing more than one API from one or more service registries.", 3249 "type": "array", 3250 "items": { 3251 "$ref": "#/definitions/UnpublishInfo" 3252 } 3253 } 3254 } 3255 }, 3256 "InputStream": { 3257 "type": "object" 3258 }, 3259 "InputVersion": { 3260 "type": "object", 3261 "required": [ 3262 "newApiVersion" 3263 ], 3264 "properties": { 3265 "newApiVersion": { 3266 "type": "string" 3267 }, 3268 "retainApplications": { 3269 "type": "boolean" 3270 } 3271 } 3272 }, 3273 "IntegerSchema": { 3274 "allOf": [ 3275 { 3276 "$ref": "#/definitions/Schema" 3277 }, 3278 { 3279 "type": "object" 3280 } 3281 ] 3282 }, 3283 "IntegrationServerPublishInfo": { 3284 "type": "object", 3285 "properties": { 3286 "apiName": { 3287 "type": "string" 3288 }, 3289 "contentModelComplianceForWSDL": { 3290 "type": "string" 3291 }, 3292 "enableMTOM": { 3293 "type": "boolean" 3294 }, 3295 "enforceWSICompliance": { 3296 "type": "boolean" 3297 }, 3298 "folderName": { 3299 "description": "Name of the folder under the package (mentioned on 'packageName' property) in which the API to be published. This field is required.", 3300 "type": "string" 3301 }, 3302 "importSwaggerBasedOnTags": { 3303 "type": "boolean" 3304 }, 3305 "integrationServerId": { 3306 "description": "Uddi key of the integration server created in API Gateway. This field is required.", 3307 "type": "string" 3308 }, 3309 "integrationServerName": { 3310 "type": "string" 3311 }, 3312 "packageAndFolders": { 3313 "type": "array", 3314 "items": { 3315 "$ref": "#/definitions/PackageFolderPair" 3316 } 3317 }, 3318 "packageName": { 3319 "description": "Name of the package in the integration server in which the API to be published. This field is required.", 3320 "type": "string" 3321 }, 3322 "status": { 3323 "type": "string", 3324 "enum": [ 3325 "NEW", 3326 "PUBLISHED", 3327 "SUSPENDED" 3328 ] 3329 }, 3330 "updateNativeEndpointsOfAPI": { 3331 "type": "boolean" 3332 }, 3333 "validateSchemaWithXerces": { 3334 "type": "boolean" 3335 } 3336 } 3337 }, 3338 "IntegrationServerPublishResponse": { 3339 "type": "object", 3340 "properties": { 3341 "description": { 3342 "description": "Represents the status of the publish operation of the API to the service registry eg: Publish successful, Publish failed, etc", 3343 "type": "string" 3344 }, 3345 "failureReason": { 3346 "description": "Provides the reason for the failure when the publish operation is not successful", 3347 "type": "string" 3348 }, 3349 "integrationServerId": { 3350 "description": "Id i.e, UDDI key of the service registry", 3351 "type": "string" 3352 }, 3353 "integrationServerName": { 3354 "type": "string" 3355 }, 3356 "status": { 3357 "type": "string", 3358 "enum": [ 3359 "NEW", 3360 "PUBLISHED", 3361 "SUSPENDED" 3362 ] 3363 }, 3364 "success": { 3365 "description": "Represents whether the publish of API to the service registry is success. Possible values: true/false", 3366 "type": "boolean" 3367 } 3368 } 3369 }, 3370 "Licence": { 3371 "type": "object", 3372 "properties": { 3373 "name": { 3374 "description": "The license name used for the API", 3375 "type": "string" 3376 }, 3377 "url": { 3378 "description": "A URL to the license used for the API", 3379 "type": "string" 3380 }, 3381 "vendorExtensions": { 3382 "type": "object", 3383 "additionalProperties": { 3384 "type": "object" 3385 } 3386 } 3387 } 3388 }, 3389 "Link": { 3390 "type": "object", 3391 "properties": { 3392 "description": { 3393 "description": "A description of the link", 3394 "type": "string" 3395 }, 3396 "get$ref": { 3397 "type": "string" 3398 }, 3399 "operationId": { 3400 "description": "The name of an existing, resolvable OAS operation, as defined with a unique operationId. This field is mutually exclusive of the operationRef field", 3401 "type": "string" 3402 }, 3403 "operationRef": { 3404 "description": "A relative or absolute reference to an OAS operation. This field is mutually exclusive of the operationId field, and MUST point to an Operation Object. Relative operationRef values MAY be used to locate an existing Operation Object in the API definition", 3405 "type": "string" 3406 }, 3407 "parameters": { 3408 "description": "A map representing parameters to pass to an operation as specified with operationId or identified via operationRef. The key is the parameter name to be used, whereas the value can be a constant or an expression to be evaluated and passed to the linked operation. The parameter name can be qualified using the parameter location [{in}.]{name} for operations that use the same parameter name in different locations (e.g. path.id)", 3409 "type": "object", 3410 "additionalProperties": { 3411 "type": "string" 3412 } 3413 }, 3414 "requestBody": { 3415 "description": "A literal value or {expression} to use as a request body when calling the target operation", 3416 "type": "string" 3417 }, 3418 "vendorExtensions": { 3419 "type": "object", 3420 "additionalProperties": { 3421 "type": "object" 3422 } 3423 } 3424 } 3425 }, 3426 "MapProperty": { 3427 "allOf": [ 3428 { 3429 "$ref": "#/definitions/Property" 3430 }, 3431 { 3432 "type": "object", 3433 "properties": { 3434 "additionalProperties": { 3435 "$ref": "#/definitions/Property" 3436 }, 3437 "maxProperties": { 3438 "type": "integer", 3439 "format": "int32" 3440 }, 3441 "minProperties": { 3442 "type": "integer", 3443 "format": "int32" 3444 } 3445 } 3446 } 3447 ] 3448 }, 3449 "MediaType": { 3450 "type": "object", 3451 "properties": { 3452 "example": { 3453 "description": "Example of the media type. The example object SHOULD be in the correct format as specified by the media type. The example field is mutually exclusive of the examples field. Furthermore, if referencing a schema which contains an example, the example value SHALL override the example provided by the schema", 3454 "type": "object" 3455 }, 3456 "examples": { 3457 "description": "Examples of the media type. Each example object SHOULD match the media type and specified schema if present. The examples field is mutually exclusive of the example field. Furthermore, if referencing a schema which contains an example, the examples value SHALL override the example provided by the schema", 3458 "type": "object", 3459 "additionalProperties": { 3460 "$ref": "#/definitions/Example" 3461 } 3462 }, 3463 "schema": { 3464 "$ref": "#/definitions/Schema" 3465 }, 3466 "vendorExtensions": { 3467 "type": "object", 3468 "additionalProperties": { 3469 "type": "object" 3470 } 3471 } 3472 } 3473 }, 3474 "MessageFrame": { 3475 "type": "object", 3476 "properties": { 3477 "messageDescription": { 3478 "type": "string" 3479 }, 3480 "messagePayload": { 3481 "type": "string" 3482 }, 3483 "origin": { 3484 "type": "string", 3485 "enum": [ 3486 "Server", 3487 "Client" 3488 ] 3489 }, 3490 "type": { 3491 "type": "string", 3492 "enum": [ 3493 "Binary", 3494 "Text" 3495 ] 3496 } 3497 } 3498 }, 3499 "MethodParameters": { 3500 "type": "object", 3501 "properties": { 3502 "enabled": { 3503 "type": "boolean" 3504 }, 3505 "parameters": { 3506 "type": "object", 3507 "additionalProperties": { 3508 "type": "string" 3509 } 3510 }, 3511 "returnType": { 3512 "type": "string" 3513 } 3514 } 3515 }, 3516 "MockService": { 3517 "type": "object", 3518 "properties": { 3519 "enableMock": { 3520 "type": "boolean" 3521 }, 3522 "runAsUser": { 3523 "type": "string" 3524 }, 3525 "service": { 3526 "type": "string" 3527 } 3528 } 3529 }, 3530 "MockedCondition": { 3531 "type": "object", 3532 "properties": { 3533 "conditionName": { 3534 "type": "string" 3535 }, 3536 "mockedConditionParameter": { 3537 "type": "string", 3538 "enum": [ 3539 "Body", 3540 "Header", 3541 "QueryParameter" 3542 ] 3543 }, 3544 "mockedLevel1Operator": { 3545 "type": "string", 3546 "enum": [ 3547 "Equals", 3548 "NotEquals", 3549 "ContainsKey", 3550 "ContainsKeyValue" 3551 ] 3552 }, 3553 "mockedLevel2Operator": { 3554 "type": "string", 3555 "enum": [ 3556 "Equals", 3557 "NotEquals", 3558 "Contains", 3559 "StartsWith", 3560 "EndsWith" 3561 ] 3562 }, 3563 "value1": { 3564 "type": "string" 3565 }, 3566 "value2": { 3567 "type": "string" 3568 } 3569 } 3570 }, 3571 "MockedConditionsBasedCustomResponse": { 3572 "type": "object", 3573 "properties": { 3574 "mockedConditionList": { 3575 "type": "array", 3576 "items": { 3577 "$ref": "#/definitions/MockedCondition" 3578 } 3579 }, 3580 "mockedResponse": { 3581 "$ref": "#/definitions/MockedResponse" 3582 } 3583 } 3584 }, 3585 "MockedResponse": { 3586 "type": "object", 3587 "properties": { 3588 "responseBody": { 3589 "type": "object", 3590 "additionalProperties": { 3591 "type": "object" 3592 } 3593 }, 3594 "responseHeaders": { 3595 "type": "object", 3596 "additionalProperties": { 3597 "type": "object" 3598 } 3599 }, 3600 "statusCode": { 3601 "type": "string" 3602 } 3603 } 3604 }, 3605 "Model": { 3606 "type": "object", 3607 "properties": { 3608 "description": { 3609 "type": "string" 3610 }, 3611 "example": { 3612 "type": "object" 3613 }, 3614 "externalDocs": { 3615 "$ref": "#/definitions/ExternalDocs" 3616 }, 3617 "properties": { 3618 "type": "object", 3619 "additionalProperties": { 3620 "type": "object" 3621 } 3622 }, 3623 "reference": { 3624 "type": "string" 3625 }, 3626 "title": { 3627 "type": "string" 3628 }, 3629 "type": { 3630 "type": "string" 3631 }, 3632 "vendorExtensions": { 3633 "type": "object", 3634 "additionalProperties": { 3635 "type": "object" 3636 } 3637 } 3638 }, 3639 "discriminator": "type" 3640 }, 3641 "ModelImpl": { 3642 "allOf": [ 3643 { 3644 "$ref": "#/definitions/Model" 3645 }, 3646 { 3647 "type": "object", 3648 "properties": { 3649 "allowEmptyValue": { 3650 "type": "boolean" 3651 }, 3652 "defaultValue": { 3653 "type": "object" 3654 }, 3655 "discriminator": { 3656 "type": "string" 3657 }, 3658 "enum": { 3659 "type": "array", 3660 "items": { 3661 "type": "string" 3662 } 3663 }, 3664 "format": { 3665 "type": "string" 3666 }, 3667 "maximum": { 3668 "type": "number" 3669 }, 3670 "minimum": { 3671 "type": "number" 3672 }, 3673 "name": { 3674 "type": "string" 3675 }, 3676 "required": { 3677 "type": "array", 3678 "items": { 3679 "type": "string" 3680 } 3681 }, 3682 "uniqueItems": { 3683 "type": "boolean" 3684 }, 3685 "xml": { 3686 "$ref": "#/definitions/Xml" 3687 } 3688 } 3689 } 3690 ] 3691 }, 3692 "Multipart": { 3693 "type": "object", 3694 "properties": { 3695 "contentType": { 3696 "type": "string" 3697 }, 3698 "count": { 3699 "type": "integer", 3700 "format": "int32" 3701 }, 3702 "parent": { 3703 "$ref": "#/definitions/Part" 3704 } 3705 } 3706 }, 3707 "Namespaces": { 3708 "type": "object", 3709 "properties": { 3710 "prefix": { 3711 "type": "string" 3712 }, 3713 "uri": { 3714 "type": "string" 3715 } 3716 } 3717 }, 3718 "Node": { 3719 "type": "object", 3720 "properties": { 3721 "hostId": { 3722 "type": "string" 3723 }, 3724 "replica": { 3725 "type": "integer", 3726 "format": "int32" 3727 } 3728 } 3729 }, 3730 "Number": { 3731 "type": "object" 3732 }, 3733 "NumberSchema": { 3734 "allOf": [ 3735 { 3736 "$ref": "#/definitions/Schema" 3737 }, 3738 { 3739 "type": "object" 3740 } 3741 ] 3742 }, 3743 "OAuth2Definition": { 3744 "type": "object", 3745 "properties": { 3746 "authorizationGrants": { 3747 "type": "array", 3748 "items": { 3749 "type": "string" 3750 } 3751 }, 3752 "authorizationUrl": { 3753 "type": "string" 3754 }, 3755 "description": { 3756 "type": "string" 3757 }, 3758 "flow": { 3759 "type": "string" 3760 }, 3761 "refreshUrl": { 3762 "type": "string" 3763 }, 3764 "scopes": { 3765 "type": "object", 3766 "additionalProperties": { 3767 "type": "object" 3768 } 3769 }, 3770 "securitySchemeDescriptor": { 3771 "$ref": "#/definitions/SecuritySchemeDescriptor" 3772 }, 3773 "tokenUrl": { 3774 "type": "string" 3775 }, 3776 "type": { 3777 "type": "string" 3778 }, 3779 "vendorExtensions": { 3780 "type": "object", 3781 "additionalProperties": { 3782 "type": "object" 3783 } 3784 } 3785 } 3786 }, 3787 "OAuth2Token": { 3788 "type": "object", 3789 "properties": { 3790 "clientId": { 3791 "description": "unique identifier of the oauth2 client", 3792 "type": "string" 3793 }, 3794 "clientName": { 3795 "description": "the name of the client", 3796 "type": "string" 3797 }, 3798 "clientSecret": { 3799 "description": "the client secret", 3800 "type": "string" 3801 }, 3802 "expirationInterval": { 3803 "description": "the expiration interval", 3804 "type": "string" 3805 }, 3806 "redirectUris": { 3807 "description": "list of redirect uris", 3808 "type": "array", 3809 "items": { 3810 "type": "string" 3811 } 3812 }, 3813 "refreshCount": { 3814 "description": "number of times an access token can be refreshed", 3815 "type": "string" 3816 }, 3817 "scopes": { 3818 "description": "the scopes associated with the client", 3819 "type": "array", 3820 "items": { 3821 "type": "string" 3822 } 3823 }, 3824 "type": { 3825 "description": "type of the oauth2 client", 3826 "type": "string" 3827 } 3828 } 3829 }, 3830 "OAuthFlows": { 3831 "type": "object", 3832 "properties": { 3833 "authorizationCode": { 3834 "$ref": "#/definitions/OAuth2Definition" 3835 }, 3836 "clientCredentials": { 3837 "$ref": "#/definitions/OAuth2Definition" 3838 }, 3839 "implicit": { 3840 "$ref": "#/definitions/OAuth2Definition" 3841 }, 3842 "password": { 3843 "$ref": "#/definitions/OAuth2Definition" 3844 }, 3845 "vendorExtensions": { 3846 "type": "object", 3847 "additionalProperties": { 3848 "type": "object" 3849 } 3850 } 3851 } 3852 }, 3853 "ODataAPI": { 3854 "allOf": [ 3855 { 3856 "$ref": "#/definitions/API" 3857 }, 3858 { 3859 "type": "object", 3860 "properties": { 3861 "actionImports": { 3862 "type": "object", 3863 "additionalProperties": { 3864 "$ref": "#/definitions/ActionImport" 3865 } 3866 }, 3867 "actions": { 3868 "type": "object", 3869 "additionalProperties": { 3870 "$ref": "#/definitions/EntityType" 3871 } 3872 }, 3873 "entitySets": { 3874 "type": "object", 3875 "additionalProperties": { 3876 "$ref": "#/definitions/EntitySet" 3877 } 3878 }, 3879 "entityTypes": { 3880 "type": "object", 3881 "additionalProperties": { 3882 "$ref": "#/definitions/EntityType" 3883 } 3884 }, 3885 "functionImports": { 3886 "type": "object", 3887 "additionalProperties": { 3888 "$ref": "#/definitions/FunctionImport" 3889 } 3890 }, 3891 "functions": { 3892 "type": "object", 3893 "additionalProperties": { 3894 "$ref": "#/definitions/EntityType" 3895 } 3896 }, 3897 "metaDataDocument": { 3898 "type": "string" 3899 }, 3900 "odataVersion": { 3901 "type": "string" 3902 }, 3903 "serviceDocument": { 3904 "type": "string" 3905 }, 3906 "serviceRoot": { 3907 "type": "string" 3908 }, 3909 "singletons": { 3910 "type": "object", 3911 "additionalProperties": { 3912 "$ref": "#/definitions/EntitySet" 3913 } 3914 } 3915 } 3916 } 3917 ] 3918 }, 3919 "ObjectProperty": { 3920 "allOf": [ 3921 { 3922 "$ref": "#/definitions/Property" 3923 }, 3924 { 3925 "type": "object", 3926 "properties": { 3927 "properties": { 3928 "type": "object", 3929 "additionalProperties": { 3930 "$ref": "#/definitions/Property" 3931 } 3932 } 3933 } 3934 } 3935 ] 3936 }, 3937 "ObjectSchema": { 3938 "allOf": [ 3939 { 3940 "$ref": "#/definitions/Schema" 3941 }, 3942 { 3943 "type": "object" 3944 } 3945 ] 3946 }, 3947 "Operation": { 3948 "type": "object", 3949 "properties": { 3950 "callbacks": { 3951 "description": "An optional, string description, intended to apply to all operations in this path", 3952 "type": "object", 3953 "additionalProperties": { 3954 "$ref": "#/definitions/Callback" 3955 } 3956 }, 3957 "deprecated": { 3958 "description": "Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is false", 3959 "type": "boolean" 3960 }, 3961 "description": { 3962 "description": "A verbose explanation of the operation behavior", 3963 "type": "string" 3964 }, 3965 "enabled": { 3966 "type": "boolean" 3967 }, 3968 "externalDocs": { 3969 "$ref": "#/definitions/ExternalDocs" 3970 }, 3971 "mockedConditionsBasedCustomResponsesList": { 3972 "description": "The list of mocked conditions and it's applicable only for mocked APIs", 3973 "type": "array", 3974 "items": { 3975 "$ref": "#/definitions/MockedConditionsBasedCustomResponse" 3976 } 3977 }, 3978 "mockedResponses": { 3979 "description": "The list of possible mocked responses as they are returned from executing this operation and it's applicable only for mocked APIs", 3980 "type": "object", 3981 "additionalProperties": { 3982 "$ref": "#/definitions/MockedResponse" 3983 } 3984 }, 3985 "operationId": { 3986 "description": "Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is case-sensitive", 3987 "type": "string" 3988 }, 3989 "parameters": { 3990 "description": "A list of parameters that are applicable for this operation. If a parameter is already defined at the Path Item, the new definition will override it but can never remove it", 3991 "type": "array", 3992 "items": { 3993 "$ref": "#/definitions/Parameter" 3994 } 3995 }, 3996 "requestBody": { 3997 "$ref": "#/definitions/RequestBody" 3998 }, 3999 "responses": { 4000 "description": "The list of possible responses as they are returned from executing this operation", 4001 "type": "object", 4002 "additionalProperties": { 4003 "$ref": "#/definitions/Response" 4004 } 4005 }, 4006 "scopes": { 4007 "type": "array", 4008 "items": { 4009 "type": "string" 4010 } 4011 }, 4012 "summary": { 4013 "description": "A short summary of what the operation does", 4014 "type": "string" 4015 }, 4016 "tags": { 4017 "description": "A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier", 4018 "type": "array", 4019 "items": { 4020 "type": "string" 4021 } 4022 }, 4023 "vendorExtensions": { 4024 "type": "object", 4025 "additionalProperties": { 4026 "type": "object" 4027 } 4028 } 4029 } 4030 }, 4031 "OutputStream": { 4032 "type": "object" 4033 }, 4034 "PackageFolderPair": { 4035 "type": "object", 4036 "properties": { 4037 "apiDescriptorNSNameMap": { 4038 "type": "object", 4039 "additionalProperties": { 4040 "type": "string" 4041 } 4042 }, 4043 "folderName": { 4044 "type": "string" 4045 }, 4046 "markedAsDeleted": { 4047 "type": "boolean" 4048 }, 4049 "packageName": { 4050 "type": "string" 4051 } 4052 } 4053 }, 4054 "Parameter": { 4055 "type": "object", 4056 "properties": { 4057 "_enum": { 4058 "type": "array", 4059 "items": { 4060 "type": "string" 4061 } 4062 }, 4063 "allowEmptyValue": { 4064 "description": "Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a parameter with an empty value", 4065 "type": "boolean" 4066 }, 4067 "allowReserved": { 4068 "description": "Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$\u0026'()*+,;= to be included without percent-encoding. This property only applies to parameters with an in value of query. The default value is false", 4069 "type": "boolean" 4070 }, 4071 "content": { 4072 "description": "A map containing the representations for the parameter. The key is the media type and the value describes it. The map MUST only contain one entry", 4073 "type": "object", 4074 "additionalProperties": { 4075 "$ref": "#/definitions/MediaType" 4076 } 4077 }, 4078 "default": { 4079 "type": "string" 4080 }, 4081 "deprecated": { 4082 "description": "Determines whether this parameter is mandatory. If the parameter location is \"path\", this property is REQUIRED and its value MUST be true. Otherwise, the property MAY be included and its default value is false", 4083 "type": "boolean" 4084 }, 4085 "description": { 4086 "description": "A brief description of the parameter. This could contain examples of use", 4087 "type": "string" 4088 }, 4089 "examples": { 4090 "description": "Examples of the media type. Each example SHOULD contain a value in the correct format as specified in the parameter encoding. The examples field is mutually exclusive of the example field. Furthermore, if referencing a schema which contains an example, the examples value SHALL override the example provided by the schema", 4091 "type": "object", 4092 "additionalProperties": { 4093 "$ref": "#/definitions/Example" 4094 } 4095 }, 4096 "explode": { 4097 "description": "When this is true, parameter values of type array or object generate separate parameters for each value of the array or key-value pair of the map. For other types of parameters this property has no effect. When style is form, the default value is true. For all other styles, the default value is false", 4098 "type": "boolean" 4099 }, 4100 "extendedExample": { 4101 "description": "Example of the media type. The example SHOULD match the specified schema and encoding properties if present. The example field is mutually exclusive of the examples field. Furthermore, if referencing a schema which contains an example, the example value SHALL override the example provided by the schema. To represent examples of media types that cannot naturally be represented in JSON or YAML, a string value can contain the example with escaping where necessary", 4102 "type": "object" 4103 }, 4104 "get$ref": { 4105 "description": "The available paths and operations for the API", 4106 "type": "string" 4107 }, 4108 "in": { 4109 "description": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\"", 4110 "type": "string" 4111 }, 4112 "name": { 4113 "description": "The name of the parameter. Parameter names are case sensitive", 4114 "type": "string" 4115 }, 4116 "parameterSchema": { 4117 "$ref": "#/definitions/Schema" 4118 }, 4119 "required": { 4120 "description": "Determines whether this parameter is mandatory. If the parameter location is \"path\", this property is REQUIRED and its value MUST be true. Otherwise, the property MAY be included and its default value is false", 4121 "type": "boolean" 4122 }, 4123 "style": { 4124 "description": "Describes how the parameter value will be serialized depending on the type of the parameter value. Default values (based on value of in): for query - form; for path - simple; for header - simple; for cookie - form", 4125 "type": "string", 4126 "enum": [ 4127 "MATRIX", 4128 "LABEL", 4129 "FORM", 4130 "SIMPLE", 4131 "SPACEDELIMITED", 4132 "PIPEDELIMITED", 4133 "DEEPOBJECT" 4134 ] 4135 }, 4136 "vendorExtensions": { 4137 "type": "object", 4138 "additionalProperties": { 4139 "type": "object" 4140 } 4141 }, 4142 "xpath": { 4143 "$ref": "#/definitions/Xpath" 4144 } 4145 } 4146 }, 4147 "Part": { 4148 "type": "object", 4149 "properties": { 4150 "allHeaders": { 4151 "$ref": "#/definitions/Enumeration" 4152 }, 4153 "content": { 4154 "type": "object" 4155 }, 4156 "contentType": { 4157 "type": "string" 4158 }, 4159 "dataHandler": { 4160 "$ref": "#/definitions/DataHandler" 4161 }, 4162 "description": { 4163 "type": "string" 4164 }, 4165 "disposition": { 4166 "type": "string" 4167 }, 4168 "fileName": { 4169 "type": "string" 4170 }, 4171 "inputStream": { 4172 "$ref": "#/definitions/InputStream" 4173 }, 4174 "lineCount": { 4175 "type": "integer", 4176 "format": "int32" 4177 }, 4178 "size": { 4179 "type": "integer", 4180 "format": "int32" 4181 } 4182 } 4183 }, 4184 "Path": { 4185 "type": "object", 4186 "properties": { 4187 "delete": { 4188 "$ref": "#/definitions/Operation" 4189 }, 4190 "description": { 4191 "description": "An optional, string description, intended to apply to all operations in this path", 4192 "type": "string" 4193 }, 4194 "displayName": { 4195 "type": "string" 4196 }, 4197 "enabled": { 4198 "type": "boolean" 4199 }, 4200 "get": { 4201 "$ref": "#/definitions/Operation" 4202 }, 4203 "get$ref": { 4204 "description": "Allows for an external definition of this path item", 4205 "type": "string" 4206 }, 4207 "head": { 4208 "$ref": "#/definitions/Operation" 4209 }, 4210 "options": { 4211 "$ref": "#/definitions/Operation" 4212 }, 4213 "parameters": { 4214 "description": "A list of parameters that are applicable for all the operations described under this path. These parameters can be overridden at the operation level, but cannot be removed there", 4215 "type": "array", 4216 "items": { 4217 "type": "object" 4218 } 4219 }, 4220 "patch": { 4221 "$ref": "#/definitions/Operation" 4222 }, 4223 "post": { 4224 "$ref": "#/definitions/Operation" 4225 }, 4226 "put": { 4227 "$ref": "#/definitions/Operation" 4228 }, 4229 "scopes": { 4230 "type": "array", 4231 "items": { 4232 "type": "string" 4233 } 4234 }, 4235 "summary": { 4236 "description": "An optional, string summary, intended to apply to all operations in this path", 4237 "type": "string" 4238 }, 4239 "tags": { 4240 "description": "A list of path level tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier", 4241 "type": "array", 4242 "items": { 4243 "type": "string" 4244 } 4245 }, 4246 "trace": { 4247 "$ref": "#/definitions/Operation" 4248 }, 4249 "vendorExtensions": { 4250 "type": "object", 4251 "additionalProperties": { 4252 "type": "object" 4253 } 4254 } 4255 } 4256 }, 4257 "PathParameter": { 4258 "allOf": [ 4259 { 4260 "$ref": "#/definitions/Parameter" 4261 }, 4262 { 4263 "type": "object" 4264 } 4265 ] 4266 }, 4267 "Property": { 4268 "type": "object", 4269 "properties": { 4270 "access": { 4271 "type": "string" 4272 }, 4273 "allowEmptyValue": { 4274 "type": "boolean" 4275 }, 4276 "description": { 4277 "type": "string" 4278 }, 4279 "example": { 4280 "type": "object" 4281 }, 4282 "format": { 4283 "type": "string" 4284 }, 4285 "name": { 4286 "type": "string" 4287 }, 4288 "position": { 4289 "type": "integer", 4290 "format": "int32" 4291 }, 4292 "readOnly": { 4293 "type": "boolean" 4294 }, 4295 "required": { 4296 "type": "boolean" 4297 }, 4298 "title": { 4299 "type": "string" 4300 }, 4301 "type": { 4302 "type": "string" 4303 }, 4304 "vendorExtensions": { 4305 "type": "object", 4306 "additionalProperties": { 4307 "type": "object" 4308 } 4309 }, 4310 "xml": { 4311 "$ref": "#/definitions/Xml" 4312 } 4313 }, 4314 "discriminator": "type" 4315 }, 4316 "PublishPayload": { 4317 "type": "object", 4318 "properties": { 4319 "apiId": { 4320 "description": "API id for the API to be published. This field is required. The API will be published to the service registry with the value configured in 'Service registry display name' field of the API", 4321 "type": "string" 4322 }, 4323 "integrationServerPublishInfo": { 4324 "type": "array", 4325 "items": { 4326 "$ref": "#/definitions/IntegrationServerPublishInfo" 4327 } 4328 }, 4329 "serviceRegistryPublishInfo": { 4330 "description": "List of service registry publish information for the API. Each element of the list contains the publish information of the API for one service registry.", 4331 "type": "array", 4332 "items": { 4333 "$ref": "#/definitions/ServiceRegistryPublishInfo" 4334 } 4335 } 4336 } 4337 }, 4338 "PublishResponse": { 4339 "type": "object", 4340 "properties": { 4341 "apiId": { 4342 "description": "API id of the API published.", 4343 "type": "string" 4344 }, 4345 "apiName": { 4346 "description": "API name of the API published.", 4347 "type": "string" 4348 }, 4349 "apiVersion": { 4350 "description": "API version of the API published.", 4351 "type": "string" 4352 }, 4353 "integrationServerPublishResponses": { 4354 "type": "array", 4355 "items": { 4356 "$ref": "#/definitions/IntegrationServerPublishResponse" 4357 } 4358 }, 4359 "serviceRegistryPublishResponses": { 4360 "description": "Contains publish status of the API for each service registry in the request.", 4361 "type": "array", 4362 "items": { 4363 "$ref": "#/definitions/ServiceRegistryPublishResponse" 4364 } 4365 } 4366 } 4367 }, 4368 "QueryParameter": { 4369 "allOf": [ 4370 { 4371 "$ref": "#/definitions/Parameter" 4372 }, 4373 { 4374 "type": "object" 4375 } 4376 ] 4377 }, 4378 "RefModel": { 4379 "allOf": [ 4380 { 4381 "$ref": "#/definitions/Model" 4382 }, 4383 { 4384 "type": "object", 4385 "properties": { 4386 "get$ref": { 4387 "type": "string" 4388 }, 4389 "refFormat": { 4390 "type": "string", 4391 "enum": [ 4392 "URL", 4393 "RELATIVE", 4394 "INTERNAL" 4395 ] 4396 }, 4397 "simpleRef": { 4398 "type": "string" 4399 } 4400 } 4401 } 4402 ] 4403 }, 4404 "RefParameter": { 4405 "allOf": [ 4406 { 4407 "$ref": "#/definitions/Parameter" 4408 }, 4409 { 4410 "type": "object" 4411 } 4412 ] 4413 }, 4414 "RefProperty": { 4415 "allOf": [ 4416 { 4417 "$ref": "#/definitions/Property" 4418 }, 4419 { 4420 "type": "object", 4421 "properties": { 4422 "get$ref": { 4423 "type": "string" 4424 }, 4425 "refFormat": { 4426 "type": "string", 4427 "enum": [ 4428 "URL", 4429 "RELATIVE", 4430 "INTERNAL" 4431 ] 4432 }, 4433 "simpleRef": { 4434 "type": "string" 4435 } 4436 } 4437 } 4438 ] 4439 }, 4440 "RequestBody": { 4441 "type": "object", 4442 "properties": { 4443 "content": { 4444 "description": "The content of the request body. The key is a media type or media type range and the value describes it", 4445 "type": "object", 4446 "additionalProperties": { 4447 "$ref": "#/definitions/MediaType" 4448 } 4449 }, 4450 "description": { 4451 "description": "A brief description of the request body. This could contain examples of use", 4452 "type": "string" 4453 }, 4454 "get$ref": { 4455 "type": "string" 4456 }, 4457 "required": { 4458 "description": "Determines if the request body is required in the request. Defaults to false", 4459 "type": "boolean" 4460 }, 4461 "vendorExtensions": { 4462 "type": "object", 4463 "additionalProperties": { 4464 "type": "object" 4465 } 4466 } 4467 } 4468 }, 4469 "Response": { 4470 "type": "object", 4471 "properties": { 4472 "content": { 4473 "description": "A map containing descriptions of potential response payloads. The key is a media type or media type range and the value describes it", 4474 "type": "object", 4475 "additionalProperties": { 4476 "$ref": "#/definitions/MediaType" 4477 } 4478 }, 4479 "description": { 4480 "description": "A short description of the response", 4481 "type": "string" 4482 }, 4483 "get$ref": { 4484 "type": "string" 4485 }, 4486 "headersV3": { 4487 "description": "Maps a header name to its definition. RFC7230 states header names are case insensitive. If a response header is defined with the name \"Content-Type\", it SHALL be ignored", 4488 "type": "object", 4489 "additionalProperties": { 4490 "$ref": "#/definitions/Header" 4491 } 4492 }, 4493 "links": { 4494 "description": "A map of operations links that can be followed from the response. The key of the map is a short name for the link, following the naming constraints of the names for Component Objects.", 4495 "type": "object", 4496 "additionalProperties": { 4497 "$ref": "#/definitions/Link" 4498 } 4499 }, 4500 "vendorExtensions": { 4501 "type": "object", 4502 "additionalProperties": { 4503 "type": "object" 4504 } 4505 } 4506 } 4507 }, 4508 "RestAPI": { 4509 "allOf": [ 4510 { 4511 "$ref": "#/definitions/API" 4512 }, 4513 { 4514 "type": "object", 4515 "properties": { 4516 "components": { 4517 "$ref": "#/definitions/Components" 4518 }, 4519 "externalDocs": { 4520 "description": "Additional external documentation", 4521 "type": "array", 4522 "items": { 4523 "$ref": "#/definitions/ExternalDocs" 4524 } 4525 }, 4526 "info": { 4527 "$ref": "#/definitions/Info" 4528 }, 4529 "paths": { 4530 "description": "The available paths and operations for the API", 4531 "type": "object", 4532 "additionalProperties": { 4533 "$ref": "#/definitions/Path" 4534 } 4535 }, 4536 "servers": { 4537 "description": "An array of Server Objects, which provide connectivity information to a target server", 4538 "type": "array", 4539 "items": { 4540 "$ref": "#/definitions/Server" 4541 } 4542 }, 4543 "vendorExtensions": { 4544 "type": "object", 4545 "additionalProperties": { 4546 "type": "object" 4547 } 4548 } 4549 } 4550 } 4551 ] 4552 }, 4553 "RestEnabledPath": { 4554 "type": "object", 4555 "properties": { 4556 "delete": { 4557 "$ref": "#/definitions/Operation" 4558 }, 4559 "description": { 4560 "description": "An optional, string description, intended to apply to all operations in this path", 4561 "type": "string" 4562 }, 4563 "displayName": { 4564 "type": "string" 4565 }, 4566 "enabled": { 4567 "type": "boolean" 4568 }, 4569 "get": { 4570 "$ref": "#/definitions/Operation" 4571 }, 4572 "get$ref": { 4573 "description": "Allows for an external definition of this path item", 4574 "type": "string" 4575 }, 4576 "head": { 4577 "$ref": "#/definitions/Operation" 4578 }, 4579 "invokePath": { 4580 "type": "string" 4581 }, 4582 "name": { 4583 "type": "string" 4584 }, 4585 "options": { 4586 "$ref": "#/definitions/Operation" 4587 }, 4588 "parameters": { 4589 "description": "A list of parameters that are applicable for all the operations described under this path. These parameters can be overridden at the operation level, but cannot be removed there", 4590 "type": "array", 4591 "items": { 4592 "type": "object" 4593 } 4594 }, 4595 "patch": { 4596 "$ref": "#/definitions/Operation" 4597 }, 4598 "post": { 4599 "$ref": "#/definitions/Operation" 4600 }, 4601 "put": { 4602 "$ref": "#/definitions/Operation" 4603 }, 4604 "scopes": { 4605 "type": "array", 4606 "items": { 4607 "type": "string" 4608 } 4609 }, 4610 "summary": { 4611 "description": "An optional, string summary, intended to apply to all operations in this path", 4612 "type": "string" 4613 }, 4614 "tags": { 4615 "type": "array", 4616 "items": { 4617 "type": "string" 4618 } 4619 }, 4620 "trace": { 4621 "$ref": "#/definitions/Operation" 4622 }, 4623 "vendorExtensions": { 4624 "type": "object", 4625 "additionalProperties": { 4626 "type": "object" 4627 } 4628 } 4629 } 4630 }, 4631 "SOAPAPI": { 4632 "allOf": [ 4633 { 4634 "$ref": "#/definitions/API" 4635 }, 4636 { 4637 "type": "object", 4638 "properties": { 4639 "baseWsdlUri": { 4640 "type": "string" 4641 }, 4642 "isRESTInvokeEnabled": { 4643 "type": "boolean" 4644 }, 4645 "nativeUri": { 4646 "type": "array", 4647 "uniqueItems": true, 4648 "items": { 4649 "type": "string" 4650 } 4651 }, 4652 "operationPolicies": { 4653 "type": "object", 4654 "additionalProperties": { 4655 "type": "string" 4656 } 4657 }, 4658 "operationsInfo": { 4659 "type": "array", 4660 "uniqueItems": true, 4661 "items": { 4662 "$ref": "#/definitions/SOAPOperation" 4663 } 4664 }, 4665 "primaryEndpoint": { 4666 "type": "object", 4667 "additionalProperties": { 4668 "type": "boolean" 4669 } 4670 }, 4671 "rootFileFolder": { 4672 "type": "string" 4673 }, 4674 "serviceName": { 4675 "type": "string" 4676 }, 4677 "wsdl": { 4678 "type": "string" 4679 } 4680 } 4681 } 4682 ] 4683 }, 4684 "SOAPBinding": { 4685 "type": "object", 4686 "properties": { 4687 "faultMessages": { 4688 "type": "array", 4689 "items": { 4690 "type": "string" 4691 } 4692 }, 4693 "inputMessage": { 4694 "type": "string" 4695 }, 4696 "interFace": { 4697 "$ref": "#/definitions/SOAPInterface" 4698 }, 4699 "name": { 4700 "type": "string" 4701 }, 4702 "outputMessage": { 4703 "type": "string" 4704 }, 4705 "specifier": { 4706 "type": "string" 4707 }, 4708 "type": { 4709 "type": "string" 4710 } 4711 } 4712 }, 4713 "SOAPInterface": { 4714 "type": "object", 4715 "properties": { 4716 "name": { 4717 "type": "string" 4718 }, 4719 "operations": { 4720 "type": "array", 4721 "items": { 4722 "$ref": "#/definitions/SOAPOperation" 4723 } 4724 } 4725 } 4726 }, 4727 "SOAPOperation": { 4728 "type": "object", 4729 "properties": { 4730 "bindings": { 4731 "type": "array", 4732 "items": { 4733 "$ref": "#/definitions/SOAPBinding" 4734 } 4735 }, 4736 "defined": { 4737 "type": "boolean" 4738 }, 4739 "enabled": { 4740 "type": "boolean" 4741 }, 4742 "isRESTInvokeEnabled": { 4743 "type": "boolean" 4744 }, 4745 "mockedConditionsBasedCustomResponsesList": { 4746 "type": "array", 4747 "items": { 4748 "$ref": "#/definitions/MockedConditionsBasedCustomResponse" 4749 } 4750 }, 4751 "mockedResponses": { 4752 "type": "object", 4753 "additionalProperties": { 4754 "$ref": "#/definitions/MockedResponse" 4755 } 4756 }, 4757 "name": { 4758 "type": "string" 4759 }, 4760 "namespace": { 4761 "type": "string" 4762 }, 4763 "restEnabledPath": { 4764 "$ref": "#/definitions/RestEnabledPath" 4765 }, 4766 "scopes": { 4767 "type": "array", 4768 "items": { 4769 "type": "string" 4770 } 4771 }, 4772 "soapAction": { 4773 "type": "string" 4774 }, 4775 "tags": { 4776 "type": "array", 4777 "items": { 4778 "type": "string" 4779 } 4780 } 4781 } 4782 }, 4783 "Schema": { 4784 "type": "object", 4785 "properties": { 4786 "additionalProperties": { 4787 "$ref": "#/definitions/Schema" 4788 }, 4789 "default": { 4790 "description": "The default value represents what would be assumed by the consumer of the input as the value of the schema if one is not provided. Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object defined at the same level. For example, if type is string, then default can be \"foo\" but cannot be 1", 4791 "type": "object" 4792 }, 4793 "deprecated": { 4794 "description": "Specifies that a schema is deprecated and SHOULD be transitioned out of usage. Default value is false", 4795 "type": "boolean" 4796 }, 4797 "description": { 4798 "description": "Provide a more lengthy explanation about the purpose of the data described by the schema", 4799 "type": "string" 4800 }, 4801 "enum": { 4802 "type": "array", 4803 "items": { 4804 "type": "object" 4805 } 4806 }, 4807 "example": { 4808 "description": "A free-form property to include an example of an instance for this schema. To represent examples that cannot be naturally represented in JSON or YAML, a string value can be used to contain the example with escaping where necessary", 4809 "type": "object" 4810 }, 4811 "exclusiveMaximum": { 4812 "description": "Indicate whether maximum are exclusive of the value", 4813 "type": "boolean" 4814 }, 4815 "exclusiveMinimum": { 4816 "description": "Indicate whether minimum are exclusive of the value", 4817 "type": "boolean" 4818 }, 4819 "externalDocs": { 4820 "$ref": "#/definitions/ExternalDocs" 4821 }, 4822 "format": { 4823 "description": "The format keyword allows for basic semantic validation on certain kinds of string values that are commonly used", 4824 "type": "string" 4825 }, 4826 "get$ref": { 4827 "type": "string" 4828 }, 4829 "maxItems": { 4830 "description": "The maximum length of the array can be specified", 4831 "type": "integer", 4832 "format": "int32" 4833 }, 4834 "maxLength": { 4835 "description": "The maximum length of a string can be constrained using the minLength", 4836 "type": "integer", 4837 "format": "int32" 4838 }, 4839 "maxProperties": { 4840 "description": "The maximum number of properties on an object can be restricted", 4841 "type": "integer", 4842 "format": "int32" 4843 }, 4844 "maximum": { 4845 "description": "Upper limit in the ranges of numbers, (or exclusiveMinimum and exclusiveMaximum for expressing exclusive range)", 4846 "type": "number" 4847 }, 4848 "minItems": { 4849 "description": "The minimum length of the array can be specified", 4850 "type": "integer", 4851 "format": "int32" 4852 }, 4853 "minLength": { 4854 "description": "The minimum length of a string can be constrained using the minLength", 4855 "type": "integer", 4856 "format": "int32" 4857 }, 4858 "minProperties": { 4859 "description": "The minimum number of properties on an object can be restricted", 4860 "type": "integer", 4861 "format": "int32" 4862 }, 4863 "minimum": { 4864 "description": "Lower limit in the ranges of numbers", 4865 "type": "number" 4866 }, 4867 "multipleOf": { 4868 "description": "Numbers can be restricted to a multiple of a given number, using the multipleOf keyword. It may be set to any positive number.", 4869 "type": "number" 4870 }, 4871 "name": { 4872 "description": "User defined name for the property", 4873 "type": "string" 4874 }, 4875 "not": { 4876 "$ref": "#/definitions/Schema" 4877 }, 4878 "nullable": { 4879 "description": "Allows sending a null value for the defined schema. Default value is false", 4880 "type": "boolean" 4881 }, 4882 "pattern": { 4883 "description": "The pattern keyword is used to restrict a string to a particular regular expression. The regular expression syntax is the one defined in JavaScript (ECMA 262 specifically)", 4884 "type": "string" 4885 }, 4886 "properties": { 4887 "description": "The properties (key-value pairs) on an object are defined using the properties keyword. The value of properties is an object, where each key is the name of a property and each value is of type schema used to validate that property", 4888 "type": "object", 4889 "additionalProperties": { 4890 "$ref": "#/definitions/Schema" 4891 } 4892 }, 4893 "readOnly": { 4894 "description": "Relevant only for Schema \"properties\" definitions. Declares the property as \"read only\". This means that it MAY be sent as part of a response but SHOULD NOT be sent as part of the request. If the property is marked as readOnly being true and is in the required list, the required will take effect on the response only. A property MUST NOT be marked as both readOnly and writeOnly being true. Default value is false", 4895 "type": "boolean" 4896 }, 4897 "required": { 4898 "description": "By default, the properties defined by the properties keyword are not required. However, one can provide a list of required properties using the required keyword.\nThe required keyword takes an array of zero or more strings. Each of these strings must be unique.", 4899 "type": "array", 4900 "items": { 4901 "type": "string" 4902 } 4903 }, 4904 "title": { 4905 "description": "User defined title for the property", 4906 "type": "string" 4907 }, 4908 "type": { 4909 "description": "It specifies the data type for a schema", 4910 "type": "string" 4911 }, 4912 "uniqueItems": { 4913 "description": "A schema can ensure that each of the items in an array is unique. Simply set the uniqueItems keyword to true", 4914 "type": "boolean" 4915 }, 4916 "vendorExtensions": { 4917 "type": "object", 4918 "additionalProperties": { 4919 "type": "object" 4920 } 4921 }, 4922 "writeOnly": { 4923 "description": "Relevant only for Schema \"properties\" definitions. Declares the property as \"write only\". Therefore, it MAY be sent as part of a request but SHOULD NOT be sent as part of the response. If the property is marked as writeOnly being true and is in the required list, the required will take effect on the request only. A property MUST NOT be marked as both readOnly and writeOnly being true. Default value is false", 4924 "type": "boolean" 4925 }, 4926 "xml": { 4927 "$ref": "#/definitions/Xml" 4928 } 4929 }, 4930 "discriminator": "type" 4931 }, 4932 "Scope": { 4933 "type": "object", 4934 "properties": { 4935 "description": { 4936 "type": "string" 4937 }, 4938 "getoAuth2ScopeName": { 4939 "type": "string" 4940 }, 4941 "mashedUpAPI": { 4942 "type": "boolean" 4943 }, 4944 "name": { 4945 "type": "string" 4946 }, 4947 "policies": { 4948 "type": "array", 4949 "items": { 4950 "type": "string" 4951 } 4952 } 4953 } 4954 }, 4955 "ScopeInformation": { 4956 "type": "object", 4957 "properties": { 4958 "resourcePath": { 4959 "type": "string" 4960 }, 4961 "supportedOperations": { 4962 "type": "array", 4963 "items": { 4964 "type": "string" 4965 } 4966 } 4967 } 4968 }, 4969 "ScopeResourceIndex": { 4970 "type": "object", 4971 "properties": { 4972 "references": { 4973 "type": "array", 4974 "items": { 4975 "$ref": "#/definitions/ScopeInformation" 4976 } 4977 }, 4978 "scope": { 4979 "$ref": "#/definitions/Scope" 4980 } 4981 } 4982 }, 4983 "SecurityScheme": { 4984 "type": "object", 4985 "properties": { 4986 "bearerFormat": { 4987 "type": "string" 4988 }, 4989 "description": { 4990 "type": "string" 4991 }, 4992 "flows": { 4993 "$ref": "#/definitions/OAuthFlows" 4994 }, 4995 "get$ref": { 4996 "type": "string" 4997 }, 4998 "in": { 4999 "type": "string", 5000 "enum": [ 5001 "COOKIE", 5002 "HEADER", 5003 "QUERY" 5004 ] 5005 }, 5006 "name": { 5007 "type": "string" 5008 }, 5009 "openIdConnectUrl": { 5010 "type": "string" 5011 }, 5012 "scheme": { 5013 "type": "string" 5014 }, 5015 "type": { 5016 "type": "string", 5017 "enum": [ 5018 "APIKEY", 5019 "HTTP", 5020 "OAUTH2", 5021 "OPENIDCONNECT" 5022 ] 5023 }, 5024 "vendorExtensions": { 5025 "type": "object", 5026 "additionalProperties": { 5027 "type": "object" 5028 } 5029 } 5030 } 5031 }, 5032 "SecuritySchemeDescriptor": { 5033 "type": "object", 5034 "properties": { 5035 "headers": { 5036 "type": "object", 5037 "additionalProperties": { 5038 "type": "object" 5039 } 5040 }, 5041 "queryParameters": { 5042 "type": "object", 5043 "additionalProperties": { 5044 "type": "object" 5045 } 5046 }, 5047 "responses": { 5048 "type": "object", 5049 "additionalProperties": { 5050 "type": "object" 5051 } 5052 } 5053 } 5054 }, 5055 "Server": { 5056 "type": "object", 5057 "properties": { 5058 "description": { 5059 "description": "An optional string describing the host designated by the URL", 5060 "type": "string" 5061 }, 5062 "url": { 5063 "description": "A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the OpenAPI document is being served. Variable substitutions will be made when a variable is named in {brackets}", 5064 "type": "string" 5065 }, 5066 "variables": { 5067 "description": "A map between a variable name and its value. The value is used for substitution in the server's URL template", 5068 "type": "object", 5069 "additionalProperties": { 5070 "$ref": "#/definitions/ServerVariable" 5071 } 5072 }, 5073 "vendorExtensions": { 5074 "type": "object", 5075 "additionalProperties": { 5076 "type": "object" 5077 } 5078 } 5079 } 5080 }, 5081 "ServerVariable": { 5082 "type": "object", 5083 "properties": { 5084 "default": { 5085 "type": "string" 5086 }, 5087 "description": { 5088 "description": "An optional description for the server variable", 5089 "type": "string" 5090 }, 5091 "enum": { 5092 "type": "array", 5093 "items": { 5094 "type": "string" 5095 } 5096 }, 5097 "vendorExtensions": { 5098 "type": "object", 5099 "additionalProperties": { 5100 "type": "object" 5101 } 5102 } 5103 } 5104 }, 5105 "ServiceRegistryPublishGetResponse": { 5106 "type": "object", 5107 "properties": { 5108 "publishInfo": { 5109 "$ref": "#/definitions/PublishPayload" 5110 } 5111 } 5112 }, 5113 "ServiceRegistryPublishInfo": { 5114 "type": "object", 5115 "properties": { 5116 "gatewayEndpoints": { 5117 "description": "List of API endpoints of the API. Each element contains an endpoint and the information about the publish status of that endpoint for the current service registry.", 5118 "type": "array", 5119 "uniqueItems": true, 5120 "items": { 5121 "$ref": "#/definitions/Endpoints" 5122 } 5123 }, 5124 "name": { 5125 "description": "Name of the service registry. This field is shown only in response and should not be sent by clients in requests. Only the serviceRegistryId is considered for uniquely identifying the registry.", 5126 "type": "string" 5127 }, 5128 "serviceRegistryId": { 5129 "description": "Uddi key of the service registry created in API Gateway. This field is required.", 5130 "type": "string" 5131 }, 5132 "status": { 5133 "description": "Publish Status of the API for this service registry. This field is shown only in response and should not be sent by clients in requests. Possible values are NEW, PUBLISHED and SUSPENDED. NEW represents the API is not published to the service registry. PUBLISHED represents the API is published to the service registry. SUSPENDED represents the API is published to service registry, but is not currently active (during deactivation of API or shutdown of API Gateway).", 5134 "type": "string", 5135 "enum": [ 5136 "NEW", 5137 "PUBLISHED", 5138 "SUSPENDED" 5139 ] 5140 } 5141 } 5142 }, 5143 "ServiceRegistryPublishPutResponse": { 5144 "type": "object", 5145 "properties": { 5146 "publishResponse": { 5147 "$ref": "#/definitions/PublishResponse" 5148 }, 5149 "publishResponses": { 5150 "description": "This contains the service registry publish status for requests publishing more than one API to one or more service registries.", 5151 "type": "array", 5152 "items": { 5153 "$ref": "#/definitions/PublishResponse" 5154 } 5155 } 5156 } 5157 }, 5158 "ServiceRegistryPublishResponse": { 5159 "type": "object", 5160 "properties": { 5161 "description": { 5162 "description": "Represents the status of the publish operation of the API to the service registry eg: Publish successful, Publish failed, etc", 5163 "type": "string" 5164 }, 5165 "failureReason": { 5166 "description": "Provides the reason for the failure when the publish operation is not successful", 5167 "type": "string" 5168 }, 5169 "gatewayEndpoints": { 5170 "description": "List of API endpoints of the API. Each element contains an endpoint and the information about the publish status of that endpoint for the current service registry.", 5171 "type": "array", 5172 "uniqueItems": true, 5173 "items": { 5174 "$ref": "#/definitions/Endpoints" 5175 } 5176 }, 5177 "serviceRegistryId": { 5178 "description": "Id i.e, UDDI key of the service registry", 5179 "type": "string" 5180 }, 5181 "serviceRegistryName": { 5182 "description": "Name of the service registry", 5183 "type": "string" 5184 }, 5185 "status": { 5186 "description": "Publish Status of the API for this service registry. Possible values are NEW, PUBLISHED and SUSPENDED. NEW represents the API is not published to the service registry. PUBLISHED represents the API is published to the service registry. SUSPENDED represents the API is published to service registry, but is not currently active (during deactivation of API or shutdown of API Gateway).", 5187 "type": "string", 5188 "enum": [ 5189 "NEW", 5190 "PUBLISHED", 5191 "SUSPENDED" 5192 ] 5193 }, 5194 "success": { 5195 "description": "Represents whether the publish of API to the service registry is success. Possible values: true/false", 5196 "type": "boolean" 5197 } 5198 } 5199 }, 5200 "ServiceRegistryUnpublishPutResponse": { 5201 "type": "object", 5202 "properties": { 5203 "unpublishResponse": { 5204 "$ref": "#/definitions/UnpublishResponse" 5205 }, 5206 "unpublishResponses": { 5207 "description": "This contains the service registry unpublish status for requests unpublishing more than one API from one or more service registries.", 5208 "type": "array", 5209 "items": { 5210 "$ref": "#/definitions/UnpublishResponse" 5211 } 5212 } 5213 } 5214 }, 5215 "ServiceRegistryUnpublishResponse": { 5216 "type": "object", 5217 "properties": { 5218 "description": { 5219 "description": "Represents the status of the unpublish operation of the API from the service registry eg: Unpublish successful, Unpublish failed, etc", 5220 "type": "string" 5221 }, 5222 "failureReason": { 5223 "description": "Provides the reason for the failure when the unpublish operation is not successful", 5224 "type": "string" 5225 }, 5226 "serviceRegistryId": { 5227 "description": "Id i.e, UDDI key of the service registry", 5228 "type": "string" 5229 }, 5230 "serviceRegistryName": { 5231 "description": "Name of the service registry", 5232 "type": "string" 5233 }, 5234 "success": { 5235 "description": "Represents whether the unpublish operation of API from the service registry is success. Possible values: true/false", 5236 "type": "boolean" 5237 } 5238 } 5239 }, 5240 "StringProperty": { 5241 "allOf": [ 5242 { 5243 "$ref": "#/definitions/Property" 5244 }, 5245 { 5246 "type": "object", 5247 "properties": { 5248 "default": { 5249 "type": "string" 5250 }, 5251 "enum": { 5252 "type": "array", 5253 "items": { 5254 "type": "string" 5255 } 5256 }, 5257 "maxLength": { 5258 "type": "integer", 5259 "format": "int32" 5260 }, 5261 "minLength": { 5262 "type": "integer", 5263 "format": "int32" 5264 }, 5265 "pattern": { 5266 "type": "string" 5267 } 5268 } 5269 } 5270 ] 5271 }, 5272 "StringSchema": { 5273 "allOf": [ 5274 { 5275 "$ref": "#/definitions/Schema" 5276 }, 5277 { 5278 "type": "object" 5279 } 5280 ] 5281 }, 5282 "StringSchemaModel": { 5283 "allOf": [ 5284 { 5285 "$ref": "#/definitions/Model" 5286 }, 5287 { 5288 "type": "object", 5289 "properties": { 5290 "schema": { 5291 "type": "string" 5292 } 5293 } 5294 } 5295 ] 5296 }, 5297 "StringSchemaProperty": { 5298 "allOf": [ 5299 { 5300 "$ref": "#/definitions/Property" 5301 }, 5302 { 5303 "type": "object", 5304 "properties": { 5305 "schema": { 5306 "type": "string" 5307 } 5308 } 5309 } 5310 ] 5311 }, 5312 "Tag": { 5313 "type": "object", 5314 "properties": { 5315 "description": { 5316 "description": "A short description for the tag", 5317 "type": "string" 5318 }, 5319 "externalDocs": { 5320 "$ref": "#/definitions/ExternalDocs" 5321 }, 5322 "name": { 5323 "description": "The name of the tag", 5324 "type": "string" 5325 }, 5326 "vendorExtensions": { 5327 "type": "object", 5328 "additionalProperties": { 5329 "type": "object" 5330 } 5331 } 5332 } 5333 }, 5334 "Team": { 5335 "type": "object", 5336 "properties": { 5337 "id": { 5338 "description": "Team id", 5339 "type": "string" 5340 }, 5341 "name": { 5342 "description": "Team name", 5343 "type": "string" 5344 }, 5345 "source": { 5346 "description": "The value is to identify whether the team is created from global team assignment or from user or by system", 5347 "type": "string", 5348 "enum": [ 5349 "USER", 5350 "GLOBAL_ASSIGNMENT", 5351 "SYSTEM" 5352 ] 5353 } 5354 } 5355 }, 5356 "UnpublishInfo": { 5357 "type": "object", 5358 "properties": { 5359 "apiId": { 5360 "description": "API id for the API to be unpublished. This field is required.", 5361 "type": "string" 5362 }, 5363 "serviceRegistryIds": { 5364 "description": "List of ids of the service registries from which the API has to be unpublished. This field is required.", 5365 "type": "array", 5366 "items": { 5367 "type": "string" 5368 } 5369 } 5370 } 5371 }, 5372 "UnpublishResponse": { 5373 "type": "object", 5374 "properties": { 5375 "apiId": { 5376 "description": "API id of the API published.", 5377 "type": "string" 5378 }, 5379 "apiName": { 5380 "description": "API name of the API published.", 5381 "type": "string" 5382 }, 5383 "apiVersion": { 5384 "description": "API version of the API published.", 5385 "type": "string" 5386 }, 5387 "serviceRegistryUnpublishResponses": { 5388 "description": "Contains unpublish status of the API for each service registry in the request.", 5389 "type": "array", 5390 "items": { 5391 "$ref": "#/definitions/ServiceRegistryUnpublishResponse" 5392 } 5393 } 5394 } 5395 }, 5396 "Version": { 5397 "type": "object", 5398 "properties": { 5399 "apiId": { 5400 "type": "string" 5401 }, 5402 "versionNumber": { 5403 "type": "string" 5404 } 5405 } 5406 }, 5407 "WebsocketAPI": { 5408 "allOf": [ 5409 { 5410 "$ref": "#/definitions/API" 5411 }, 5412 { 5413 "type": "object", 5414 "properties": { 5415 "externalDocs": { 5416 "type": "array", 5417 "items": { 5418 "$ref": "#/definitions/ExternalDocs" 5419 } 5420 }, 5421 "messages": { 5422 "type": "array", 5423 "items": { 5424 "$ref": "#/definitions/MessageFrame" 5425 } 5426 }, 5427 "nativeUri": { 5428 "type": "array", 5429 "uniqueItems": true, 5430 "items": { 5431 "type": "string" 5432 } 5433 }, 5434 "parameters": { 5435 "type": "object", 5436 "additionalProperties": { 5437 "$ref": "#/definitions/AbstractParameter" 5438 } 5439 }, 5440 "supportedSubProtocols": { 5441 "type": "array", 5442 "items": { 5443 "type": "string" 5444 } 5445 } 5446 } 5447 } 5448 ] 5449 }, 5450 "Xml": { 5451 "type": "object", 5452 "properties": { 5453 "attribute": { 5454 "description": "Declares whether the property definition translates to an attribute instead of an element. Default value is false", 5455 "type": "boolean" 5456 }, 5457 "name": { 5458 "description": "Replaces the name of the element/attribute used for the described schema property. When defined within items, it will affect the name of the individual XML elements within the list. When defined alongside type being array (outside the items), it will affect the wrapping element and only if wrapped is true. If wrapped is false, it will be ignored", 5459 "type": "string" 5460 }, 5461 "namespace": { 5462 "description": "The URI of the namespace definition", 5463 "type": "string" 5464 }, 5465 "prefix": { 5466 "description": "The prefix to be used for the name", 5467 "type": "string" 5468 }, 5469 "vendorExtensions": { 5470 "type": "object", 5471 "additionalProperties": { 5472 "type": "object" 5473 } 5474 }, 5475 "wrapped": { 5476 "description": "MAY be used only for an array definition. Signifies whether the array is wrapped (for example, \u003cbooks\u003e\u003cbook/\u003e\u003cbook/\u003e\u003c/books\u003e) or unwrapped (\u003cbook/\u003e\u003cbook/\u003e). Default value is false", 5477 "type": "boolean" 5478 } 5479 } 5480 }, 5481 "Xpath": { 5482 "type": "object", 5483 "properties": { 5484 "namespaces": { 5485 "type": "array", 5486 "items": { 5487 "$ref": "#/definitions/Namespaces" 5488 } 5489 }, 5490 "xpath": { 5491 "type": "string" 5492 } 5493 } 5494 } 5495 }, 5496 "securityDefinitions": { 5497 "Basic": { 5498 "description": "API Gateway Administrator and API Gateway provider", 5499 "type": "basic" 5500 } 5501 } 5502 }