Last active
October 13, 2017 01:13
-
-
Save KuroNoDev/1ed8c288959690b54b21 to your computer and use it in GitHub Desktop.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| { | |
| "swagger": "2.0", | |
| "info": { | |
| "description": "TORO Integrate API", | |
| "version": "1.0.0", | |
| "title": "TORO Integrate API", | |
| "contact": { | |
| "name": "" | |
| }, | |
| "license": { | |
| "name": "", | |
| "url": "" | |
| } | |
| }, | |
| "host": "localhost:8080", | |
| "basePath": "/", | |
| "tags": [ | |
| { | |
| "name": "gloop" | |
| }, | |
| { | |
| "name": "examples-services", | |
| "description": "TORO Integrate Example REST Services." | |
| }, | |
| { | |
| "name": "examples-messaging", | |
| "description": "TORO Integrate Example REST Services" | |
| }, | |
| { | |
| "name": "examples-reports", | |
| "description": "" | |
| }, | |
| { | |
| "name": "database", | |
| "description": "Database API" | |
| }, | |
| { | |
| "name": "endpoint", | |
| "description": "Endpoint API" | |
| }, | |
| { | |
| "name": "tracker", | |
| "description": "Tracker API" | |
| }, | |
| { | |
| "name": "access-control", | |
| "description": "Access control API" | |
| }, | |
| { | |
| "name": "system", | |
| "description": "System API" | |
| }, | |
| { | |
| "name": "properties", | |
| "description": "Properties API" | |
| }, | |
| { | |
| "name": "package", | |
| "description": "Package API" | |
| }, | |
| { | |
| "name": "monitor", | |
| "description": "Monitor API" | |
| }, | |
| { | |
| "name": "session", | |
| "description": "Session API" | |
| }, | |
| { | |
| "name": "invocable", | |
| "description": "Service Invocation API" | |
| }, | |
| { | |
| "name": "marketplace", | |
| "description": "Marketplace API" | |
| }, | |
| { | |
| "name": "broker", | |
| "description": "Broker API" | |
| }, | |
| { | |
| "name": "file-system", | |
| "description": "File system API" | |
| } | |
| ], | |
| "schemes": [ | |
| "http" | |
| ], | |
| "produces": [], | |
| "paths": { | |
| "/api/testGloop/{filename}/{content}/": { | |
| "get": { | |
| "tags": [ | |
| "gloop" | |
| ], | |
| "summary": "/api/testGloop/{filename}/{content}/", | |
| "operationId": "Test", | |
| "consumes": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "filename", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "content", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ] | |
| }, | |
| "post": { | |
| "tags": [ | |
| "gloop" | |
| ], | |
| "summary": "/api/testGloop/{filename}/{content}/", | |
| "operationId": "Test", | |
| "consumes": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "filename", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "content", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ] | |
| } | |
| }, | |
| "/api/examples-services/sql/add-employee": { | |
| "post": { | |
| "tags": [ | |
| "examples-services" | |
| ], | |
| "summary": "sql/add-employee", | |
| "description": "TORO Integrate allows you to easily get a <a href=\"http://docs.groovy-lang.org/docs/latest/html/api/groovy/sql/Sql.html\">Groovy SQL</a> object that's already connected to a TORO Integrate JDBC Connection pool. This script shows how easy it is to expose a RESTful api that uses a database to add a record.", | |
| "operationId": "addEmployee", | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "employee", | |
| "description": "The employee to add. This example uses a strongly typed object that contains JAXB and validation annotations.", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/Employee" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/APIResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/examples-services/sql/delete/{id}": { | |
| "delete": { | |
| "tags": [ | |
| "examples-services" | |
| ], | |
| "summary": "sql/delete/{id}", | |
| "description": "Simple method that shows how to delete a record. The ID is part of the URI when used via REST. <br> Usage: Input an employee ID, click invoke / execute. <br> Note: Add an employee first by using the (POST) AddEmployee / (POST) BulkInsertEmployees endpoint.", | |
| "operationId": "deleteEmployee", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "The employee ID. ", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| ], | |
| "responses": { | |
| "404": { | |
| "description": "Employee not found " | |
| } | |
| } | |
| } | |
| }, | |
| "/api/examples-services/get-bill": { | |
| "get": { | |
| "tags": [ | |
| "examples-services" | |
| ], | |
| "summary": "/get-bill", | |
| "description": "This code can be used to run on a schedule, say the first day of the month. This code will use last month as the billing period", | |
| "operationId": "getMonitorBills", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/MonitorBill" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/examples-services/sql/bulk-insert": { | |
| "post": { | |
| "tags": [ | |
| "examples-services" | |
| ], | |
| "summary": "sql/bulk-insert", | |
| "description": "Send a comma separated list of employee records in the following format to this method to add multiple employee records in one request: <pre> <name1>,<position1>,<department1><br/> <name2>,<position2>,<department2><br/> ... </pre>", | |
| "operationId": "bulkInsertEmployees", | |
| "consumes": [ | |
| "multipart/form-data" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "body", | |
| "in": "formData", | |
| "required": false, | |
| "type": "file" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/examples-messaging/test-async": { | |
| "get": { | |
| "tags": [ | |
| "examples-messaging" | |
| ], | |
| "summary": "test-async", | |
| "description": "This snippet demonstrates an asynchronous method using a closure, that will return a string containing the current thread, request thread, request and response objects.", | |
| "operationId": "testAsync", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/examples-services/get-bill/{year}/{month}": { | |
| "get": { | |
| "tags": [ | |
| "examples-services" | |
| ], | |
| "summary": "/get-bill/{year}/{month}", | |
| "description": "Gets a list of monitor bill records for all users in the ESB. The monitor bill records will just show the total (summed) costs and the first 20 service invokes.", | |
| "operationId": "getMonitorBills", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "year", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "name": "month", | |
| "in": "path", | |
| "description": "zero-based month. 0 = January, 1 = February, etc. ", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/MonitorBill" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/examples-services/sql/update/{id}": { | |
| "patch": { | |
| "tags": [ | |
| "examples-services" | |
| ], | |
| "summary": "sql/update/{id}", | |
| "description": "Simple method that shows how to update a record. The ID is part of the URI when used via REST. <br> Usage: Input id of employee to be updated and employee record click invoke / execute. The ID here is ignored. <br> Note: Add an employee first by using the (POST) AddEmployee / (POST) BulkInsertEmployees endpoint. <br>", | |
| "operationId": "updateEmployee", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "The employee ID. ", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "employee", | |
| "description": "The employee record. The ID here is ignored. ", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/Employee" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "404": { | |
| "description": "Employee not found " | |
| } | |
| } | |
| } | |
| }, | |
| "/api/examples-reports/populateExampleData": { | |
| "post": { | |
| "tags": [ | |
| "examples-reports" | |
| ], | |
| "summary": "populateExampleData", | |
| "description": "This will generate example records in the Monitor search index. <br/>", | |
| "operationId": "populateExampleData", | |
| "parameters": [ | |
| { | |
| "name": "startDate", | |
| "in": "query", | |
| "description": "The date will be randomized based on the start date FORMAT: YYYY-MM-DD ", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "endDate", | |
| "in": "query", | |
| "description": "The date will be randomized based on the end date FORMAT: YYYY-MM-DD ", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "maxRecord", | |
| "in": "query", | |
| "description": "the total random record count to be generated ", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "name": "examplePackageMaxCount", | |
| "in": "query", | |
| "description": "the total example package to be used. Ex: value:10 will randomize from Package_00 to Package_0010 ", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "name": "exampleUserMaxCount", | |
| "in": "query", | |
| "description": "the total example users to be used. Ex: value:10 will randomize from User_00 to User_010 ", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "name": "exampleEndpointNameMaxCount", | |
| "in": "query", | |
| "description": "the total example endpoint name to be used. Ex: value:10 will randomize from endpoint_00 to endpoint_010", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/APIResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/examples-services/forecast/{token}/{latitude}/{longitude}": { | |
| "get": { | |
| "tags": [ | |
| "examples-services" | |
| ], | |
| "summary": "/forecast/{token}/{latitude}/{longitude}", | |
| "description": "This is an example service using TORO One Liner methods by calling Dark Sky API. Read <a href= \"https://darksky.net/dev/docs/forecast\">here</a> for more info.", | |
| "operationId": "displayForecast", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "token", | |
| "in": "path", | |
| "description": "The forecast.io access token to use the API ", | |
| "required": true, | |
| "type": "string", | |
| "default": "bebbf6601cb9b32f96c99ce10cebf27b" | |
| }, | |
| { | |
| "name": "latitude", | |
| "in": "path", | |
| "description": "value from target coordinates. ", | |
| "required": true, | |
| "type": "string", | |
| "default": "15.1462752" | |
| }, | |
| { | |
| "name": "longitude", | |
| "in": "path", | |
| "description": "value from target coordinates.", | |
| "required": true, | |
| "type": "string", | |
| "default": "120.5594641" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/examples-reports/deleteExampleData": { | |
| "post": { | |
| "tags": [ | |
| "examples-reports" | |
| ], | |
| "summary": "deleteExampleData", | |
| "description": "This will remove all the generated example records from the Monitor search index.", | |
| "operationId": "deleteExampleData", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/APIResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/examples-services/readtext": { | |
| "post": { | |
| "tags": [ | |
| "examples-services" | |
| ], | |
| "summary": "readtext", | |
| "description": "Simple operation that reads a file and sends back the content <br>(only works for known text-based file extensions, .txt, .doc, .json, .yml, .html, .htm, .java, .docx, .groovy, .xml, .jsp, .js, .css ).", | |
| "operationId": "readTextFile", | |
| "consumes": [ | |
| "multipart/form-data" | |
| ], | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "file", | |
| "in": "formData", | |
| "required": false, | |
| "type": "file" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/APIResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/examples-messaging/email/send": { | |
| "post": { | |
| "tags": [ | |
| "examples-messaging" | |
| ], | |
| "summary": "email/send", | |
| "description": "This snippet shows how to send email messages asynchronously with TORO Integrate. Simply provide it with a your smtp(s) details, to address, subject and the recipient's name. TORO Integrate will then send the email for you. Read more about the endpoint <a href=\"http://docs.toro.io/display/INT/Email\">here</a>. If you look at the source you'll see that the actual code is simply wrapped in a set of extra braces. TORO Integrate will then invoke the code asynchronously! This is useful for requests that take a little while. The thread that initially processed the request is put back into the pool ready to process another request. The actual code itself is invoked from another thread. When the service completes, a response is served from another thread", | |
| "operationId": "sendEmail", | |
| "parameters": [ | |
| { | |
| "name": "protocol", | |
| "in": "query", | |
| "description": "The SMTP/S protocol to use, must be smtp or smtps. ", | |
| "required": true, | |
| "type": "string", | |
| "enum": [ | |
| "smtp", | |
| "smtps" | |
| ] | |
| }, | |
| { | |
| "name": "emailLogin", | |
| "in": "query", | |
| "description": "The login/email address to use to log in to the SMTP/S server ", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "password", | |
| "in": "query", | |
| "description": "Your password ", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "server", | |
| "in": "query", | |
| "description": "SMTP/S server name/IP ", | |
| "required": true, | |
| "type": "string", | |
| "default": "smtp.gmail.com" | |
| }, | |
| { | |
| "name": "port", | |
| "in": "query", | |
| "description": "Server port number ", | |
| "required": true, | |
| "type": "integer", | |
| "default": 587, | |
| "format": "int32" | |
| }, | |
| { | |
| "name": "to", | |
| "in": "query", | |
| "description": "The recipient's email address ", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "subject", | |
| "in": "query", | |
| "description": "The email subject ", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "recipientName", | |
| "in": "query", | |
| "description": "The recipient's name", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/CallableAPIResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/examples-messaging/jms/publish/{jmsQueue}": { | |
| "get": { | |
| "tags": [ | |
| "examples-messaging" | |
| ], | |
| "summary": "jms/publish/{jmsQueue:.+}", | |
| "description": "This example shows how easy it is to send a message to a particular Topic on the Broker.<br> See <a href=\"http://docs.toro.io/toro-integrate/user-guide/developing/creating-a-service/writing-a-service/groovy-extension-modules\">here</a> for more information", | |
| "operationId": "sendJMSMessage", | |
| "parameters": [ | |
| { | |
| "name": "jmsQueue", | |
| "in": "path", | |
| "description": "The name of the topic to send the text to ", | |
| "required": true, | |
| "type": "string", | |
| "maxLength": 20, | |
| "minLength": 1 | |
| }, | |
| { | |
| "name": "messageContent", | |
| "in": "query", | |
| "description": "The message content", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/examples-services/weather/{city}/{countryCode}/{temperatureScale}": { | |
| "get": { | |
| "tags": [ | |
| "examples-services" | |
| ], | |
| "summary": "/weather/{city}/{countryCode}/{temperatureScale}", | |
| "description": "Simple HTTP example. This example does a HTTP post to a specific url. It then uses built-in libraries to parse the response as json, and display various parameters from the response. Enter a city and country code, it will then get the current weather for the location from <a href=\"http://openweathermap.org/\">http://openweathermap.org/</a>", | |
| "operationId": "getWeather", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "city", | |
| "in": "path", | |
| "description": "The city to get weather information for ", | |
| "required": true, | |
| "type": "string", | |
| "default": "Sydney", | |
| "maxLength": 20, | |
| "minLength": 2 | |
| }, | |
| { | |
| "name": "countryCode", | |
| "in": "path", | |
| "description": "The 2 letter country code where the city belongs ", | |
| "required": true, | |
| "type": "string", | |
| "default": "AU", | |
| "maxLength": 2, | |
| "minLength": 2 | |
| }, | |
| { | |
| "name": "temperatureScale", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/examples-services/calculate-bill": { | |
| "post": { | |
| "tags": [ | |
| "examples-services" | |
| ], | |
| "summary": "/calculate-bill", | |
| "description": "Here is an example method that calculates costs as follows: The first 10,000 calls a month are $100.00 (100 calls per dollar) The next 20,000 calls a month are $150.00 (133.33 calls per dollar, $250 in total) Each 1,000 calls after that are $2.00 (500 calls per dollar, $250 + X in total)", | |
| "operationId": "calculateCost", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "monitorBill", | |
| "description": "Monitor bill object from the solr schema ", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/definitions/MonitorBill" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/MonitorBill" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/examples-services/sql/get/{id}": { | |
| "get": { | |
| "tags": [ | |
| "examples-services" | |
| ], | |
| "summary": "sql/get/{id}", | |
| "description": "This method returns a single employee object. Unlike the list method, this returns a populated employee object. <br> Usage: Input employee id and click invoke / execute. <br> Note: Add an employee first by using the (POST) AddEmployee / (POST) BulkInsertEmployees endpoint.", | |
| "operationId": "getEmployee", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "the employee id to get ", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| ], | |
| "responses": { | |
| "404": { | |
| "description": "Employee not found " | |
| } | |
| } | |
| } | |
| }, | |
| "/api/examples-services/sql/list": { | |
| "get": { | |
| "tags": [ | |
| "examples-services" | |
| ], | |
| "summary": "sql/list", | |
| "description": "This method shows one way of iterating through a table and returning data from inside it.<br> Note: Add an employee first by using the (POST) add employee endpoint.", | |
| "operationId": "getEmployees", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/esbapi/databases/drivers": { | |
| "get": { | |
| "tags": [ | |
| "database" | |
| ], | |
| "operationId": "getDrivers", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [] | |
| } | |
| }, | |
| "/esbapi/databases/{name}/procedures/{procedureName}/columns": { | |
| "get": { | |
| "tags": [ | |
| "database" | |
| ], | |
| "operationId": "getDatabaseProcedureColumns", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "procedureName", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "catalogName", | |
| "in": "query", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "schemaPattern", | |
| "in": "query", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "columnNamePattern", | |
| "in": "query", | |
| "required": false, | |
| "type": "string" | |
| } | |
| ] | |
| } | |
| }, | |
| "/esbapi/packages/{packageName}/endpoints/{name}": { | |
| "get": { | |
| "tags": [ | |
| "endpoint" | |
| ], | |
| "operationId": "getEndpoint", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "packageName", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "name", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ] | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "endpoint" | |
| ], | |
| "operationId": "deleteEndpoint", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "packageName", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "name", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ] | |
| } | |
| }, | |
| "/esbapi/tracker/documents/{internalId}": { | |
| "get": { | |
| "tags": [ | |
| "tracker" | |
| ], | |
| "operationId": "getDocument", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "internalId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ] | |
| } | |
| }, | |
| "/esbapi/databases": { | |
| "get": { | |
| "tags": [ | |
| "database" | |
| ], | |
| "operationId": "getDatabases", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "description": "Match names containing", | |
| "required": false | |
| }, | |
| { | |
| "name": "page", | |
| "in": "query", | |
| "description": "Page to query", | |
| "required": false, | |
| "type": "integer", | |
| "default": 0 | |
| }, | |
| { | |
| "name": "size", | |
| "in": "query", | |
| "description": "Size of result set", | |
| "required": false, | |
| "type": "integer", | |
| "default": 20 | |
| } | |
| ] | |
| }, | |
| "post": { | |
| "tags": [ | |
| "database" | |
| ], | |
| "operationId": "saveDatabase", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "info", | |
| "required": false, | |
| "schema": { | |
| "$ref": "#/definitions/jdbc-connection-info" | |
| } | |
| } | |
| ] | |
| } | |
| }, | |
| "/esbapi/access-control/users/{username}": { | |
| "get": { | |
| "tags": [ | |
| "access-control" | |
| ], | |
| "operationId": "getUser", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "username", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ] | |
| }, | |
| "put": { | |
| "tags": [ | |
| "access-control" | |
| ], | |
| "operationId": "updateUser", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "username", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "payload", | |
| "required": false, | |
| "schema": { | |
| "$ref": "#/definitions/Payload" | |
| } | |
| } | |
| ] | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "access-control" | |
| ], | |
| "operationId": "deleteUser", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "username", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ] | |
| } | |
| }, | |
| "/esbapi/databases/{name}": { | |
| "get": { | |
| "tags": [ | |
| "database" | |
| ], | |
| "operationId": "getDatabase", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ] | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "database" | |
| ], | |
| "operationId": "deleteDatabase", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ] | |
| } | |
| }, | |
| "/esbapi/system/logs": { | |
| "get": { | |
| "tags": [ | |
| "system" | |
| ], | |
| "operationId": "downloadLogs", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "date", | |
| "in": "query", | |
| "required": false, | |
| "type": "string", | |
| "format": "date-time" | |
| } | |
| ] | |
| } | |
| }, | |
| "/esbapi/packages/{packageName}/endpoints/{name}/enable": { | |
| "put": { | |
| "tags": [ | |
| "endpoint" | |
| ], | |
| "operationId": "enableEndpoint", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "packageName", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "name", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ] | |
| } | |
| }, | |
| "/esbapi/databases/test": { | |
| "post": { | |
| "tags": [ | |
| "database" | |
| ], | |
| "operationId": "testDatabaseConnection", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "info", | |
| "required": false, | |
| "schema": { | |
| "$ref": "#/definitions/jdbc-connection-info" | |
| } | |
| } | |
| ] | |
| } | |
| }, | |
| "/esbapi/tracker/documents/{internalId}/content": { | |
| "get": { | |
| "tags": [ | |
| "tracker" | |
| ], | |
| "operationId": "getDocumentStateContent", | |
| "produces": [ | |
| "application/octet-stream" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "internalId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "stateId", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| ] | |
| } | |
| }, | |
| "/esbapi/properties": { | |
| "get": { | |
| "tags": [ | |
| "properties" | |
| ], | |
| "operationId": "getProperties", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "keys", | |
| "in": "query", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| } | |
| ] | |
| }, | |
| "post": { | |
| "tags": [ | |
| "properties" | |
| ], | |
| "operationId": "saveProperties", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "parameters", | |
| "in": "query", | |
| "required": false, | |
| "type": "object" | |
| } | |
| ] | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "properties" | |
| ], | |
| "operationId": "deleteProperties", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "keys", | |
| "in": "query", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| } | |
| ] | |
| } | |
| }, | |
| "/esbapi/access-control/users": { | |
| "get": { | |
| "tags": [ | |
| "access-control" | |
| ], | |
| "operationId": "getUsers", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "username", | |
| "in": "query", | |
| "description": "Match username containing", | |
| "required": false | |
| }, | |
| { | |
| "name": "displayName", | |
| "in": "query", | |
| "description": "Match displayName containing", | |
| "required": false | |
| }, | |
| { | |
| "name": "emailAddress", | |
| "in": "query", | |
| "description": "Match email containing", | |
| "required": false | |
| }, | |
| { | |
| "name": "page", | |
| "in": "query", | |
| "description": "Page to query", | |
| "required": false, | |
| "type": "integer", | |
| "default": 0 | |
| }, | |
| { | |
| "name": "size", | |
| "in": "query", | |
| "description": "Size of result set", | |
| "required": false, | |
| "type": "integer", | |
| "default": 20 | |
| } | |
| ] | |
| }, | |
| "post": { | |
| "tags": [ | |
| "access-control" | |
| ], | |
| "operationId": "saveUser", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "payload", | |
| "required": false, | |
| "schema": { | |
| "$ref": "#/definitions/Payload" | |
| } | |
| } | |
| ] | |
| } | |
| }, | |
| "/esbapi/access-control/users/{username}/change-password": { | |
| "post": { | |
| "tags": [ | |
| "access-control" | |
| ], | |
| "operationId": "changeUserPassword", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "username", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "payload", | |
| "required": false, | |
| "schema": { | |
| "$ref": "#/definitions/PasswordChangePayload" | |
| } | |
| } | |
| ] | |
| } | |
| }, | |
| "/esbapi/access-control/groups/{name}": { | |
| "delete": { | |
| "tags": [ | |
| "access-control" | |
| ], | |
| "operationId": "deleteGroup", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ] | |
| } | |
| }, | |
| "/esbapi/packages/{name}": { | |
| "get": { | |
| "tags": [ | |
| "package" | |
| ], | |
| "operationId": "getPackage", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ] | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "package" | |
| ], | |
| "operationId": "deletePackage", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ] | |
| } | |
| }, | |
| "/esbapi/packages/{packageName}/endpoints/{name}/stop": { | |
| "put": { | |
| "tags": [ | |
| "endpoint" | |
| ], | |
| "operationId": "stopEndpoint", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "packageName", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "name", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ] | |
| } | |
| }, | |
| "/esbapi/access-control/groups": { | |
| "get": { | |
| "tags": [ | |
| "access-control" | |
| ], | |
| "operationId": "getGroups", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "description": "Match names containing", | |
| "required": false | |
| }, | |
| { | |
| "name": "page", | |
| "in": "query", | |
| "description": "Page to query", | |
| "required": false, | |
| "type": "integer", | |
| "default": 0 | |
| }, | |
| { | |
| "name": "size", | |
| "in": "query", | |
| "description": "Size of result set", | |
| "required": false, | |
| "type": "integer", | |
| "default": 20 | |
| } | |
| ] | |
| }, | |
| "post": { | |
| "tags": [ | |
| "access-control" | |
| ], | |
| "operationId": "saveGroup", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "groupName", | |
| "in": "query", | |
| "required": false, | |
| "type": "string" | |
| } | |
| ] | |
| } | |
| }, | |
| "/esbapi/access-control/users/{username}/token": { | |
| "get": { | |
| "tags": [ | |
| "access-control" | |
| ], | |
| "operationId": "getUserToken", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "username", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ] | |
| }, | |
| "post": { | |
| "tags": [ | |
| "access-control" | |
| ], | |
| "operationId": "generateUserToken", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "username", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ] | |
| } | |
| }, | |
| "/esbapi/monitor/{id}": { | |
| "get": { | |
| "tags": [ | |
| "monitor" | |
| ], | |
| "operationId": "getRuleById", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ] | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "monitor" | |
| ], | |
| "operationId": "deleteRuleById", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ] | |
| } | |
| }, | |
| "/esbapi/databases/{name}/tables": { | |
| "get": { | |
| "tags": [ | |
| "database" | |
| ], | |
| "operationId": "getDatabaseTables", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "catalogName", | |
| "in": "query", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "schemaPattern", | |
| "in": "query", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "tableNamePattern", | |
| "in": "query", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "types", | |
| "in": "query", | |
| "required": false, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| } | |
| ] | |
| } | |
| }, | |
| "/esbapi/packages/{packageName}/endpoints/validate": { | |
| "put": { | |
| "tags": [ | |
| "endpoint" | |
| ], | |
| "operationId": "validateEndpoint", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "packageName", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "endpointModel", | |
| "required": false, | |
| "schema": { | |
| "$ref": "#/definitions/EndpointModel" | |
| } | |
| } | |
| ] | |
| } | |
| }, | |
| "/esbapi/monitor": { | |
| "get": { | |
| "tags": [ | |
| "monitor" | |
| ], | |
| "operationId": "getRules", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "description": "Match names containing", | |
| "required": false | |
| }, | |
| { | |
| "name": "page", | |
| "in": "query", | |
| "description": "Page to query", | |
| "required": false, | |
| "type": "integer", | |
| "default": 0 | |
| }, | |
| { | |
| "name": "size", | |
| "in": "query", | |
| "description": "Size of result set", | |
| "required": false, | |
| "type": "integer", | |
| "default": 20 | |
| } | |
| ] | |
| }, | |
| "post": { | |
| "tags": [ | |
| "monitor" | |
| ], | |
| "operationId": "saveRule", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "rule", | |
| "required": false, | |
| "schema": { | |
| "$ref": "#/definitions/Rule" | |
| } | |
| } | |
| ] | |
| } | |
| }, | |
| "/esbapi/packages/{name}/start": { | |
| "put": { | |
| "tags": [ | |
| "package" | |
| ], | |
| "operationId": "startPackage", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ] | |
| } | |
| }, | |
| "/esbapi/access-control/groups/{groupName}": { | |
| "get": { | |
| "tags": [ | |
| "access-control" | |
| ], | |
| "operationId": "getGroup", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "groupName", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ] | |
| }, | |
| "put": { | |
| "tags": [ | |
| "access-control" | |
| ], | |
| "operationId": "addUserToGroup", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "groupName", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "username", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ] | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "access-control" | |
| ], | |
| "operationId": "removeUserFromGroup", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "groupName", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "username", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ] | |
| } | |
| }, | |
| "/esbapi/packages": { | |
| "get": { | |
| "tags": [ | |
| "package" | |
| ], | |
| "operationId": "getPackages", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "description": "Match names containing", | |
| "required": false | |
| }, | |
| { | |
| "name": "page", | |
| "in": "query", | |
| "description": "Page to query", | |
| "required": false, | |
| "type": "integer", | |
| "default": 0 | |
| }, | |
| { | |
| "name": "size", | |
| "in": "query", | |
| "description": "Size of result set", | |
| "required": false, | |
| "type": "integer", | |
| "default": 20 | |
| } | |
| ] | |
| }, | |
| "post": { | |
| "tags": [ | |
| "package" | |
| ], | |
| "operationId": "savePackage", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "model", | |
| "required": false, | |
| "schema": { | |
| "$ref": "#/definitions/ESBPackage Model" | |
| } | |
| } | |
| ] | |
| } | |
| }, | |
| "/esbapi/monitor/{id}/disable": { | |
| "put": { | |
| "tags": [ | |
| "monitor" | |
| ], | |
| "operationId": "disableRuleById", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ] | |
| } | |
| }, | |
| "/esbapi/databases/{name}/procedures": { | |
| "get": { | |
| "tags": [ | |
| "database" | |
| ], | |
| "operationId": "getDatabaseProcedures", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "catalogName", | |
| "in": "query", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "schemaPattern", | |
| "in": "query", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "procedureNamePattern", | |
| "in": "query", | |
| "required": false, | |
| "type": "string" | |
| } | |
| ] | |
| } | |
| }, | |
| "/esbapi/access-control/users/{username}/enable": { | |
| "put": { | |
| "tags": [ | |
| "access-control" | |
| ], | |
| "operationId": "enableUser", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "username", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ] | |
| } | |
| }, | |
| "/esbapi/session": { | |
| "get": { | |
| "tags": [ | |
| "session" | |
| ], | |
| "operationId": "currentSession", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [] | |
| } | |
| }, | |
| "/esbapi/packages/{packageName}/service-groups": { | |
| "get": { | |
| "tags": [ | |
| "invocable" | |
| ], | |
| "operationId": "getSupportedServiceGroups", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "description": "Match names containing", | |
| "required": false | |
| }, | |
| { | |
| "name": "type", | |
| "in": "query", | |
| "description": "Type matching", | |
| "required": false, | |
| "enum": [ | |
| "bean", | |
| "javascript", | |
| "gloop", | |
| "flux", | |
| "class", | |
| "groovy", | |
| "java" | |
| ] | |
| }, | |
| { | |
| "name": "page", | |
| "in": "query", | |
| "description": "Page to query", | |
| "required": false, | |
| "type": "integer", | |
| "default": 0 | |
| }, | |
| { | |
| "name": "size", | |
| "in": "query", | |
| "description": "Size of result set", | |
| "required": false, | |
| "type": "integer", | |
| "default": 20 | |
| } | |
| ] | |
| } | |
| }, | |
| "/esbapi/databases/{name}/tables/{tableName}/columns": { | |
| "get": { | |
| "tags": [ | |
| "database" | |
| ], | |
| "operationId": "getDatabaseTableColumns", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "tableName", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "catalogName", | |
| "in": "query", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "schemaPattern", | |
| "in": "query", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "columnNamePattern", | |
| "in": "query", | |
| "required": false, | |
| "type": "string" | |
| } | |
| ] | |
| } | |
| }, | |
| "/esbapi/access-control/users/{username}/disable": { | |
| "put": { | |
| "tags": [ | |
| "access-control" | |
| ], | |
| "operationId": "disableUser", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "username", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ] | |
| } | |
| }, | |
| "/esbapi/properties/reload": { | |
| "put": { | |
| "tags": [ | |
| "properties" | |
| ], | |
| "operationId": "reloadProperties", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [] | |
| } | |
| }, | |
| "/esbapi/marketplace/items/{id}/install": { | |
| "put": { | |
| "tags": [ | |
| "marketplace" | |
| ], | |
| "operationId": "installMarketItem", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "type", | |
| "in": "query", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "version", | |
| "in": "query", | |
| "required": false, | |
| "type": "string" | |
| } | |
| ] | |
| } | |
| }, | |
| "/esbapi/databases/{name}/start": { | |
| "put": { | |
| "tags": [ | |
| "database" | |
| ], | |
| "operationId": "startDatabase", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ] | |
| } | |
| }, | |
| "/esbapi/packages/upload": { | |
| "post": { | |
| "tags": [ | |
| "package" | |
| ], | |
| "operationId": "uploadPackage", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "file", | |
| "in": "formData", | |
| "required": false, | |
| "type": "file" | |
| }, | |
| { | |
| "name": "startOnCreate", | |
| "in": "query", | |
| "required": false, | |
| "type": "boolean" | |
| } | |
| ] | |
| } | |
| }, | |
| "/esbapi/databases/{name}/keywords": { | |
| "get": { | |
| "tags": [ | |
| "database" | |
| ], | |
| "operationId": "getDatabaseKeywords", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "type", | |
| "in": "query", | |
| "required": false, | |
| "type": "string" | |
| } | |
| ] | |
| } | |
| }, | |
| "/esbapi/packages/{packageName}/service-groups/{groupName}/services": { | |
| "get": { | |
| "tags": [ | |
| "invocable" | |
| ], | |
| "operationId": "getSupportedServices", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "description": "Match names containing", | |
| "required": false | |
| }, | |
| { | |
| "name": "page", | |
| "in": "query", | |
| "description": "Page to query", | |
| "required": false, | |
| "type": "integer", | |
| "default": 0 | |
| }, | |
| { | |
| "name": "size", | |
| "in": "query", | |
| "description": "Size of result set", | |
| "required": false, | |
| "type": "integer", | |
| "default": 20 | |
| } | |
| ] | |
| } | |
| }, | |
| "/esbapi/databases/{name}/functions": { | |
| "get": { | |
| "tags": [ | |
| "database" | |
| ], | |
| "operationId": "getDatabaseFunctions", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "catalogName", | |
| "in": "query", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "schemaPattern", | |
| "in": "query", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "functionNamePattern", | |
| "in": "query", | |
| "required": false, | |
| "type": "string" | |
| } | |
| ] | |
| } | |
| }, | |
| "/esbapi/monitor/{id}/enable": { | |
| "put": { | |
| "tags": [ | |
| "monitor" | |
| ], | |
| "operationId": "enableRuleById", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ] | |
| } | |
| }, | |
| "/esbapi/packages/{packageName}/endpoints/{name}/start": { | |
| "put": { | |
| "tags": [ | |
| "endpoint" | |
| ], | |
| "operationId": "startEndpoint", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "packageName", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "name", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ] | |
| } | |
| }, | |
| "/esbapi/databases/{name}/schemas": { | |
| "get": { | |
| "tags": [ | |
| "database" | |
| ], | |
| "operationId": "getDatabaseSchemas", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ] | |
| } | |
| }, | |
| "/esbapi/packages/{packageName}/endpoints": { | |
| "get": { | |
| "tags": [ | |
| "endpoint" | |
| ], | |
| "operationId": "getEndpoints", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "description": "Match names containing", | |
| "required": false | |
| }, | |
| { | |
| "name": "type", | |
| "in": "query", | |
| "description": "Type matching", | |
| "required": false, | |
| "enum": [ | |
| "any", | |
| "dir-watcher", | |
| "email", | |
| "ftp-client", | |
| "ftp-server", | |
| "jabber", | |
| "jms-listener", | |
| "rest-alias", | |
| "rss", | |
| "scheduler", | |
| "tracker-resubmit", | |
| "unrecognized" | |
| ] | |
| }, | |
| { | |
| "name": "page", | |
| "in": "query", | |
| "description": "Page to query", | |
| "required": false, | |
| "type": "integer", | |
| "default": 0 | |
| }, | |
| { | |
| "name": "size", | |
| "in": "query", | |
| "description": "Size of result set", | |
| "required": false, | |
| "type": "integer", | |
| "default": 20 | |
| } | |
| ] | |
| }, | |
| "post": { | |
| "tags": [ | |
| "endpoint" | |
| ], | |
| "operationId": "saveEndpoint", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "packageName", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "endpointModel", | |
| "required": false, | |
| "schema": { | |
| "$ref": "#/definitions/EndpointModel" | |
| } | |
| } | |
| ] | |
| } | |
| }, | |
| "/esbapi/system/restart": { | |
| "put": { | |
| "tags": [ | |
| "system" | |
| ], | |
| "operationId": "restart", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [] | |
| } | |
| }, | |
| "/esbapi/packages/{packageName}/download": { | |
| "get": { | |
| "tags": [ | |
| "package" | |
| ], | |
| "operationId": "downloadPackage", | |
| "produces": [ | |
| "application/octet-stream" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "packageName", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "includePackageProperties", | |
| "in": "query", | |
| "required": false, | |
| "type": "boolean" | |
| } | |
| ] | |
| } | |
| }, | |
| "/esbapi/tracker/documents/{internalId}/resubmit": { | |
| "post": { | |
| "tags": [ | |
| "tracker" | |
| ], | |
| "operationId": "resubmitDocumentState", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "internalId", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "stateId", | |
| "in": "query", | |
| "required": false, | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| ] | |
| } | |
| }, | |
| "/esbapi/session/logout": { | |
| "post": { | |
| "tags": [ | |
| "session" | |
| ], | |
| "operationId": "logout", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [] | |
| } | |
| }, | |
| "/esbapi/tracker/documents": { | |
| "get": { | |
| "tags": [ | |
| "tracker" | |
| ], | |
| "operationId": "searchDocuments", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "page", | |
| "in": "query", | |
| "description": "Page to query", | |
| "required": false, | |
| "type": "integer", | |
| "default": 0 | |
| }, | |
| { | |
| "name": "size", | |
| "in": "query", | |
| "description": "Size of result set", | |
| "required": false, | |
| "type": "integer", | |
| "default": 20 | |
| } | |
| ] | |
| } | |
| }, | |
| "/esbapi/databases/{name}/stop": { | |
| "put": { | |
| "tags": [ | |
| "database" | |
| ], | |
| "operationId": "stopDatabase", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ] | |
| } | |
| }, | |
| "/esbapi/packages/{packageName}/endpoints/{name}/disable": { | |
| "put": { | |
| "tags": [ | |
| "endpoint" | |
| ], | |
| "operationId": "disableEndpoint", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "packageName", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "name", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ] | |
| } | |
| }, | |
| "/esbapi/databases/{name}/functions/{functionName}/columns": { | |
| "get": { | |
| "tags": [ | |
| "database" | |
| ], | |
| "operationId": "getDatabaseFunctionColumns", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "functionName", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "catalogName", | |
| "in": "query", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "schemaPattern", | |
| "in": "query", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "columnNamePattern", | |
| "in": "query", | |
| "required": false, | |
| "type": "string" | |
| } | |
| ] | |
| } | |
| }, | |
| "/esbapi/broker/destinations": { | |
| "get": { | |
| "tags": [ | |
| "broker" | |
| ], | |
| "operationId": "getDestinations", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "description": "Match names containing", | |
| "required": false | |
| }, | |
| { | |
| "name": "type", | |
| "in": "query", | |
| "description": "Type matching", | |
| "required": false, | |
| "enum": [ | |
| "topic", | |
| "queue" | |
| ] | |
| }, | |
| { | |
| "name": "page", | |
| "in": "query", | |
| "description": "Page to query", | |
| "required": false, | |
| "type": "integer", | |
| "default": 0 | |
| }, | |
| { | |
| "name": "size", | |
| "in": "query", | |
| "description": "Size of result set", | |
| "required": false, | |
| "type": "integer", | |
| "default": 20 | |
| } | |
| ] | |
| } | |
| }, | |
| "/esbapi/file-system/ls": { | |
| "get": { | |
| "tags": [ | |
| "file-system" | |
| ], | |
| "operationId": "ls", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "cwd", | |
| "in": "query", | |
| "required": false, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "dirOnly", | |
| "in": "query", | |
| "required": false, | |
| "type": "boolean" | |
| }, | |
| { | |
| "name": "includeHidden", | |
| "in": "query", | |
| "required": false, | |
| "type": "boolean" | |
| } | |
| ] | |
| } | |
| }, | |
| "/esbapi/packages/{name}/stop": { | |
| "put": { | |
| "tags": [ | |
| "package" | |
| ], | |
| "operationId": "stopPackage", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ] | |
| } | |
| }, | |
| "/esbapi/tracker/document-types": { | |
| "get": { | |
| "tags": [ | |
| "tracker" | |
| ], | |
| "operationId": "getDocumentTypes", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [] | |
| } | |
| }, | |
| "/esbapi/marketplace/items": { | |
| "get": { | |
| "tags": [ | |
| "marketplace" | |
| ], | |
| "operationId": "getMarketItems", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "page", | |
| "in": "query", | |
| "description": "Page to query", | |
| "required": false, | |
| "type": "integer", | |
| "default": 0 | |
| }, | |
| { | |
| "name": "size", | |
| "in": "query", | |
| "description": "Size of result set", | |
| "required": false, | |
| "type": "integer", | |
| "default": 20 | |
| } | |
| ] | |
| } | |
| }, | |
| "/esbapi/system/shutdown": { | |
| "put": { | |
| "tags": [ | |
| "system" | |
| ], | |
| "operationId": "shutdown", | |
| "produces": [ | |
| "application/json", | |
| "application/xml" | |
| ], | |
| "parameters": [] | |
| } | |
| } | |
| }, | |
| "securityDefinitions": { | |
| "api_key": { | |
| "type": "apiKey", | |
| "name": "api_key", | |
| "in": "header" | |
| } | |
| }, | |
| "definitions": { | |
| "APILogMessage": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "TRACE", | |
| "DEBUG", | |
| "INFO", | |
| "WARN", | |
| "ERROR" | |
| ] | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "ServiceInvoke": { | |
| "type": "object", | |
| "required": [ | |
| "apiGroup", | |
| "endpointName", | |
| "endpointType", | |
| "id", | |
| "location", | |
| "packageName", | |
| "responseTime", | |
| "ruleId", | |
| "serviceName", | |
| "success", | |
| "timeReceived", | |
| "trackerId", | |
| "url", | |
| "user" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "description": "Record ID" | |
| }, | |
| "ruleId": { | |
| "type": "integer", | |
| "format": "int64", | |
| "description": "Matching Rule ID" | |
| }, | |
| "timeReceived": { | |
| "type": "string", | |
| "format": "date-time", | |
| "description": "Time Received (Service Invoke Time)" | |
| }, | |
| "trackerId": { | |
| "type": "string", | |
| "description": "Tracker Document ID" | |
| }, | |
| "packageName": { | |
| "type": "string", | |
| "description": "ESB Package Name" | |
| }, | |
| "endpointName": { | |
| "type": "string", | |
| "description": "Endpoint name" | |
| }, | |
| "endpointType": { | |
| "type": "string", | |
| "description": "Endpoint type" | |
| }, | |
| "apiGroup": { | |
| "type": "string", | |
| "description": "API Group" | |
| }, | |
| "serviceName": { | |
| "type": "string", | |
| "description": "Service Name" | |
| }, | |
| "url": { | |
| "type": "string", | |
| "description": "URL" | |
| }, | |
| "user": { | |
| "type": "string", | |
| "description": "User Name" | |
| }, | |
| "success": { | |
| "type": "boolean", | |
| "description": "Success" | |
| }, | |
| "cost": { | |
| "type": "number", | |
| "format": "double", | |
| "description": "Invoke Cost" | |
| }, | |
| "responseTime": { | |
| "type": "integer", | |
| "format": "int64", | |
| "description": "Response Time" | |
| }, | |
| "location": { | |
| "type": "string", | |
| "description": "Location (co-ordinates) of originating request" | |
| }, | |
| "doubleProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "number", | |
| "format": "double" | |
| } | |
| }, | |
| "stringProperties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "CallableAPIResponse": { | |
| "type": "object" | |
| }, | |
| "APIResponse": { | |
| "type": "object", | |
| "properties": { | |
| "result": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "payload": { | |
| "type": "object" | |
| }, | |
| "warnings": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/APILogMessage" | |
| } | |
| } | |
| } | |
| }, | |
| "MonitorBill": { | |
| "type": "object", | |
| "required": [ | |
| "cost", | |
| "endDate", | |
| "serviceInvokes", | |
| "start", | |
| "startDate", | |
| "totalServiceInvokes" | |
| ], | |
| "properties": { | |
| "startDate": { | |
| "type": "string", | |
| "format": "date-time", | |
| "description": "Start Date" | |
| }, | |
| "endDate": { | |
| "type": "string", | |
| "format": "date-time", | |
| "description": "End Date" | |
| }, | |
| "serviceInvokes": { | |
| "type": "array", | |
| "description": "Service Invokes", | |
| "items": { | |
| "$ref": "#/definitions/ServiceInvoke" | |
| } | |
| }, | |
| "cost": { | |
| "type": "number", | |
| "format": "double", | |
| "description": "Total Cost" | |
| }, | |
| "totalServiceInvokes": { | |
| "type": "integer", | |
| "format": "int64", | |
| "description": "Total number of service invokes for given time period" | |
| }, | |
| "start": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "The offset" | |
| } | |
| } | |
| }, | |
| "Callable": { | |
| "type": "object" | |
| }, | |
| "EndpointModel": { | |
| "type": "object", | |
| "required": [ | |
| "endpointName", | |
| "endpointType", | |
| "packageName" | |
| ], | |
| "properties": { | |
| "packageName": { | |
| "type": "string", | |
| "minLength": 1, | |
| "maxLength": 50 | |
| }, | |
| "endpointName": { | |
| "type": "string", | |
| "minLength": 1, | |
| "maxLength": 50, | |
| "pattern": "^[A-Za-z0-9]*$" | |
| }, | |
| "originalEndpointName": { | |
| "type": "string", | |
| "minLength": 0, | |
| "maxLength": 50 | |
| }, | |
| "endpointType": { | |
| "type": "string", | |
| "minLength": 1, | |
| "maxLength": 50 | |
| }, | |
| "properties": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| }, | |
| "file": { | |
| "$ref": "#/definitions/MultipartFile" | |
| }, | |
| "serviceName": { | |
| "type": "string" | |
| }, | |
| "start": { | |
| "type": "boolean" | |
| }, | |
| "updating": { | |
| "type": "boolean" | |
| } | |
| } | |
| }, | |
| "Matcher": { | |
| "type": "object", | |
| "properties": { | |
| "groups": { | |
| "type": "array", | |
| "readOnly": true, | |
| "uniqueItems": true, | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "packages": { | |
| "type": "array", | |
| "readOnly": true, | |
| "uniqueItems": true, | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "user_filter": { | |
| "type": "string", | |
| "readOnly": true, | |
| "enum": [ | |
| "EVERYONE", | |
| "ANONYMOUS", | |
| "INTEGRATE_USERS" | |
| ] | |
| }, | |
| "users": { | |
| "type": "array", | |
| "readOnly": true, | |
| "uniqueItems": true, | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "services": { | |
| "type": "array", | |
| "readOnly": true, | |
| "uniqueItems": true, | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "url_patterns": { | |
| "type": "array", | |
| "readOnly": true, | |
| "uniqueItems": true, | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "InputStream": { | |
| "type": "object" | |
| }, | |
| "MultipartFile": { | |
| "type": "object", | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| }, | |
| "empty": { | |
| "type": "boolean" | |
| }, | |
| "bytes": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "format": "byte" | |
| } | |
| }, | |
| "size": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "inputStream": { | |
| "$ref": "#/definitions/InputStream" | |
| }, | |
| "contentType": { | |
| "type": "string" | |
| }, | |
| "originalFilename": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "Employee": { | |
| "type": "object", | |
| "required": [ | |
| "department", | |
| "name", | |
| "position" | |
| ], | |
| "properties": { | |
| "id": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "Employee ID" | |
| }, | |
| "name": { | |
| "type": "string", | |
| "example": "Daren Klamer", | |
| "description": "Employee name", | |
| "minLength": 1, | |
| "maxLength": 50 | |
| }, | |
| "position": { | |
| "type": "string", | |
| "example": "Manager", | |
| "description": "Employee position", | |
| "minLength": 1, | |
| "maxLength": 50 | |
| }, | |
| "department": { | |
| "type": "string", | |
| "example": "I.T, TORO", | |
| "description": "Employee department", | |
| "minLength": 1, | |
| "maxLength": 50 | |
| } | |
| } | |
| }, | |
| "ModelAndViewContainer": { | |
| "type": "object", | |
| "properties": { | |
| "view": { | |
| "type": "object" | |
| }, | |
| "defaultModel": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| }, | |
| "status": { | |
| "type": "string", | |
| "enum": [ | |
| "CONTINUE", | |
| "SWITCHING_PROTOCOLS", | |
| "PROCESSING", | |
| "CHECKPOINT", | |
| "OK", | |
| "CREATED", | |
| "ACCEPTED", | |
| "NON_AUTHORITATIVE_INFORMATION", | |
| "NO_CONTENT", | |
| "RESET_CONTENT", | |
| "PARTIAL_CONTENT", | |
| "MULTI_STATUS", | |
| "ALREADY_REPORTED", | |
| "IM_USED", | |
| "MULTIPLE_CHOICES", | |
| "MOVED_PERMANENTLY", | |
| "FOUND", | |
| "MOVED_TEMPORARILY", | |
| "SEE_OTHER", | |
| "NOT_MODIFIED", | |
| "USE_PROXY", | |
| "TEMPORARY_REDIRECT", | |
| "PERMANENT_REDIRECT", | |
| "BAD_REQUEST", | |
| "UNAUTHORIZED", | |
| "PAYMENT_REQUIRED", | |
| "FORBIDDEN", | |
| "NOT_FOUND", | |
| "METHOD_NOT_ALLOWED", | |
| "NOT_ACCEPTABLE", | |
| "PROXY_AUTHENTICATION_REQUIRED", | |
| "REQUEST_TIMEOUT", | |
| "CONFLICT", | |
| "GONE", | |
| "LENGTH_REQUIRED", | |
| "PRECONDITION_FAILED", | |
| "PAYLOAD_TOO_LARGE", | |
| "REQUEST_ENTITY_TOO_LARGE", | |
| "URI_TOO_LONG", | |
| "REQUEST_URI_TOO_LONG", | |
| "UNSUPPORTED_MEDIA_TYPE", | |
| "REQUESTED_RANGE_NOT_SATISFIABLE", | |
| "EXPECTATION_FAILED", | |
| "I_AM_A_TEAPOT", | |
| "INSUFFICIENT_SPACE_ON_RESOURCE", | |
| "METHOD_FAILURE", | |
| "DESTINATION_LOCKED", | |
| "UNPROCESSABLE_ENTITY", | |
| "LOCKED", | |
| "FAILED_DEPENDENCY", | |
| "UPGRADE_REQUIRED", | |
| "PRECONDITION_REQUIRED", | |
| "TOO_MANY_REQUESTS", | |
| "REQUEST_HEADER_FIELDS_TOO_LARGE", | |
| "UNAVAILABLE_FOR_LEGAL_REASONS", | |
| "INTERNAL_SERVER_ERROR", | |
| "NOT_IMPLEMENTED", | |
| "BAD_GATEWAY", | |
| "SERVICE_UNAVAILABLE", | |
| "GATEWAY_TIMEOUT", | |
| "HTTP_VERSION_NOT_SUPPORTED", | |
| "VARIANT_ALSO_NEGOTIATES", | |
| "INSUFFICIENT_STORAGE", | |
| "LOOP_DETECTED", | |
| "BANDWIDTH_LIMIT_EXCEEDED", | |
| "NOT_EXTENDED", | |
| "NETWORK_AUTHENTICATION_REQUIRED" | |
| ] | |
| }, | |
| "sessionStatus": { | |
| "$ref": "#/definitions/SessionStatus" | |
| }, | |
| "requestHandled": { | |
| "type": "boolean" | |
| }, | |
| "viewName": { | |
| "type": "string" | |
| }, | |
| "viewReference": { | |
| "type": "boolean" | |
| }, | |
| "model": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "ESBPackage Model": { | |
| "type": "object", | |
| "required": [ | |
| "marketplaceId", | |
| "name", | |
| "startOnCreate", | |
| "version" | |
| ], | |
| "properties": { | |
| "name": { | |
| "type": "string", | |
| "description": "Package Name", | |
| "minLength": 1, | |
| "maxLength": 50 | |
| }, | |
| "marketplaceId": { | |
| "type": "string", | |
| "description": "Marketplace ID", | |
| "minLength": 1, | |
| "maxLength": 255 | |
| }, | |
| "version": { | |
| "type": "string", | |
| "description": "Package Version", | |
| "minLength": 1, | |
| "maxLength": 255 | |
| }, | |
| "startOnCreate": { | |
| "type": "boolean", | |
| "description": "Start package on create", | |
| "enum": [ | |
| true, | |
| false | |
| ] | |
| } | |
| }, | |
| "xml": { | |
| "name": "ESBPackage" | |
| } | |
| }, | |
| "SessionStatus": { | |
| "type": "object", | |
| "properties": { | |
| "complete": { | |
| "type": "boolean" | |
| } | |
| } | |
| }, | |
| "Payload": { | |
| "type": "object", | |
| "properties": { | |
| "groups": { | |
| "type": "array", | |
| "readOnly": true, | |
| "uniqueItems": true, | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "displayName": { | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "id": { | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "enabled": { | |
| "type": "boolean", | |
| "readOnly": true | |
| }, | |
| "password": { | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "username": { | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "emailAddress": { | |
| "type": "string", | |
| "readOnly": true | |
| } | |
| } | |
| }, | |
| "Limit": { | |
| "type": "object", | |
| "properties": { | |
| "per_month": { | |
| "type": "integer", | |
| "format": "int32", | |
| "readOnly": true | |
| }, | |
| "per_week": { | |
| "type": "integer", | |
| "format": "int32", | |
| "readOnly": true | |
| }, | |
| "per_day": { | |
| "type": "integer", | |
| "format": "int32", | |
| "readOnly": true | |
| }, | |
| "per_hour": { | |
| "type": "integer", | |
| "format": "int32", | |
| "readOnly": true | |
| }, | |
| "date_type": { | |
| "type": "string", | |
| "readOnly": true, | |
| "enum": [ | |
| "CALENDAR", | |
| "ROLLING" | |
| ] | |
| }, | |
| "per_minute": { | |
| "type": "integer", | |
| "format": "int32", | |
| "readOnly": true | |
| } | |
| } | |
| }, | |
| "Rule": { | |
| "type": "object", | |
| "properties": { | |
| "name": { | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "priority": { | |
| "type": "integer", | |
| "format": "int32", | |
| "readOnly": true | |
| }, | |
| "limit": { | |
| "readOnly": true, | |
| "$ref": "#/definitions/Limit" | |
| }, | |
| "matcher": { | |
| "readOnly": true, | |
| "$ref": "#/definitions/Matcher" | |
| }, | |
| "id": { | |
| "type": "integer", | |
| "format": "int64", | |
| "readOnly": true | |
| }, | |
| "invocable_service": { | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "enabled": { | |
| "type": "boolean", | |
| "readOnly": true | |
| }, | |
| "description": { | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "cost": { | |
| "type": "number", | |
| "readOnly": true | |
| } | |
| } | |
| }, | |
| "jdbc-connection-info": { | |
| "type": "object", | |
| "required": [ | |
| "acquireIncrement", | |
| "driverClass", | |
| "idleConnectionTestPeriodInMinutes", | |
| "idleMaxAgeInMinutes", | |
| "maxConnectionsPerPartition", | |
| "minConnectionsPerPartition", | |
| "name", | |
| "partitionCount", | |
| "password", | |
| "statementsCacheSize", | |
| "url", | |
| "userName" | |
| ], | |
| "properties": { | |
| "name": { | |
| "type": "string", | |
| "description": "Database name", | |
| "minLength": 1, | |
| "maxLength": 30, | |
| "pattern": "^[A-Za-z0-9_]*$" | |
| }, | |
| "enabled": { | |
| "type": "boolean", | |
| "description": "Enabled" | |
| }, | |
| "xa": { | |
| "type": "boolean", | |
| "description": "XA", | |
| "default": false | |
| }, | |
| "driverClass": { | |
| "type": "string", | |
| "description": "Driver class", | |
| "minLength": 1, | |
| "maxLength": 2147483647 | |
| }, | |
| "url": { | |
| "type": "string", | |
| "description": "Driver Url", | |
| "minLength": 1, | |
| "maxLength": 255 | |
| }, | |
| "userName": { | |
| "type": "string", | |
| "description": "username", | |
| "minLength": 1, | |
| "maxLength": 20 | |
| }, | |
| "password": { | |
| "type": "string", | |
| "description": "password" | |
| }, | |
| "idleConnectionTestPeriodInMinutes": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "idle-connection-period", | |
| "minimum": 1, | |
| "maximum": 100 | |
| }, | |
| "idleMaxAgeInMinutes": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "idle-max-age", | |
| "minimum": 1, | |
| "maximum": 30 | |
| }, | |
| "maxConnectionsPerPartition": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "max-partition-connections", | |
| "minimum": 1, | |
| "maximum": 10 | |
| }, | |
| "minConnectionsPerPartition": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "min-partition-connections", | |
| "minimum": 1, | |
| "maximum": 100 | |
| }, | |
| "partitionCount": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "partition-count", | |
| "minimum": 1, | |
| "maximum": 5 | |
| }, | |
| "acquireIncrement": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "acquire-increment", | |
| "minimum": 1, | |
| "maximum": 5 | |
| }, | |
| "statementsCacheSize": { | |
| "type": "integer", | |
| "format": "int32", | |
| "description": "statement-cache-size", | |
| "minimum": 1, | |
| "maximum": 1000 | |
| }, | |
| "startupError": { | |
| "type": "string", | |
| "readOnly": true, | |
| "minLength": 0, | |
| "maxLength": 3000 | |
| }, | |
| "databaseProductName": { | |
| "type": "string", | |
| "readOnly": true, | |
| "minLength": 0, | |
| "maxLength": 100 | |
| }, | |
| "databaseProductVersion": { | |
| "type": "string", | |
| "readOnly": true, | |
| "minLength": 0, | |
| "maxLength": 100 | |
| }, | |
| "databaseMajorVersion": { | |
| "type": "integer", | |
| "format": "int32", | |
| "readOnly": true | |
| }, | |
| "databaseMinorVersion": { | |
| "type": "integer", | |
| "format": "int32", | |
| "readOnly": true | |
| }, | |
| "driverName": { | |
| "type": "string", | |
| "readOnly": true, | |
| "minLength": 0, | |
| "maxLength": 100 | |
| }, | |
| "driverVersion": { | |
| "type": "string", | |
| "readOnly": true, | |
| "minLength": 0, | |
| "maxLength": 100 | |
| }, | |
| "driverMajorVersion": { | |
| "type": "integer", | |
| "format": "int32", | |
| "readOnly": true | |
| }, | |
| "driverMinorVersion": { | |
| "type": "integer", | |
| "format": "int32", | |
| "readOnly": true | |
| }, | |
| "home": { | |
| "type": "string" | |
| }, | |
| "updating": { | |
| "type": "boolean" | |
| } | |
| } | |
| }, | |
| "PasswordChangePayload": { | |
| "type": "object", | |
| "properties": { | |
| "new": { | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "old": { | |
| "type": "string", | |
| "readOnly": true | |
| } | |
| } | |
| } | |
| } | |
| } |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment