diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/architecture.rst | 10 | ||||
| -rw-r--r-- | docs/authentication.rst | 27 | ||||
| -rw-r--r-- | docs/configuration.rst | 27 | ||||
| -rwxr-xr-x | docs/index.rst | 12 | ||||
| -rw-r--r-- | docs/installation.rst | 20 | ||||
| -rw-r--r-- | docs/logging.rst | 13 | ||||
| -rw-r--r-- | docs/release-notes.rst | 53 | ||||
| -rw-r--r-- | docs/setup.rst | 8 | ||||
| -rw-r--r-- | docs/single.rst | 2 | ||||
| -rw-r--r-- | docs/swagger.json | 2118 |
10 files changed, 85 insertions, 2205 deletions
diff --git a/docs/architecture.rst b/docs/architecture.rst index ae29f9e0..8daa0d3b 100644 --- a/docs/architecture.rst +++ b/docs/architecture.rst @@ -4,7 +4,15 @@ Architecture ============ -` See ONAP Wiki <https://wiki.onap.org/display/DW/MUSIC-Multi-site+State+Coordination+Service>`_ +.. note:: + * This section is used to describe a software component from a high level + view of capability, common usage scenarios, and interactions with other + components required in the usage scenarios. + + * The architecture section is typically: provided in a platform-component + and sdk collections; and referenced from developer and user guides. + + * This note must be removed after content has been added. Capabilities diff --git a/docs/authentication.rst b/docs/authentication.rst index 87dbea05..3c6f48a4 100644 --- a/docs/authentication.rst +++ b/docs/authentication.rst @@ -1,25 +1,22 @@ -Authentication -============== + `For Single install:`_ -`Single-Site Install`_ + `Multi-Site Install:`_ -`Multi-Site Install`_ + `Headers:`_ -`Headers`_ + `AAF Authentication`_ -`AAF Authentication`_ - -`AID Authentication Non-AAF`_ + `AID Authentication Non-AAF`_ `Onboarding API`_ - `Add Application`_ +`Add Application`_ - `Get Application`_ +`Get Application`_ - `Edit Application`_ +`Edit Application`_ - `Delete Application`_ +`Delete Application`_ Steps to test AAF MUSIC has been enhanced to support applications which are already authenticated using AAF and applications which are not authenticated using AAF. @@ -36,7 +33,7 @@ In the cassandra bin dir run ./cqlsh and log in to db then: If you want to save the following in a file you can then run ./cqlsh -f <file.cql> -Single-Site Install +For Single install: ^^^^^^^^^^^^^^^^^^^ :: @@ -61,7 +58,7 @@ Single-Site Install ); -Multi-Site Install +Multi-Site Install: ^^^^^^^^^^^^^^^^^^^ :: @@ -86,7 +83,7 @@ Multi-Site Install PRIMARY KEY (uuid) ); -Headers +Headers: ^^^^^^^^ For AAF applications all the 3 headers ns, userId and password are mandatory. diff --git a/docs/configuration.rst b/docs/configuration.rst index 279e5bd6..085f9c66 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -4,25 +4,24 @@ Configuration ============= -See the following pages for Configuration Information: +.. note:: + * This section is used to describe the options a software component offers for configuration. -.. toctree:: - :maxdepth: 1 + * Configuration is typically: provided for platform-component and sdk projects; + and referenced in developer and user guides. + + * This note must be removed after content has been added. - Single-Site Install <single> - Multi-Site Install <multi> - Authentication <authentication> +Example ... -.. Example ... +You can provide the following in ``basic.conf`` -.. You can provide the following in ``basic.conf`` +``host=ADDRESS`` + The address of the host -.. ``host=ADDRESS`` -.. The address of the host +``port=PORT`` + The port used for signaling -.. ``port=PORT`` -.. The port used for signaling - -.. Optional. Default: ``8080`` + Optional. Default: ``8080`` diff --git a/docs/index.rst b/docs/index.rst index 437a50d8..3ef97755 100755 --- a/docs/index.rst +++ b/docs/index.rst @@ -8,17 +8,17 @@ Music Developer Documentation .. toctree:: :maxdepth: 1 - installation + Single-SIte Install <single> + Muili-Site Install <multi> setup release-notes - architecture - logging - configuration - + .. architecture +.. configuration .. consumedapis .. delivery .. index -.. +.. installation +.. logging .. offeredapis diff --git a/docs/installation.rst b/docs/installation.rst index 1b817114..be64a63b 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -4,17 +4,17 @@ Installation ============ +.. note:: + * This section is used to describe how a software component is acquired and installed. + + * This section is typically: provided for a platform-component and application; and + referenced in user guides. -.. toctree:: - :maxdepth: 1 + * This note must be removed after content has been added. - Single-Site Install <single> - Multi-Site Install <multi> +Environment +----------- -.. Environment -.. ----------- - - -.. Steps -.. ----- +Steps +----- diff --git a/docs/logging.rst b/docs/logging.rst index b1d3a186..39eabfba 100644 --- a/docs/logging.rst +++ b/docs/logging.rst @@ -4,8 +4,14 @@ Logging ======= -Log file produced will be in /opt/app/music/logs/MUSIC/music.log,error.log,debug.log -Log files are in EELF format. +.. note:: + * This section is used to describe the informational or diagnostic messages emitted from + a software component and the methods or collecting them. + + * This section is typically: provided for a platform-component and sdk; and + referenced in developer and user guides + + * This note must be removed after content has been added. Where to Access Information @@ -14,6 +20,3 @@ Where to Access Information Error / Warning Messages ------------------------ - - - diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 766fb123..9b6688c3 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -4,58 +4,47 @@ Release Notes ============= -Initial Release for Beijing -Version: 2.5.4 --------------- - -:Release Date: 2018-06-07 - -**New Features** +.. note:: + * This Release Notes must be updated each time the team decides to Release new artifacts. + * The scope of this Release Notes is for this particular component. In other words, each ONAP component has its Release Notes. + * This Release Notes is cumulative, the most recently Released artifact is made visible in the top of this Release Notes. + * Except the date and the version number, all the other sections are optional but there must be at least one section describing the purpose of this new release. + * This note must be removed after content has been added. -MUSIC provides a service with recipes that individual ONAP components and microservice can use for - - state replication across multiple geo-distributed sites - - flexible fine-grained consistency management of state - - policy driven state-ownership across replicas of the service +Version: x.y.z +-------------- -**Bug Fixes** - - `MUSIC-33 <https://jira.onap.org/projects/MUSIC/issues/MUSIC-33>`_ CriticalPut is causing HTTP Status 500 – Internal Server Error +:Release Date: yyyy-mm-dd - - `MUSIC-34 <https://jira.onap.org/projects/MUSIC/issues/MUSIC-34>`_ CreateTable,InsertIntoTable,UpdateTable,DeleteFromTable,DropTable don't check resource existence - - `MUSIC-35 <https://jira.onap.org/projects/MUSIC/issues/MUSIC-35>`_ Onboarding issues - - `MUSIC-36 <https://jira.onap.org/projects/MUSIC/issues/MUSIC-36>`_ Test Case failing +**New Features** - - `MUSIC-37 <https://jira.onap.org/projects/MUSIC/issues/MUSIC-37>`_ Acquire lock to return more information +One or two sentences explaining the purpose of this Release. +**Bug Fixes** + - `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and a sentence explaining what this defect is addressing. **Known Issues** -N/A - -**Security Notes** - -MUSIC code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The MUSIC open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=25439359>`_. + - `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and two, three sentences. + One sentences explaining what is the issue. + + Another sentence explaining the impact of the issue. + + And an optional sentence providing a workaround. -Quick Links: +**Security Issues** + You may want to include a reference to CVE (Common Vulnerabilities and Exposures) `CVE <https://cve.mitre.org>`_ -- `MUSIC project page <https://wiki.onap.org/display/DW/MUSIC+Project>`_ -- `Passing Badge information for MUSIC <https://bestpractices.coreinfrastructure.org/en/projects/1722>`_ -- `Project Vulnerability Review Table for MUSIC <https://wiki.onap.org/pages/viewpage.action?pageId=25439359>`_ **Upgrade Notes** - N/A - **Deprecation Notes** - N/A - **Other** - N/A - =========== End of Release Notes diff --git a/docs/setup.rst b/docs/setup.rst index b12acd04..208c779b 100644 --- a/docs/setup.rst +++ b/docs/setup.rst @@ -5,8 +5,8 @@ Setup for Developing MUSIC :maxdepth: 1 Single-Site Install <single> - Multi-Site Install <multi> - Authentication <authentication> + Muili-Site Install <multi> + Authentication MUSIC is to be installed in a single Dir on a vm. @@ -46,5 +46,5 @@ Continue by selecting the link to the setup you are doing. :maxdepth: 1 Single-Site Install <single> - Multi-Site Install <multi> - Authentication <authentication> + Muili-Site Install <multi> + Authentication diff --git a/docs/single.rst b/docs/single.rst index 060f02b4..08c5e315 100644 --- a/docs/single.rst +++ b/docs/single.rst @@ -15,7 +15,7 @@ Instructions - Ensure you have OpenJDK 8 on your machine. - Download Apache Cassandra 3.0, install into /opt/app/music and follow these instructions http://cassandra.apache.org/doc/latest/getting_started/installing.html till and including Step - By the end of this you should have Cassandra working. -- Download Apache Zookeeper 3.4.6, install into /opt/app/music and follow these instructions https://zookeeper.apache.org/doc/r3.4.6/zookeeperStarted.html pertaining to the standalone operation. By the end of this you should have Zookeeper working. +- Download Apache Zookeeper 3.4.6, install into /opt/app/music and follow these instructions https://zookeeper.apache.org/doc/trunk/zookeeperStarted.html pertaining to the standalone operation. By the end of this you should have Zookeeper working. - Download the Version 8.5 Apache Tomcat and install it using these instructions https://tomcat.apache.org/download-80.cgi (this is for version 8.5). - Create a music.properties file and place it in /opt/app/music/etc/. Here is a sample of the file: diff --git a/docs/swagger.json b/docs/swagger.json index 27db769f..c352537b 100644 --- a/docs/swagger.json +++ b/docs/swagger.json @@ -1,2117 +1 @@ -{ - "swagger": "2.0", - "info": { - "version": "1.0.0", - "title": "" - }, - "host": "localhost:8080", - "basePath": "/MUSIC/rest", - "tags": [ - { - "name": "Data Api" - }, - { - "name": "Healthcheck Api" - }, - { - "name": "Lock Api" - }, - { - "name": "Q Api" - }, - { - "name": "Test Api" - }, - { - "name": "Version Api" - } - ], - "schemes": [ - "http" - ], - "paths": { - "/v2/keyspaces/{keyspace}/tables/{tablename}/rows": { - "get": { - "tags": [ - "Data Api" - ], - "summary": "Select All or Select Specific", - "description": "", - "operationId": "select", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "version", - "in": "path", - "description": "Major Version", - "required": true, - "type": "string" - }, - { - "name": "X-minorVersion", - "in": "header", - "description": "Minor Version", - "required": false, - "type": "string" - }, - { - "name": "X-patchVersion", - "in": "header", - "description": "Patch Version", - "required": false, - "type": "string" - }, - { - "name": "aid", - "in": "header", - "description": "AID", - "required": true, - "type": "string" - }, - { - "name": "ns", - "in": "header", - "description": "Application namespace", - "required": true, - "type": "string" - }, - { - "name": "Authorization", - "in": "header", - "description": "Authorization", - "required": true, - "type": "string" - }, - { - "name": "keyspace", - "in": "path", - "description": "Keyspace Name", - "required": true, - "type": "string" - }, - { - "name": "tablename", - "in": "path", - "description": "Table Name", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "type": "object", - "additionalProperties": { - "type": "object" - } - } - } - } - }, - "post": { - "tags": [ - "Data Api" - ], - "summary": "Insert Into Table", - "description": "", - "operationId": "insertIntoTable", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "version", - "in": "path", - "description": "Major Version", - "required": true, - "type": "string" - }, - { - "name": "X-minorVersion", - "in": "header", - "description": "Minor Version", - "required": false, - "type": "string" - }, - { - "name": "X-patchVersion", - "in": "header", - "description": "Patch Version", - "required": false, - "type": "string" - }, - { - "name": "aid", - "in": "header", - "description": "AID", - "required": true, - "type": "string" - }, - { - "name": "ns", - "in": "header", - "description": "Application namespace", - "required": true, - "type": "string" - }, - { - "name": "Authorization", - "in": "header", - "description": "Authorization", - "required": true, - "type": "string" - }, - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/JsonTable" - } - }, - { - "name": "keyspace", - "in": "path", - "description": "Keyspace Name", - "required": true, - "type": "string" - }, - { - "name": "tablename", - "in": "path", - "description": "Table Name", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "type": "string" - } - } - } - }, - "put": { - "tags": [ - "Data Api" - ], - "summary": "Update Table", - "description": "", - "operationId": "updateTable", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "version", - "in": "path", - "description": "Major Version", - "required": true, - "type": "string" - }, - { - "name": "X-minorVersion", - "in": "header", - "description": "Minor Version", - "required": false, - "type": "string" - }, - { - "name": "X-patchVersion", - "in": "header", - "description": "Patch Version", - "required": false, - "type": "string" - }, - { - "name": "aid", - "in": "header", - "description": "AID", - "required": true, - "type": "string" - }, - { - "name": "ns", - "in": "header", - "description": "Application namespace", - "required": true, - "type": "string" - }, - { - "name": "Authorization", - "in": "header", - "description": "Authorization", - "required": true, - "type": "string" - }, - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/JsonTable" - } - }, - { - "name": "keyspace", - "in": "path", - "description": "Keyspace Name", - "required": true, - "type": "string" - }, - { - "name": "tablename", - "in": "path", - "description": "Table Name", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "type": "string" - } - } - } - }, - "delete": { - "tags": [ - "Data Api" - ], - "summary": "Delete From table", - "description": "", - "operationId": "deleteFromTable", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "version", - "in": "path", - "description": "Major Version", - "required": true, - "type": "string" - }, - { - "name": "X-minorVersion", - "in": "header", - "description": "Minor Version", - "required": false, - "type": "string" - }, - { - "name": "X-patchVersion", - "in": "header", - "description": "Patch Version", - "required": false, - "type": "string" - }, - { - "name": "aid", - "in": "header", - "description": "AID", - "required": true, - "type": "string" - }, - { - "name": "ns", - "in": "header", - "description": "Application namespace", - "required": true, - "type": "string" - }, - { - "name": "Authorization", - "in": "header", - "description": "Authorization", - "required": true, - "type": "string" - }, - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/JsonTable" - } - }, - { - "name": "keyspace", - "in": "path", - "description": "Keyspace Name", - "required": true, - "type": "string" - }, - { - "name": "tablename", - "in": "path", - "description": "Table Name", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "type": "string" - } - } - } - } - }, - "/v2/keyspaces/{name}": { - "post": { - "tags": [ - "Data Api" - ], - "summary": "Create Keyspace", - "description": "", - "operationId": "createKeySpace", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "version", - "in": "path", - "description": "Major Version", - "required": true, - "type": "string" - }, - { - "name": "X-minorVersion", - "in": "header", - "description": "Minor Version", - "required": false, - "type": "string" - }, - { - "name": "X-patchVersion", - "in": "header", - "description": "Patch Version", - "required": false, - "type": "string" - }, - { - "name": "aid", - "in": "header", - "description": "AID", - "required": true, - "type": "string" - }, - { - "name": "Authorization", - "in": "header", - "description": "Authorization", - "required": true, - "type": "string" - }, - { - "name": "ns", - "in": "header", - "description": "Application namespace", - "required": true, - "type": "string" - }, - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/JsonTable" - } - }, - { - "name": "name", - "in": "path", - "description": "Keyspace Name", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "type": "string" - } - } - } - }, - "delete": { - "tags": [ - "Data Api" - ], - "summary": "Delete Keyspace", - "description": "", - "operationId": "dropKeySpace", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "version", - "in": "path", - "description": "Major Version", - "required": true, - "type": "string" - }, - { - "name": "X-minorVersion", - "in": "header", - "description": "Minor Version", - "required": false, - "type": "string" - }, - { - "name": "X-patchVersion", - "in": "header", - "description": "Patch Version", - "required": false, - "type": "string" - }, - { - "name": "aid", - "in": "header", - "description": "AID", - "required": true, - "type": "string" - }, - { - "name": "Authorization", - "in": "header", - "description": "Authorization", - "required": true, - "type": "string" - }, - { - "name": "ns", - "in": "header", - "description": "Application namespace", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Keyspace Name", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "type": "string" - } - } - } - } - }, - "/v2/keyspaces/{keyspace}/tables/{tablename}/index/{field}": { - "post": { - "tags": [ - "Data Api" - ], - "summary": "Create Index", - "description": "", - "operationId": "createIndex", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "version", - "in": "path", - "description": "Major Version", - "required": true, - "type": "string" - }, - { - "name": "X-minorVersion", - "in": "header", - "description": "Minor Version", - "required": false, - "type": "string" - }, - { - "name": "X-patchVersion", - "in": "header", - "description": "Patch Version", - "required": false, - "type": "string" - }, - { - "name": "aid", - "in": "header", - "description": "AID", - "required": true, - "type": "string" - }, - { - "name": "ns", - "in": "header", - "description": "Application namespace", - "required": true, - "type": "string" - }, - { - "name": "Authorization", - "in": "header", - "description": "Authorization", - "required": true, - "type": "string" - }, - { - "name": "keyspace", - "in": "path", - "description": "Keyspace Name", - "required": true, - "type": "string" - }, - { - "name": "tablename", - "in": "path", - "description": "Table Name", - "required": true, - "type": "string" - }, - { - "name": "field", - "in": "path", - "description": "Field Name", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "type": "string" - } - } - } - } - }, - "/v2/keyspaces/{keyspace}/tables/{tablename}/rows/criticalget": { - "put": { - "tags": [ - "Data Api" - ], - "summary": "Select Critical", - "description": "", - "operationId": "selectCritical", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "version", - "in": "path", - "description": "Major Version", - "required": true, - "type": "string" - }, - { - "name": "X-minorVersion", - "in": "header", - "description": "Minor Version", - "required": false, - "type": "string" - }, - { - "name": "X-patchVersion", - "in": "header", - "description": "Patch Version", - "required": false, - "type": "string" - }, - { - "name": "aid", - "in": "header", - "description": "AID", - "required": true, - "type": "string" - }, - { - "name": "ns", - "in": "header", - "description": "Application namespace", - "required": true, - "type": "string" - }, - { - "name": "Authorization", - "in": "header", - "description": "Authorization", - "required": true, - "type": "string" - }, - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/JsonTable" - } - }, - { - "name": "keyspace", - "in": "path", - "description": "Keyspace Name", - "required": true, - "type": "string" - }, - { - "name": "tablename", - "in": "path", - "description": "Table Name", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "type": "object", - "additionalProperties": { - "type": "object" - } - } - } - } - } - }, - "/v2/keyspaces/{keyspace}/tables/{tablename}": { - "post": { - "tags": [ - "Data Api" - ], - "summary": "Create Table", - "description": "", - "operationId": "createTable", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "version", - "in": "path", - "description": "Major Version", - "required": true, - "type": "string" - }, - { - "name": "X-minorVersion", - "in": "header", - "description": "Minor Version", - "required": false, - "type": "string" - }, - { - "name": "X-patchVersion", - "in": "header", - "description": "Patch Version", - "required": false, - "type": "string" - }, - { - "name": "aid", - "in": "header", - "description": "AID", - "required": true, - "type": "string" - }, - { - "name": "ns", - "in": "header", - "description": "Application namespace", - "required": true, - "type": "string" - }, - { - "name": "Authorization", - "in": "header", - "description": "Authorization", - "required": true, - "type": "string" - }, - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/JsonTable" - } - }, - { - "name": "keyspace", - "in": "path", - "description": "Keyspace Name", - "required": true, - "type": "string" - }, - { - "name": "tablename", - "in": "path", - "description": "Table Name", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "type": "string" - } - } - } - }, - "delete": { - "tags": [ - "Data Api" - ], - "summary": "Drop Table", - "description": "", - "operationId": "dropTable", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "version", - "in": "path", - "description": "Major Version", - "required": true, - "type": "string" - }, - { - "name": "X-minorVersion", - "in": "header", - "description": "Minor Version", - "required": false, - "type": "string" - }, - { - "name": "X-patchVersion", - "in": "header", - "description": "Patch Version", - "required": false, - "type": "string" - }, - { - "name": "aid", - "in": "header", - "description": "AID", - "required": true, - "type": "string" - }, - { - "name": "ns", - "in": "header", - "description": "Application namespace", - "required": true, - "type": "string" - }, - { - "name": "Authorization", - "in": "header", - "description": "Authorization", - "required": true, - "type": "string" - }, - { - "name": "keyspace", - "in": "path", - "description": "Keyspace Name", - "required": true, - "type": "string" - }, - { - "name": "tablename", - "in": "path", - "description": "Table Name", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "type": "string" - } - } - } - } - }, - "/v{version}/service/pingCassandra/{consistency}": { - "get": { - "tags": [ - "Healthcheck Api" - ], - "summary": "Get Health Status", - "description": "", - "operationId": "cassandraStatus", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "consistency", - "in": "path", - "description": "Consistency level", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "type": "object", - "additionalProperties": { - "type": "object" - } - } - } - } - } - }, - "/v{version}/service/pingZookeeper": { - "get": { - "tags": [ - "Healthcheck Api" - ], - "summary": "Get Health Status", - "description": "", - "operationId": "ZKStatus", - "produces": [ - "application/json" - ], - "parameters": [], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "type": "object", - "additionalProperties": { - "type": "object" - } - } - } - } - } - }, - "/v2/locks/create/{lockname}": { - "post": { - "tags": [ - "Lock Api" - ], - "summary": "Create Lock", - "description": "Puts the requesting process in the q for this lock. The corresponding node will be created in zookeeper if it did not already exist. Lock Name is the \"key\" of the form keyspaceName.tableName.rowId", - "operationId": "createLockReference", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "lockname", - "in": "path", - "description": "Lock Name", - "required": true, - "type": "string" - }, - { - "name": "X-minorVersion", - "in": "header", - "description": "Minor Version", - "required": false, - "type": "string" - }, - { - "name": "X-patchVersion", - "in": "header", - "description": "Patch Version", - "required": false, - "type": "string" - }, - { - "name": "Authorization", - "in": "header", - "description": "Authorization", - "required": true, - "type": "string" - }, - { - "name": "aid", - "in": "header", - "description": "AID", - "required": true, - "type": "string" - }, - { - "name": "ns", - "in": "header", - "description": "Application namespace", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "type": "object", - "additionalProperties": { - "type": "object" - } - } - } - } - } - }, - "/v2/locks/acquire/{lockreference}": { - "get": { - "tags": [ - "Lock Api" - ], - "summary": "Aquire Lock", - "description": "Checks if the node is in the top of the queue and hence acquires the lock", - "operationId": "accquireLock", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "lockreference", - "in": "path", - "description": "Lock Reference", - "required": true, - "type": "string" - }, - { - "name": "X-minorVersion", - "in": "header", - "description": "Minor Version", - "required": false, - "type": "string" - }, - { - "name": "X-patchVersion", - "in": "header", - "description": "Patch Version", - "required": false, - "type": "string" - }, - { - "name": "Authorization", - "in": "header", - "description": "Authorization", - "required": true, - "type": "string" - }, - { - "name": "aid", - "in": "header", - "description": "AID", - "required": true, - "type": "string" - }, - { - "name": "ns", - "in": "header", - "description": "Application namespace", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "type": "object", - "additionalProperties": { - "type": "object" - } - } - } - } - } - }, - "/v2/locks/acquire-with-lease/{lockreference}": { - "post": { - "tags": [ - "Lock Api" - ], - "summary": "Aquire Lock with Lease", - "description": "", - "operationId": "accquireLockWithLease", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/JsonTable" - } - }, - { - "name": "lockreference", - "in": "path", - "description": "Lock Reference", - "required": true, - "type": "string" - }, - { - "name": "X-minorVersion", - "in": "header", - "description": "Minor Version", - "required": false, - "type": "string" - }, - { - "name": "X-patchVersion", - "in": "header", - "description": "Patch Version", - "required": false, - "type": "string" - }, - { - "name": "Authorization", - "in": "header", - "description": "Authorization", - "required": true, - "type": "string" - }, - { - "name": "aid", - "in": "header", - "description": "AID", - "required": true, - "type": "string" - }, - { - "name": "ns", - "in": "header", - "description": "Application namespace", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "type": "object", - "additionalProperties": { - "type": "object" - } - } - } - } - } - }, - "/v2/locks/enquire/{lockname}": { - "get": { - "tags": [ - "Lock Api" - ], - "summary": "Get Lock Holder", - "description": "Gets the current Lock Holder", - "operationId": "currentLockHolder", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "lockname", - "in": "path", - "description": "Lock Name", - "required": true, - "type": "string" - }, - { - "name": "X-minorVersion", - "in": "header", - "description": "Minor Version", - "required": false, - "type": "string" - }, - { - "name": "X-patchVersion", - "in": "header", - "description": "Patch Version", - "required": false, - "type": "string" - }, - { - "name": "Authorization", - "in": "header", - "description": "Authorization", - "required": true, - "type": "string" - }, - { - "name": "aid", - "in": "header", - "description": "AID", - "required": true, - "type": "string" - }, - { - "name": "ns", - "in": "header", - "description": "Application namespace", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "type": "object", - "additionalProperties": { - "type": "object" - } - } - } - } - } - }, - "/v2/locks/{lockname}": { - "get": { - "tags": [ - "Lock Api" - ], - "summary": "Lock State", - "description": "Returns current Lock State and Holder.", - "operationId": "currentLockState", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "lockname", - "in": "path", - "description": "Lock Name", - "required": true, - "type": "string" - }, - { - "name": "X-minorVersion", - "in": "header", - "description": "Minor Version", - "required": false, - "type": "string" - }, - { - "name": "X-patchVersion", - "in": "header", - "description": "Patch Version", - "required": false, - "type": "string" - }, - { - "name": "Authorization", - "in": "header", - "description": "Authorization", - "required": true, - "type": "string" - }, - { - "name": "aid", - "in": "header", - "description": "AID", - "required": true, - "type": "string" - }, - { - "name": "ns", - "in": "header", - "description": "Application namespace", - "required": true, - "type": "string" - }, - { - "name": "userId", - "in": "header", - "description": "userId", - "required": true, - "type": "string" - }, - { - "name": "password", - "in": "header", - "description": "Password", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "type": "object", - "additionalProperties": { - "type": "object" - } - } - } - } - } - }, - "/v2/locks/release/{lockreference}": { - "delete": { - "tags": [ - "Lock Api" - ], - "summary": "Release Lock", - "description": "deletes the process from the zk queue", - "operationId": "unLock", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "lockreference", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "X-minorVersion", - "in": "header", - "description": "Minor Version", - "required": false, - "type": "string" - }, - { - "name": "X-patchVersion", - "in": "header", - "description": "Patch Version", - "required": false, - "type": "string" - }, - { - "name": "Authorization", - "in": "header", - "description": "Authorization", - "required": true, - "type": "string" - }, - { - "name": "aid", - "in": "header", - "description": "AID", - "required": true, - "type": "string" - }, - { - "name": "ns", - "in": "header", - "description": "Application namespace", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "type": "object", - "additionalProperties": { - "type": "object" - } - } - } - } - } - }, - "/v2/locks/delete/{lockname}": { - "delete": { - "tags": [ - "Lock Api" - ], - "summary": "Delete Lock", - "description": "", - "operationId": "deleteLock", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "lockname", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "X-minorVersion", - "in": "header", - "description": "Minor Version", - "required": false, - "type": "string" - }, - { - "name": "X-patchVersion", - "in": "header", - "description": "Patch Version", - "required": false, - "type": "string" - }, - { - "name": "aid", - "in": "header", - "description": "AID", - "required": true, - "type": "string" - }, - { - "name": "Authorization", - "in": "header", - "description": "Authorization", - "required": true, - "type": "string" - }, - { - "name": "ns", - "in": "header", - "description": "Application namespace", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "type": "object", - "additionalProperties": { - "type": "object" - } - } - } - } - } - }, - "/{version}/priorityq/keyspaces/{keyspace}/{qname}": { - "post": { - "tags": [ - "Q Api" - ], - "summary": "Create Q", - "description": "", - "operationId": "createQ", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "version", - "in": "path", - "description": "Major Version", - "required": true, - "type": "string" - }, - { - "name": "X-minorVersion", - "in": "header", - "description": "Minor Version", - "required": false, - "type": "string" - }, - { - "name": "X-patchVersion", - "in": "header", - "description": "Patch Version", - "required": false, - "type": "string" - }, - { - "name": "aid", - "in": "header", - "description": "AID", - "required": true, - "type": "string" - }, - { - "name": "ns", - "in": "header", - "description": "Application namespace", - "required": true, - "type": "string" - }, - { - "name": "Authorization", - "in": "header", - "description": "Authorization", - "required": true, - "type": "string" - }, - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/JsonTable" - } - }, - { - "name": "keyspace", - "in": "path", - "description": "Key Space", - "required": true, - "type": "string" - }, - { - "name": "qname", - "in": "path", - "description": "Table Name", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "type": "string" - } - } - } - }, - "delete": { - "tags": [ - "Q Api" - ], - "summary": "DropQ", - "description": "", - "operationId": "dropQ", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "version", - "in": "path", - "description": "Major Version", - "required": true, - "type": "string" - }, - { - "name": "X-minorVersion", - "in": "header", - "description": "Minor Version", - "required": false, - "type": "string" - }, - { - "name": "X-patchVersion", - "in": "header", - "description": "Patch Version", - "required": false, - "type": "string" - }, - { - "name": "aid", - "in": "header", - "description": "AID", - "required": true, - "type": "string" - }, - { - "name": "ns", - "in": "header", - "description": "Application namespace", - "required": true, - "type": "string" - }, - { - "name": "Authorization", - "in": "header", - "description": "Authorization", - "required": true, - "type": "string" - }, - { - "name": "keyspace", - "in": "path", - "description": "Key Space", - "required": true, - "type": "string" - }, - { - "name": "qname", - "in": "path", - "description": "Table Name", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "type": "string" - } - } - } - } - }, - "/{version}/priorityq/keyspaces/{keyspace}/{qname}/rows": { - "post": { - "tags": [ - "Q Api" - ], - "summary": "", - "description": "", - "operationId": "insertIntoQ", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "version", - "in": "path", - "description": "Major Version", - "required": true, - "type": "string" - }, - { - "name": "X-minorVersion", - "in": "header", - "description": "Minor Version", - "required": false, - "type": "string" - }, - { - "name": "X-patchVersion", - "in": "header", - "description": "Patch Version", - "required": false, - "type": "string" - }, - { - "name": "aid", - "in": "header", - "description": "AID", - "required": true, - "type": "string" - }, - { - "name": "ns", - "in": "header", - "description": "Application namespace", - "required": true, - "type": "string" - }, - { - "name": "Authorization", - "in": "header", - "description": "Authorization", - "required": true, - "type": "string" - }, - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/JsonTable" - } - }, - { - "name": "keyspace", - "in": "path", - "description": "Key Space", - "required": true, - "type": "string" - }, - { - "name": "qname", - "in": "path", - "description": "Table Name", - "required": true, - "type": "string" - } - ], - "responses": { - "default": { - "description": "successful operation" - } - } - }, - "put": { - "tags": [ - "Q Api" - ], - "summary": "updateQ", - "description": "", - "operationId": "updateQ", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "version", - "in": "path", - "description": "Major Version", - "required": true, - "type": "string" - }, - { - "name": "X-minorVersion", - "in": "header", - "description": "Minor Version", - "required": false, - "type": "string" - }, - { - "name": "X-patchVersion", - "in": "header", - "description": "Patch Version", - "required": false, - "type": "string" - }, - { - "name": "aid", - "in": "header", - "description": "AID", - "required": true, - "type": "string" - }, - { - "name": "ns", - "in": "header", - "description": "Application namespace", - "required": true, - "type": "string" - }, - { - "name": "Authorization", - "in": "header", - "description": "Authorization", - "required": true, - "type": "string" - }, - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/JsonTable" - } - }, - { - "name": "keyspace", - "in": "path", - "description": "Key Space", - "required": true, - "type": "string" - }, - { - "name": "qname", - "in": "path", - "description": "Table Name", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "type": "string" - } - } - } - }, - "delete": { - "tags": [ - "Q Api" - ], - "summary": "deleteQ", - "description": "", - "operationId": "deleteFromQ", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "version", - "in": "path", - "description": "Major Version", - "required": true, - "type": "string" - }, - { - "name": "X-minorVersion", - "in": "header", - "description": "Minor Version", - "required": false, - "type": "string" - }, - { - "name": "X-patchVersion", - "in": "header", - "description": "Patch Version", - "required": false, - "type": "string" - }, - { - "name": "aid", - "in": "header", - "description": "AID", - "required": true, - "type": "string" - }, - { - "name": "ns", - "in": "header", - "description": "Application namespace", - "required": true, - "type": "string" - }, - { - "name": "Authorization", - "in": "header", - "description": "Authorization", - "required": true, - "type": "string" - }, - { - "in": "body", - "name": "body", - "required": false, - "schema": { - "$ref": "#/definitions/JsonTable" - } - }, - { - "name": "keyspace", - "in": "path", - "description": "Key Space", - "required": true, - "type": "string" - }, - { - "name": "qname", - "in": "path", - "description": "Table Name", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "type": "string" - } - } - } - } - }, - "/{version}/priorityq/keyspaces/{keyspace}/{qname}/peek": { - "get": { - "tags": [ - "Q Api" - ], - "summary": "", - "description": "", - "operationId": "peek", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "version", - "in": "path", - "description": "Major Version", - "required": true, - "type": "string" - }, - { - "name": "X-minorVersion", - "in": "header", - "description": "Minor Version", - "required": false, - "type": "string" - }, - { - "name": "X-patchVersion", - "in": "header", - "description": "Patch Version", - "required": false, - "type": "string" - }, - { - "name": "aid", - "in": "header", - "description": "AID", - "required": true, - "type": "string" - }, - { - "name": "ns", - "in": "header", - "description": "Application namespace", - "required": true, - "type": "string" - }, - { - "name": "Authorization", - "in": "header", - "description": "Authorization", - "required": true, - "type": "string" - }, - { - "name": "keyspace", - "in": "path", - "description": "Key Space", - "required": true, - "type": "string" - }, - { - "name": "qname", - "in": "path", - "description": "Table Name", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "type": "object", - "additionalProperties": { - "type": "object" - } - } - } - } - } - }, - "/{version}/priorityq/keyspaces/{keyspace}/{qname}/filter": { - "get": { - "tags": [ - "Q Api" - ], - "summary": "filter", - "description": "", - "operationId": "filter", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "version", - "in": "path", - "description": "Major Version", - "required": true, - "type": "string" - }, - { - "name": "X-minorVersion", - "in": "header", - "description": "Minor Version", - "required": false, - "type": "string" - }, - { - "name": "X-patchVersion", - "in": "header", - "description": "Patch Version", - "required": false, - "type": "string" - }, - { - "name": "aid", - "in": "header", - "description": "AID", - "required": true, - "type": "string" - }, - { - "name": "ns", - "in": "header", - "description": "Application namespace", - "required": true, - "type": "string" - }, - { - "name": "Authorization", - "in": "header", - "description": "Authorization", - "required": true, - "type": "string" - }, - { - "name": "keyspace", - "in": "path", - "description": "Key Space", - "required": true, - "type": "string" - }, - { - "name": "qname", - "in": "path", - "description": "Table Name", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "type": "object", - "additionalProperties": { - "type": "object" - } - } - } - } - } - }, - "/v{version}/test": { - "get": { - "tags": [ - "Test Api" - ], - "summary": "Get Test", - "description": "", - "operationId": "simpleTests", - "produces": [ - "application/json" - ], - "parameters": [], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "type": "object", - "additionalProperties": { - "type": "object" - } - } - } - } - } - }, - "/v{version}/version": { - "get": { - "tags": [ - "Version Api" - ], - "summary": "Get Version", - "description": "", - "operationId": "version", - "produces": [ - "application/json" - ], - "parameters": [], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "type": "object", - "additionalProperties": { - "type": "object" - } - } - } - } - } - } - }, - "definitions": { - "JsonTable": { - "type": "object", - "properties": { - "columns": { - "type": "array", - "description": "Column values", - "items": { - "type": "string" - } - }, - "consistencyInfo": { - "type": "object", - "description": "Consistency level", - "additionalProperties": { - "type": "string" - } - }, - "conditions": { - "type": "object", - "description": "Conditions", - "additionalProperties": { - "type": "object" - } - }, - "ttl": { - "type": "string", - "description": "Time to live information" - }, - "timestamp": { - "type": "string", - "description": "Time stamp" - } - }, - "description": "Json model for delete" - } - } -} +{"swagger":"2.0","info":{"version":"1.0.0","title":""},"host":"localhost:8080","basePath":"/MUSIC/rest","tags":[{"name":"Version Api"},{"name":"Test Api"},{"name":"Q Api"},{"name":"Data Api"},{"name":"Lock Api"}],"schemes":["http"],"paths":{"/priorityq/keyspaces/{keyspace}/{qname}":{"post":{"tags":["Q Api"],"summary":"","description":"","operationId":"createQ","consumes":["application/json"],"parameters":[{"name":"version","in":"path","description":"Major Version","required":true,"type":"string"},{"name":"X-minorVersion","in":"header","description":"Minor Version","required":false,"type":"string"},{"name":"X-patchVersion","in":"header","description":"Patch Version","required":false,"type":"string"},{"name":"aid","in":"header","description":"AID","required":true,"type":"string"},{"name":"ns","in":"header","description":"Application namespace","required":true,"type":"string"},{"name":"userId","in":"header","description":"userId","required":true,"type":"string"},{"name":"password","in":"header","description":"Password","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/JsonTable"}},{"name":"keyspace","in":"path","description":"Key Space","required":true,"type":"string"},{"name":"tablename","in":"path","description":"Table Name","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"type":"object"}}}}},"delete":{"tags":["Q Api"],"summary":"","description":"","operationId":"dropQ","parameters":[{"name":"version","in":"path","description":"Major Version","required":true,"type":"string"},{"name":"X-minorVersion","in":"header","description":"Minor Version","required":false,"type":"string"},{"name":"X-patchVersion","in":"header","description":"Patch Version","required":false,"type":"string"},{"name":"aid","in":"header","description":"AID","required":true,"type":"string"},{"name":"ns","in":"header","description":"Application namespace","required":true,"type":"string"},{"name":"userId","in":"header","description":"userId","required":true,"type":"string"},{"name":"password","in":"header","description":"Password","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/JsonTable"}},{"name":"keyspace","in":"path","description":"Key Space","required":true,"type":"string"},{"name":"tablename","in":"path","description":"Table Name","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"type":"object"}}}}}},"/priorityq/keyspaces/{keyspace}/{qname}/filter":{"get":{"tags":["Q Api"],"summary":"","description":"","operationId":"filter","produces":["application/json"],"parameters":[{"name":"version","in":"path","description":"Major Version","required":true,"type":"string"},{"name":"X-minorVersion","in":"header","description":"Minor Version","required":false,"type":"string"},{"name":"X-patchVersion","in":"header","description":"Patch Version","required":false,"type":"string"},{"name":"aid","in":"header","description":"AID","required":true,"type":"string"},{"name":"ns","in":"header","description":"Application namespace","required":true,"type":"string"},{"name":"userId","in":"header","description":"userId","required":true,"type":"string"},{"name":"password","in":"header","description":"Password","required":true,"type":"string"},{"name":"keyspace","in":"path","description":"Key Space","required":true,"type":"string"},{"name":"tablename","in":"path","description":"Table Name","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"type":"object"}}}}}},"/priorityq/keyspaces/{keyspace}/{qname}/peek":{"get":{"tags":["Q Api"],"summary":"","description":"","operationId":"peek","produces":["application/json"],"parameters":[{"name":"version","in":"path","description":"Major Version","required":true,"type":"string"},{"name":"X-minorVersion","in":"header","description":"Minor Version","required":false,"type":"string"},{"name":"X-patchVersion","in":"header","description":"Patch Version","required":false,"type":"string"},{"name":"aid","in":"header","description":"AID","required":true,"type":"string"},{"name":"ns","in":"header","description":"Application namespace","required":true,"type":"string"},{"name":"userId","in":"header","description":"userId","required":true,"type":"string"},{"name":"password","in":"header","description":"Password","required":true,"type":"string"},{"name":"keyspace","in":"path","description":"Key Space","required":true,"type":"string"},{"name":"tablename","in":"path","description":"Table Name","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"type":"object"}}}}}},"/priorityq/keyspaces/{keyspace}/{qname}/rows":{"post":{"tags":["Q Api"],"summary":"","description":"","operationId":"insertIntoQ","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"version","in":"path","description":"Major Version","required":true,"type":"string"},{"name":"X-minorVersion","in":"header","description":"Minor Version","required":false,"type":"string"},{"name":"X-patchVersion","in":"header","description":"Patch Version","required":false,"type":"string"},{"name":"aid","in":"header","description":"AID","required":true,"type":"string"},{"name":"ns","in":"header","description":"Application namespace","required":true,"type":"string"},{"name":"userId","in":"header","description":"userId","required":true,"type":"string"},{"name":"password","in":"header","description":"Password","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/JsonTable"}},{"name":"keyspace","in":"path","description":"Key Space","required":true,"type":"string"},{"name":"tablename","in":"path","description":"Table Name","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"type":"object"}}}}},"put":{"tags":["Q Api"],"summary":"","description":"","operationId":"updateQ","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"version","in":"path","description":"Major Version","required":true,"type":"string"},{"name":"X-minorVersion","in":"header","description":"Minor Version","required":false,"type":"string"},{"name":"X-patchVersion","in":"header","description":"Patch Version","required":false,"type":"string"},{"name":"aid","in":"header","description":"AID","required":true,"type":"string"},{"name":"ns","in":"header","description":"Application namespace","required":true,"type":"string"},{"name":"userId","in":"header","description":"userId","required":true,"type":"string"},{"name":"password","in":"header","description":"Password","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/JsonTable"}},{"name":"keyspace","in":"path","description":"Key Space","required":true,"type":"string"},{"name":"tablename","in":"path","description":"Table Name","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}}}},"delete":{"tags":["Q Api"],"summary":"","description":"","operationId":"deleteFromQ","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"version","in":"path","description":"Major Version","required":true,"type":"string"},{"name":"X-minorVersion","in":"header","description":"Minor Version","required":false,"type":"string"},{"name":"X-patchVersion","in":"header","description":"Patch Version","required":false,"type":"string"},{"name":"aid","in":"header","description":"AID","required":true,"type":"string"},{"name":"ns","in":"header","description":"Application namespace","required":true,"type":"string"},{"name":"userId","in":"header","description":"userId","required":true,"type":"string"},{"name":"password","in":"header","description":"Password","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/JsonTable"}},{"name":"keyspace","in":"path","description":"Key Space","required":true,"type":"string"},{"name":"tablename","in":"path","description":"Table Name","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}}}}},"/v{version: [0-9]+}/keyspaces/{keyspace}/tables/{tablename}":{"post":{"tags":["Data Api"],"summary":"Create Table","description":"","operationId":"createTable","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"version","in":"path","description":"Major Version","required":true,"type":"string"},{"name":"X-minorVersion","in":"header","description":"Minor Version","required":false,"type":"string"},{"name":"X-patchVersion","in":"header","description":"Patch Version","required":false,"type":"string"},{"name":"aid","in":"header","description":"AID","required":true,"type":"string"},{"name":"ns","in":"header","description":"Application namespace","required":true,"type":"string"},{"name":"userId","in":"header","description":"userId","required":true,"type":"string"},{"name":"password","in":"header","description":"Password","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/JsonTable"}},{"name":"keyspace","in":"path","description":"Keyspace Name","required":true,"type":"string"},{"name":"tablename","in":"path","description":"Table Name","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}}}},"delete":{"tags":["Data Api"],"summary":"Drop Table","description":"","operationId":"dropTable","parameters":[{"name":"version","in":"path","description":"Major Version","required":true,"type":"string"},{"name":"X-minorVersion","in":"header","description":"Minor Version","required":false,"type":"string"},{"name":"X-patchVersion","in":"header","description":"Patch Version","required":false,"type":"string"},{"name":"aid","in":"header","description":"AID","required":true,"type":"string"},{"name":"ns","in":"header","description":"Application namespace","required":true,"type":"string"},{"name":"userId","in":"header","description":"userId","required":true,"type":"string"},{"name":"password","in":"header","description":"Password","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/JsonTable"}},{"name":"keyspace","in":"path","description":"Keyspace Name","required":true,"type":"string"},{"name":"tablename","in":"path","description":"Table Name","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}}}}},"/v{version: [0-9]+}/keyspaces/{keyspace}/tables/{tablename}/index/{field}":{"post":{"tags":["Data Api"],"summary":"Create Index","description":"","operationId":"createIndex","produces":["application/json"],"parameters":[{"name":"version","in":"path","description":"Major Version","required":true,"type":"string"},{"name":"X-minorVersion","in":"header","description":"Minor Version","required":false,"type":"string"},{"name":"X-patchVersion","in":"header","description":"Patch Version","required":false,"type":"string"},{"name":"aid","in":"header","description":"AID","required":true,"type":"string"},{"name":"ns","in":"header","description":"Application namespace","required":true,"type":"string"},{"name":"userId","in":"header","description":"userId","required":true,"type":"string"},{"name":"password","in":"header","description":"Password","required":true,"type":"string"},{"name":"keyspace","in":"path","description":"Keyspace Name","required":true,"type":"string"},{"name":"tablename","in":"path","description":"Table Name","required":true,"type":"string"},{"name":"field","in":"path","description":"Field Name","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}}}}},"/v{version: [0-9]+}/keyspaces/{keyspace}/tables/{tablename}/rows":{"get":{"tags":["Data Api"],"summary":"Select All or Select Specivic","description":"","operationId":"select","produces":["application/json"],"parameters":[{"name":"version","in":"path","description":"Major Version","required":true,"type":"string"},{"name":"X-minorVersion","in":"header","description":"Minor Version","required":false,"type":"string"},{"name":"X-patchVersion","in":"header","description":"Patch Version","required":false,"type":"string"},{"name":"aid","in":"header","description":"AID","required":true,"type":"string"},{"name":"ns","in":"header","description":"Application namespace","required":true,"type":"string"},{"name":"userId","in":"header","description":"userId","required":true,"type":"string"},{"name":"password","in":"header","description":"Password","required":true,"type":"string"},{"name":"keyspace","in":"path","description":"Keyspace Name","required":true,"type":"string"},{"name":"tablename","in":"path","description":"Table Name","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"type":"object"}}}}},"post":{"tags":["Data Api"],"summary":"Insert Into Table","description":"","operationId":"insertIntoTable","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"version","in":"path","description":"Major Version","required":true,"type":"string"},{"name":"X-minorVersion","in":"header","description":"Minor Version","required":false,"type":"string"},{"name":"X-patchVersion","in":"header","description":"Patch Version","required":false,"type":"string"},{"name":"aid","in":"header","description":"AID","required":true,"type":"string"},{"name":"ns","in":"header","description":"Application namespace","required":true,"type":"string"},{"name":"userId","in":"header","description":"userId","required":true,"type":"string"},{"name":"password","in":"header","description":"Password","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/JsonTable"}},{"name":"keyspace","in":"path","description":"Keyspace Name","required":true,"type":"string"},{"name":"tablename","in":"path","description":"Table Name","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}}}},"put":{"tags":["Data Api"],"summary":"Update Table","description":"","operationId":"updateTable","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"version","in":"path","description":"Major Version","required":true,"type":"string"},{"name":"X-minorVersion","in":"header","description":"Minor Version","required":false,"type":"string"},{"name":"X-patchVersion","in":"header","description":"Patch Version","required":false,"type":"string"},{"name":"aid","in":"header","description":"AID","required":true,"type":"string"},{"name":"ns","in":"header","description":"Application namespace","required":true,"type":"string"},{"name":"userId","in":"header","description":"userId","required":true,"type":"string"},{"name":"password","in":"header","description":"Password","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/JsonTable"}},{"name":"keyspace","in":"path","description":"Keyspace Name","required":true,"type":"string"},{"name":"tablename","in":"path","description":"Table Name","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}}}},"delete":{"tags":["Data Api"],"summary":"Delete From table","description":"","operationId":"deleteFromTable","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"version","in":"path","description":"Major Version","required":true,"type":"string"},{"name":"X-minorVersion","in":"header","description":"Minor Version","required":false,"type":"string"},{"name":"X-patchVersion","in":"header","description":"Patch Version","required":false,"type":"string"},{"name":"aid","in":"header","description":"AID","required":true,"type":"string"},{"name":"ns","in":"header","description":"Application namespace","required":true,"type":"string"},{"name":"userId","in":"header","description":"userId","required":true,"type":"string"},{"name":"password","in":"header","description":"Password","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/JsonTable"}},{"name":"keyspace","in":"path","description":"Keyspace Name","required":true,"type":"string"},{"name":"tablename","in":"path","description":"Table Name","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}}}}},"/v{version: [0-9]+}/keyspaces/{keyspace}/tables/{tablename}/rows/criticalget":{"put":{"tags":["Data Api"],"summary":"Select Critical","description":"","operationId":"selectCritical","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"version","in":"path","description":"Major Version","required":true,"type":"string"},{"name":"X-minorVersion","in":"header","description":"Minor Version","required":false,"type":"string"},{"name":"X-patchVersion","in":"header","description":"Patch Version","required":false,"type":"string"},{"name":"aid","in":"header","description":"AID","required":true,"type":"string"},{"name":"ns","in":"header","description":"Application namespace","required":true,"type":"string"},{"name":"userId","in":"header","description":"userId","required":true,"type":"string"},{"name":"password","in":"header","description":"Password","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/JsonTable"}},{"name":"keyspace","in":"path","description":"Keyspace Name","required":true,"type":"string"},{"name":"tablename","in":"path","description":"Table Name","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"type":"object"}}}}}},"/v{version: [0-9]+}/keyspaces/{name}":{"post":{"tags":["Data Api"],"summary":"Create Keyspace","description":"","operationId":"createKeySpace","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"version","in":"path","description":"Major Version","required":true,"type":"string"},{"name":"X-minorVersion","in":"header","description":"Minor Version","required":false,"type":"string"},{"name":"X-patchVersion","in":"header","description":"Patch Version","required":false,"type":"string"},{"name":"aid","in":"header","description":"AID","required":true,"type":"string"},{"name":"ns","in":"header","description":"Application namespace","required":true,"type":"string"},{"name":"userId","in":"header","description":"userId","required":true,"type":"string"},{"name":"password","in":"header","description":"Password","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/JsonTable"}},{"name":"name","in":"path","description":"Keyspace Name","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}}}},"delete":{"tags":["Data Api"],"summary":"Delete Keyspace","description":"","operationId":"dropKeySpace","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"version","in":"path","description":"Major Version","required":true,"type":"string"},{"name":"X-minorVersion","in":"header","description":"Minor Version","required":false,"type":"string"},{"name":"X-patchVersion","in":"header","description":"Patch Version","required":false,"type":"string"},{"name":"aid","in":"header","description":"AID","required":true,"type":"string"},{"name":"ns","in":"header","description":"Application namespace","required":true,"type":"string"},{"name":"userId","in":"header","description":"userId","required":true,"type":"string"},{"name":"password","in":"header","description":"Password","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/JsonTable"}},{"name":"name","in":"path","description":"Keyspace Name","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}}}}},"/v{version: [0-9]+}/locks/acquire-with-lease/{lockreference}":{"post":{"tags":["Lock Api"],"summary":"Aquire Lock with Lease","description":"","operationId":"accquireLockWithLease","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/JsonTable"}},{"name":"lockreference","in":"path","description":"Lock Reference","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"type":"object"}}}}}},"/v{version: [0-9]+}/locks/acquire/{lockreference}":{"get":{"tags":["Lock Api"],"summary":"Aquire Lock","description":"Checks if the node is in the top of the queue and hence acquires the lock","operationId":"accquireLock","produces":["application/json"],"parameters":[{"name":"lockreference","in":"path","description":"Lock Reference","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"type":"object"}}}}}},"/v{version: [0-9]+}/locks/create/{lockname}":{"post":{"tags":["Lock Api"],"summary":"Create Lock","description":"Puts the requesting process in the q for this lock. The corresponding node will be created in zookeeper if it did not already exist. Lock Name is the \"key\" of the form keyspaceName.tableName.rowId","operationId":"createLockReference","produces":["application/json"],"parameters":[{"name":"lockname","in":"path","description":"Lock Name","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"type":"object"}}}}}},"/v{version: [0-9]+}/locks/delete/{lockname}":{"delete":{"tags":["Lock Api"],"summary":"Delete Lock","description":"","operationId":"deleteLock","produces":["application/json"],"parameters":[{"name":"lockname","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"type":"object"}}}}}},"/v{version: [0-9]+}/locks/enquire/{lockname}":{"get":{"tags":["Lock Api"],"summary":"Get Lock Holder","description":"Gets the current Lock Holder","operationId":"currentLockHolder","produces":["application/json"],"parameters":[{"name":"lockname","in":"path","description":"Lock Name","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"type":"object"}}}}}},"/v{version: [0-9]+}/locks/release/{lockreference}":{"delete":{"tags":["Lock Api"],"summary":"Release Lock","description":"deletes the process from the zk queue","operationId":"unLock","produces":["application/json"],"parameters":[{"name":"lockreference","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"type":"object"}}}}}},"/v{version: [0-9]+}/locks/{lockname}":{"get":{"tags":["Lock Api"],"summary":"Lock State","description":"Returns current Lock State and Holder.","operationId":"currentLockState","produces":["application/json"],"parameters":[{"name":"lockname","in":"path","description":"Lock Name","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"type":"object"}}}}}},"/v{version: [0-9]+}/test":{"get":{"tags":["Test Api"],"summary":"Get Test","description":"","operationId":"simpleTests","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"type":"object"}}}}}},"/v{version: [0-9]+}/version":{"get":{"tags":["Version Api"],"summary":"Get Version","description":"","operationId":"version","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"type":"object"}}}}}}},"definitions":{"JsonTable":{"type":"object","properties":{"leasePeriod":{"type":"integer","format":"int64","description":"Lease period"},"notifyUrl":{"type":"string","description":"URL to be notified"}},"description":"model for leased lock"},"PreparedQueryObject":{"type":"object","properties":{"values":{"type":"array","items":{"type":"object"}},"query":{"type":"string"}}}}}
\ No newline at end of file |