cheminee 0.0.15 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 706c2ab9f2aa12e134bd1abd45903bc875cae5395c5807440df94eef33bf5d9f
-  data.tar.gz: '079fbe772ea29abf9d042a439e0a38d26b0d5c5192897e8d07e8a08c9280563f'
+  metadata.gz: a65121f7843c1764ac85077b8ceaa08a05c0a5f71978ea8d6f96881bada945b1
+  data.tar.gz: 5ae188e4b9b0567db00612372c3fe9f1e57ce379560a35eca2cfd83805c2d4bb
 SHA512:
-  metadata.gz: bc6a0005d9bc67f6a9a8224e1a293e615fada51873b3a3d2ca06bfabe906538051e0d3c09530dcb0727cdad7cf27bdd25655ebe6e3791ab64c89c5171bcc34f4
-  data.tar.gz: ecfcf0007f6521245c975d92000e5736f456d3ad16e57d165cd729fd94cd3e93f64819092fc662fef4b019d8f4e308c12a0432140577dc13b2568e74a7c4743f
+  metadata.gz: b414dae786b782a47511dfe8d13f96fda7d30b9d890de210b4ee4ab2c17372e39d03dd63e6848cae0ea49c8b7d58695ce35b81b058ddd94864f80c371d3d7e78
+  data.tar.gz: 62129b1704d60fb0038c369ff861ff82bfb68b31684904e9dfe5dc470eff1345e40b8b8e9331cf2bfc0aad91531c58dd8b115d6724577f0ce4ee7843122fe9d8

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cheminee (0.0.15)
+    cheminee (0.1.6)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM
@@ -13,11 +13,11 @@ GEM
     diff-lcs (1.5.0)
     ethon (0.16.0)
       ffi (>= 1.15.0)
-    ffi (1.15.5)
+    ffi (1.16.3)
     jaro_winkler (1.5.6)
     method_source (1.0.0)
     parallel (1.23.0)
-    parser (3.2.2.3)
+    parser (3.2.2.4)
       ast (~> 2.4.1)
       racc
     pry (0.14.2)
@@ -26,7 +26,7 @@ GEM
     pry-byebug (3.10.1)
       byebug (~> 11.0)
       pry (>= 0.13, < 0.15)
-    psych (5.1.0)
+    psych (5.1.1.1)
       stringio
     racc (1.7.1)
     rainbow (3.1.1)

data/README.md

@@ -7,7 +7,7 @@ Cheminée: The Chemical Structure Search Engine
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 1.0
-- Package version: 0.0.15
+- Package version: 0.1.6
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 For more information, please visit [https://github.com/rdkit-rs/cheminee](https://github.com/rdkit-rs/cheminee)
 
@@ -24,16 +24,16 @@ gem build cheminee.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./cheminee-0.0.15.gem
+gem install ./cheminee-0.1.6.gem
 ```
 
-(for development, run `gem install --dev ./cheminee-0.0.15.gem` to install the development dependencies)
+(for development, run `gem install --dev ./cheminee-0.1.6.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'cheminee', '~> 0.0.15'
+    gem 'cheminee', '~> 0.1.6'
 
 ### Install from Git
 
@@ -58,30 +58,46 @@ Please follow the [installation](#installation) procedure and then run the follo
 require 'cheminee'
 
 api_instance = Cheminee::DefaultApi.new
-smile = [Cheminee::Smile.new({smile: 'smile_example'})] # Array<Smile> | 
 
 begin
-  result = api_instance.standardize_post(smile)
+  result = api_instance.v1_indexes_get
   p result
 rescue Cheminee::ApiError => e
-  puts "Exception when calling DefaultApi->standardize_post: #{e}"
+  puts "Exception when calling DefaultApi->v1_indexes_get: #{e}"
 end
 
 ```
 
 ## Documentation for API Endpoints
 
-All URIs are relative to *http://localhost:3000/api/v1*
+All URIs are relative to *http://localhost:3000/api*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
-*Cheminee::DefaultApi* | [**standardize_post**](docs/DefaultApi.md#standardize_post) | **POST** /standardize | 
+*Cheminee::DefaultApi* | [**v1_indexes_get**](docs/DefaultApi.md#v1_indexes_get) | **GET** /v1/indexes | 
+*Cheminee::DefaultApi* | [**v1_indexes_index_bulk_index_post**](docs/DefaultApi.md#v1_indexes_index_bulk_index_post) | **POST** /v1/indexes/{index}/bulk_index | 
+*Cheminee::DefaultApi* | [**v1_indexes_index_get**](docs/DefaultApi.md#v1_indexes_index_get) | **GET** /v1/indexes/{index} | 
+*Cheminee::DefaultApi* | [**v1_indexes_index_post**](docs/DefaultApi.md#v1_indexes_index_post) | **POST** /v1/indexes/{index} | 
+*Cheminee::DefaultApi* | [**v1_indexes_index_search_substructure_get**](docs/DefaultApi.md#v1_indexes_index_search_substructure_get) | **GET** /v1/indexes/{index}/search/substructure | 
+*Cheminee::DefaultApi* | [**v1_schemas_get**](docs/DefaultApi.md#v1_schemas_get) | **GET** /v1/schemas | 
+*Cheminee::DefaultApi* | [**v1_standardize_post**](docs/DefaultApi.md#v1_standardize_post) | **POST** /v1/standardize | 
 
 
 ## Documentation for Models
 
+ - [Cheminee::BulkRequest](docs/BulkRequest.md)
+ - [Cheminee::BulkRequestDoc](docs/BulkRequestDoc.md)
+ - [Cheminee::CreateIndexError](docs/CreateIndexError.md)
+ - [Cheminee::GetIndexesResponseError](docs/GetIndexesResponseError.md)
+ - [Cheminee::IndexMeta](docs/IndexMeta.md)
+ - [Cheminee::ListIndexResponseErr](docs/ListIndexResponseErr.md)
+ - [Cheminee::PostIndexBulkResponseError](docs/PostIndexBulkResponseError.md)
+ - [Cheminee::PostIndexBulkResponseOk](docs/PostIndexBulkResponseOk.md)
+ - [Cheminee::PostIndexBulkResponseOkStatus](docs/PostIndexBulkResponseOkStatus.md)
+ - [Cheminee::Schema](docs/Schema.md)
  - [Cheminee::Smile](docs/Smile.md)
  - [Cheminee::StandardizedSmile](docs/StandardizedSmile.md)
+ - [Cheminee::SubstructureSearchHit](docs/SubstructureSearchHit.md)
 
 
 ## Documentation for Authorization

data/cheminee.gemspec

@@ -8,7 +8,7 @@
 The version of the OpenAPI document: 1.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 7.0.0-SNAPSHOT
+OpenAPI Generator version: 7.1.0-SNAPSHOT
 
 =end
 

data/docs/BulkRequest.md

@@ -0,0 +1,18 @@
+# Cheminee::BulkRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **docs** | [**Array<BulkRequestDoc>**](BulkRequestDoc.md) |  |  |
+
+## Example
+
+```ruby
+require 'cheminee'
+
+instance = Cheminee::BulkRequest.new(
+  docs: null
+)
+```
+

data/docs/BulkRequestDoc.md

@@ -0,0 +1,20 @@
+# Cheminee::BulkRequestDoc
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **smile** | **String** |  |  |
+| **extra_data** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'cheminee'
+
+instance = Cheminee::BulkRequestDoc.new(
+  smile: null,
+  extra_data: null
+)
+```
+

data/docs/CreateIndexError.md

@@ -0,0 +1,18 @@
+# Cheminee::CreateIndexError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'cheminee'
+
+instance = Cheminee::CreateIndexError.new(
+  error: null
+)
+```
+

data/docs/DefaultApi.md

@@ -1,15 +1,397 @@
 # Cheminee::DefaultApi
 
-All URIs are relative to *http://localhost:3000/api/v1*
+All URIs are relative to *http://localhost:3000/api*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**standardize_post**](DefaultApi.md#standardize_post) | **POST** /standardize |  |
+| [**v1_indexes_get**](DefaultApi.md#v1_indexes_get) | **GET** /v1/indexes |  |
+| [**v1_indexes_index_bulk_index_post**](DefaultApi.md#v1_indexes_index_bulk_index_post) | **POST** /v1/indexes/{index}/bulk_index |  |
+| [**v1_indexes_index_get**](DefaultApi.md#v1_indexes_index_get) | **GET** /v1/indexes/{index} |  |
+| [**v1_indexes_index_post**](DefaultApi.md#v1_indexes_index_post) | **POST** /v1/indexes/{index} |  |
+| [**v1_indexes_index_search_substructure_get**](DefaultApi.md#v1_indexes_index_search_substructure_get) | **GET** /v1/indexes/{index}/search/substructure |  |
+| [**v1_schemas_get**](DefaultApi.md#v1_schemas_get) | **GET** /v1/schemas |  |
+| [**v1_standardize_post**](DefaultApi.md#v1_standardize_post) | **POST** /v1/standardize |  |
 
 
-## standardize_post
+## v1_indexes_get
 
-> <Array<StandardizedSmile>> standardize_post(smile)
+> <Array<IndexMeta>> v1_indexes_get
+
+
+
+### Examples
+
+```ruby
+require 'time'
+require 'cheminee'
+
+api_instance = Cheminee::DefaultApi.new
+
+begin
+  
+  result = api_instance.v1_indexes_get
+  p result
+rescue Cheminee::ApiError => e
+  puts "Error when calling DefaultApi->v1_indexes_get: #{e}"
+end
+```
+
+#### Using the v1_indexes_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<IndexMeta>>, Integer, Hash)> v1_indexes_get_with_http_info
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.v1_indexes_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<IndexMeta>>
+rescue Cheminee::ApiError => e
+  puts "Error when calling DefaultApi->v1_indexes_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array&lt;IndexMeta&gt;**](IndexMeta.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json; charset=utf-8
+
+
+## v1_indexes_index_bulk_index_post
+
+> <PostIndexBulkResponseOk> v1_indexes_index_bulk_index_post(index, bulk_request)
+
+
+
+### Examples
+
+```ruby
+require 'time'
+require 'cheminee'
+
+api_instance = Cheminee::DefaultApi.new
+index = 'index_example' # String | 
+bulk_request = Cheminee::BulkRequest.new({docs: [Cheminee::BulkRequestDoc.new({smile: 'smile_example'})]}) # BulkRequest | 
+
+begin
+  
+  result = api_instance.v1_indexes_index_bulk_index_post(index, bulk_request)
+  p result
+rescue Cheminee::ApiError => e
+  puts "Error when calling DefaultApi->v1_indexes_index_bulk_index_post: #{e}"
+end
+```
+
+#### Using the v1_indexes_index_bulk_index_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PostIndexBulkResponseOk>, Integer, Hash)> v1_indexes_index_bulk_index_post_with_http_info(index, bulk_request)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.v1_indexes_index_bulk_index_post_with_http_info(index, bulk_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PostIndexBulkResponseOk>
+rescue Cheminee::ApiError => e
+  puts "Error when calling DefaultApi->v1_indexes_index_bulk_index_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **index** | **String** |  |  |
+| **bulk_request** | [**BulkRequest**](BulkRequest.md) |  |  |
+
+### Return type
+
+[**PostIndexBulkResponseOk**](PostIndexBulkResponseOk.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json; charset=utf-8
+- **Accept**: application/json; charset=utf-8
+
+
+## v1_indexes_index_get
+
+> <Array<IndexMeta>> v1_indexes_index_get(index)
+
+
+
+### Examples
+
+```ruby
+require 'time'
+require 'cheminee'
+
+api_instance = Cheminee::DefaultApi.new
+index = 'index_example' # String | 
+
+begin
+  
+  result = api_instance.v1_indexes_index_get(index)
+  p result
+rescue Cheminee::ApiError => e
+  puts "Error when calling DefaultApi->v1_indexes_index_get: #{e}"
+end
+```
+
+#### Using the v1_indexes_index_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<IndexMeta>>, Integer, Hash)> v1_indexes_index_get_with_http_info(index)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.v1_indexes_index_get_with_http_info(index)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<IndexMeta>>
+rescue Cheminee::ApiError => e
+  puts "Error when calling DefaultApi->v1_indexes_index_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **index** | **String** |  |  |
+
+### Return type
+
+[**Array&lt;IndexMeta&gt;**](IndexMeta.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json; charset=utf-8
+
+
+## v1_indexes_index_post
+
+> <IndexMeta> v1_indexes_index_post(index, schema, opts)
+
+
+
+### Examples
+
+```ruby
+require 'time'
+require 'cheminee'
+
+api_instance = Cheminee::DefaultApi.new
+index = 'index_example' # String | 
+schema = 'schema_example' # String | 
+opts = {
+  sort_by: 'sort_by_example' # String | 
+}
+
+begin
+  
+  result = api_instance.v1_indexes_index_post(index, schema, opts)
+  p result
+rescue Cheminee::ApiError => e
+  puts "Error when calling DefaultApi->v1_indexes_index_post: #{e}"
+end
+```
+
+#### Using the v1_indexes_index_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<IndexMeta>, Integer, Hash)> v1_indexes_index_post_with_http_info(index, schema, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.v1_indexes_index_post_with_http_info(index, schema, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <IndexMeta>
+rescue Cheminee::ApiError => e
+  puts "Error when calling DefaultApi->v1_indexes_index_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **index** | **String** |  |  |
+| **schema** | **String** |  |  |
+| **sort_by** | **String** |  | [optional] |
+
+### Return type
+
+[**IndexMeta**](IndexMeta.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json; charset=utf-8
+
+
+## v1_indexes_index_search_substructure_get
+
+> <Array<SubstructureSearchHit>> v1_indexes_index_search_substructure_get(index, q)
+
+
+
+### Examples
+
+```ruby
+require 'time'
+require 'cheminee'
+
+api_instance = Cheminee::DefaultApi.new
+index = 'index_example' # String | 
+q = 'q_example' # String | 
+
+begin
+  
+  result = api_instance.v1_indexes_index_search_substructure_get(index, q)
+  p result
+rescue Cheminee::ApiError => e
+  puts "Error when calling DefaultApi->v1_indexes_index_search_substructure_get: #{e}"
+end
+```
+
+#### Using the v1_indexes_index_search_substructure_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<SubstructureSearchHit>>, Integer, Hash)> v1_indexes_index_search_substructure_get_with_http_info(index, q)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.v1_indexes_index_search_substructure_get_with_http_info(index, q)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<SubstructureSearchHit>>
+rescue Cheminee::ApiError => e
+  puts "Error when calling DefaultApi->v1_indexes_index_search_substructure_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **index** | **String** |  |  |
+| **q** | **String** |  |  |
+
+### Return type
+
+[**Array&lt;SubstructureSearchHit&gt;**](SubstructureSearchHit.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json; charset=utf-8
+
+
+## v1_schemas_get
+
+> <Array<Schema>> v1_schemas_get
+
+
+
+### Examples
+
+```ruby
+require 'time'
+require 'cheminee'
+
+api_instance = Cheminee::DefaultApi.new
+
+begin
+  
+  result = api_instance.v1_schemas_get
+  p result
+rescue Cheminee::ApiError => e
+  puts "Error when calling DefaultApi->v1_schemas_get: #{e}"
+end
+```
+
+#### Using the v1_schemas_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<Schema>>, Integer, Hash)> v1_schemas_get_with_http_info
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.v1_schemas_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<Schema>>
+rescue Cheminee::ApiError => e
+  puts "Error when calling DefaultApi->v1_schemas_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array&lt;Schema&gt;**](Schema.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json; charset=utf-8
+
+
+## v1_standardize_post
+
+> <Array<StandardizedSmile>> v1_standardize_post(smile)
 
 
 
@@ -24,28 +406,28 @@ smile = [Cheminee::Smile.new({smile: 'smile_example'})] # Array<Smile> |
 
 begin
   
-  result = api_instance.standardize_post(smile)
+  result = api_instance.v1_standardize_post(smile)
   p result
 rescue Cheminee::ApiError => e
-  puts "Error when calling DefaultApi->standardize_post: #{e}"
+  puts "Error when calling DefaultApi->v1_standardize_post: #{e}"
 end
 ```
 
-#### Using the standardize_post_with_http_info variant
+#### Using the v1_standardize_post_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<Array<StandardizedSmile>>, Integer, Hash)> standardize_post_with_http_info(smile)
+> <Array(<Array<StandardizedSmile>>, Integer, Hash)> v1_standardize_post_with_http_info(smile)
 
 ```ruby
 begin
   
-  data, status_code, headers = api_instance.standardize_post_with_http_info(smile)
+  data, status_code, headers = api_instance.v1_standardize_post_with_http_info(smile)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Array<StandardizedSmile>>
 rescue Cheminee::ApiError => e
-  puts "Error when calling DefaultApi->standardize_post_with_http_info: #{e}"
+  puts "Error when calling DefaultApi->v1_standardize_post_with_http_info: #{e}"
 end
 ```
 

data/docs/GetIndexesResponseError.md

@@ -0,0 +1,18 @@
+# Cheminee::GetIndexesResponseError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'cheminee'
+
+instance = Cheminee::GetIndexesResponseError.new(
+  error: null
+)
+```
+

data/docs/IndexMeta.md

@@ -0,0 +1,20 @@
+# Cheminee::IndexMeta
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **schema** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'cheminee'
+
+instance = Cheminee::IndexMeta.new(
+  name: null,
+  schema: null
+)
+```
+

data/docs/ListIndexResponseErr.md

@@ -0,0 +1,18 @@
+# Cheminee::ListIndexResponseErr
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'cheminee'
+
+instance = Cheminee::ListIndexResponseErr.new(
+  error: null
+)
+```
+