twingraph endpoints

Author: Sergey Polyarus

doc/Apis/TwingraphApi.md

@@ -4,9 +4,9 @@ All URIs are relative to *https://dev.api.cosmotech.com*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**delete**](TwingraphApi.md#delete) | **DELETE** /organizations/{organization_id}/{graph_id} | 
-[**importGraph**](TwingraphApi.md#importGraph) | **POST** /organizations/{organization_id}/import | 
-[**query**](TwingraphApi.md#query) | **POST** /organizations/{organization_id}/query | 
+[**delete**](TwingraphApi.md#delete) | **DELETE** /organizations/{organization_id}/twingraph/{graph_id} | 
+[**importGraph**](TwingraphApi.md#importGraph) | **POST** /organizations/{organization_id}/twingraph/import | 
+[**query**](TwingraphApi.md#query) | **POST** /organizations/{organization_id}/twingraph/{graph_id}/query | 
 
 
 <a name="delete"></a>
@@ -67,7 +67,7 @@ Name | Type | Description  | Notes
 
 <a name="query"></a>
 # **query**
-> String query(organization\_id, TwinGraphQuery)
+> String query(organization\_id, graph\_id, TwinGraphQuery)
 
 
 
@@ -78,6 +78,7 @@ Name | Type | Description  | Notes
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **organization\_id** | **String**| the Organization identifier | [default to null]
+ **graph\_id** | **String**| the Graph Identifier | [default to null]
  **TwinGraphQuery** | [**TwinGraphQuery**](../Models/TwinGraphQuery.md)| the query to run |
 
 ### Return type

doc/Models/TwinGraphQuery.md

@@ -3,7 +3,6 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**graphId** | **String** | Twin graph name | [optional] [default to null]
 **version** | **String** | Twin graph version | [optional] [default to null]
 **query** | **String** | the query in cypher language | [optional] [default to null]
 

doc/README.md

@@ -88,9 +88,9 @@ Class | Method | HTTP request | Description
 *SolutionApi* | [**updateSolution**](Apis/SolutionApi.md#updatesolution) | **PATCH** /organizations/{organization_id}/solutions/{solution_id} | Update a solution
 *SolutionApi* | [**updateSolutionRunTemplate**](Apis/SolutionApi.md#updatesolutionruntemplate) | **PATCH** /organizations/{organization_id}/solutions/{solution_id}/runTemplates/{run_template_id} | Update the specified Solution Run Template
 *SolutionApi* | [**uploadRunTemplateHandler**](Apis/SolutionApi.md#uploadruntemplatehandler) | **POST** /organizations/{organization_id}/solutions/{solution_id}/runtemplates/{run_template_id}/handlers/{handler_id}/upload | Upload a Run Template step handler zip file
-*TwingraphApi* | [**delete**](Apis/TwingraphApi.md#delete) | **DELETE** /organizations/{organization_id}/{graph_id} | Launch a mass delete job
-*TwingraphApi* | [**importGraph**](Apis/TwingraphApi.md#importgraph) | **POST** /organizations/{organization_id}/import | Import a new version of a twin graph
-*TwingraphApi* | [**query**](Apis/TwingraphApi.md#query) | **POST** /organizations/{organization_id}/query | Run a query on a graph instance
+*TwingraphApi* | [**delete**](Apis/TwingraphApi.md#delete) | **DELETE** /organizations/{organization_id}/twingraph/{graph_id} | Launch a mass delete job
+*TwingraphApi* | [**importGraph**](Apis/TwingraphApi.md#importgraph) | **POST** /organizations/{organization_id}/twingraph/import | Import a new version of a twin graph
+*TwingraphApi* | [**query**](Apis/TwingraphApi.md#query) | **POST** /organizations/{organization_id}/twingraph/{graph_id}/query | Run a query on a graph instance
 *UserApi* | [**authorizeUser**](Apis/UserApi.md#authorizeuser) | **GET** /oauth2/authorize | Authorize an User with OAuth2. Delegated to configured OAuth2 service
 *UserApi* | [**findAllUsers**](Apis/UserApi.md#findallusers) | **GET** /users | List all Users
 *UserApi* | [**findUserById**](Apis/UserApi.md#finduserbyid) | **GET** /users/{user_id} | Get the details of an user

openapi/plantuml/schemas.plantuml

@@ -426,7 +426,6 @@ entity TwinGraphImportInfo {
 }
 
 entity TwinGraphQuery {
-    graphId: String
     version: String
     query: String
 }

twingraph/src/main/kotlin/com/cosmotech/twingraph/api/TwingraphServiceImpl.kt

@@ -64,25 +64,27 @@ class TwingraphServiceImpl(
     logger.debug("$count keys are removed from Twingraph with prefix $graphId")
   }
 
-  override fun query(organizationId: String, twinGraphQuery: TwinGraphQuery): String {
+  override fun query(
+      organizationId: String,
+      twingraphId: String,
+      twinGraphQuery: TwinGraphQuery
+  ): String {
     val organization = organizationService.findOrganizationById(organizationId)
     csmRbac.verify(organization.getRbac(), PERMISSION_READ)
     if (twinGraphQuery.version.isNullOrEmpty()) {
-      twinGraphQuery.version = jedis.hget("${twinGraphQuery.graphId}MetaData", "lastVersion")
+      twinGraphQuery.version = jedis.hget("${twingraphId}MetaData", "lastVersion")
       if (twinGraphQuery.version.isNullOrEmpty()) {
-        throw CsmResourceNotFoundException(
-            "Cannot find lastVersion in ${twinGraphQuery.graphId}MetaData")
+        throw CsmResourceNotFoundException("Cannot find lastVersion in ${twingraphId}MetaData")
       }
     }
 
-    val redisGraphId = "${twinGraphQuery.graphId}:${twinGraphQuery.version}"
+    val redisGraphId = "${twingraphId}:${twinGraphQuery.version}"
     val resultSet: ResultSet = jedis.graphQuery(redisGraphId, twinGraphQuery.query)
 
     val iterator = resultSet.iterator()
     if (!iterator.hasNext()) {
       throw CsmResourceNotFoundException(
-          "TwinGraph empty with given ${twinGraphQuery.graphId} " +
-              "and version ${twinGraphQuery.version}")
+          "TwinGraph empty with given ${twingraphId} " + "and version ${twinGraphQuery.version}")
     }
 
     val result = mutableMapOf<Int, MutableSet<String>>()

twingraph/src/main/openapi/twingraph.yaml

@@ -17,7 +17,7 @@ tags:
   description: Twin Graph Management
 
 paths:
-  /organizations/{organization_id}/import:
+  /organizations/{organization_id}/twingraph/import:
     parameters:
       - name: organization_id
         in: path
@@ -47,14 +47,20 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/TwinGraphImportInfo'
-  /organizations/{organization_id}/query:
+  /organizations/{organization_id}/twingraph/{graph_id}/query:
     parameters:
       - name: organization_id
         in: path
         description: the Organization identifier
         required: true
         schema:
           type: string
+      - name: graph_id
+        in: path
+        description: the Graph Identifier
+        required: true
+        schema:
+          type: string
     post:
       operationId: query
       tags:
@@ -77,7 +83,7 @@ paths:
             application/json:
               schema:
                 type: string
-  /organizations/{organization_id}/{graph_id}:
+  /organizations/{organization_id}/twingraph/{graph_id}:
     parameters:
       - name: organization_id
         in: path
@@ -116,9 +122,6 @@ components:
       type: object
       description: a twin graph query in cypher language
       properties:
-        graphId:
-          type: string
-          description: Twin graph name
         version:
           type: string
           description: Twin graph version