cheminee 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a65121f7843c1764ac85077b8ceaa08a05c0a5f71978ea8d6f96881bada945b1
-  data.tar.gz: 5ae188e4b9b0567db00612372c3fe9f1e57ce379560a35eca2cfd83805c2d4bb
+  metadata.gz: cf3f1cc1f61325ed72814ecfb9ad13976b2b9b43bffd304f10c4de5bd603ce54
+  data.tar.gz: 61ad6610334dc684ac553c30be8374c62a3a9f9448ab30587b1ac415b17cdaf7
 SHA512:
-  metadata.gz: b414dae786b782a47511dfe8d13f96fda7d30b9d890de210b4ee4ab2c17372e39d03dd63e6848cae0ea49c8b7d58695ce35b81b058ddd94864f80c371d3d7e78
-  data.tar.gz: 62129b1704d60fb0038c369ff861ff82bfb68b31684904e9dfe5dc470eff1345e40b8b8e9331cf2bfc0aad91531c58dd8b115d6724577f0ce4ee7843122fe9d8
+  metadata.gz: ed7d0328a375607eaea0685985af853dbbdd2b36a4d1ad9d2f010e588a1fbfd0c614054f76e66ff16cc7d8aec4de9f41857df3bf6f5c12c785d2a3ad5d34ac36
+  data.tar.gz: 6560589c555645180d94e14ec6e28d88a6c2f0c12ca5c971b353063062873b899745d74b80c560c0498297995a7fdfcc164394878f2f60525785c978c4b70b2b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cheminee (0.1.6)
+    cheminee (0.1.7)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM

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.1.6
+- Package version: 0.1.7
 - 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.1.6.gem
+gem install ./cheminee-0.1.7.gem
 ```
 
-(for development, run `gem install --dev ./cheminee-0.1.6.gem` to install the development dependencies)
+(for development, run `gem install --dev ./cheminee-0.1.7.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.1.6'
+    gem 'cheminee', '~> 0.1.7'
 
 ### Install from Git
 
@@ -60,6 +60,7 @@ require 'cheminee'
 api_instance = Cheminee::DefaultApi.new
 
 begin
+  #List indexes
   result = api_instance.v1_indexes_get
   p result
 rescue Cheminee::ApiError => e
@@ -74,13 +75,13 @@ All URIs are relative to *http://localhost:3000/api*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
-*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 | 
+*Cheminee::DefaultApi* | [**v1_indexes_get**](docs/DefaultApi.md#v1_indexes_get) | **GET** /v1/indexes | List indexes
+*Cheminee::DefaultApi* | [**v1_indexes_index_bulk_index_post**](docs/DefaultApi.md#v1_indexes_index_bulk_index_post) | **POST** /v1/indexes/{index}/bulk_index | Index a list of SMILES and associated, free-form JSON attributes which are indexed and searchable
+*Cheminee::DefaultApi* | [**v1_indexes_index_get**](docs/DefaultApi.md#v1_indexes_index_get) | **GET** /v1/indexes/{index} | Get extended information about an index
+*Cheminee::DefaultApi* | [**v1_indexes_index_post**](docs/DefaultApi.md#v1_indexes_index_post) | **POST** /v1/indexes/{index} | Create an index
+*Cheminee::DefaultApi* | [**v1_indexes_index_search_substructure_get**](docs/DefaultApi.md#v1_indexes_index_search_substructure_get) | **GET** /v1/indexes/{index}/search/substructure | Perform substructure search against index
+*Cheminee::DefaultApi* | [**v1_schemas_get**](docs/DefaultApi.md#v1_schemas_get) | **GET** /v1/schemas | List schemas available for creating indexes
+*Cheminee::DefaultApi* | [**v1_standardize_post**](docs/DefaultApi.md#v1_standardize_post) | **POST** /v1/standardize | Pass a list of SMILES through fragment_parent, uncharger, and canonicalization routines
 
 
 ## Documentation for Models

data/docs/BulkRequestDoc.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **smile** | **String** |  |  |
-| **extra_data** | **Object** |  | [optional] |
+| **extra_data** | **Object** | This value can store an arbitrary JSON object like '{}' | [optional] |
 
 ## Example
 

data/docs/DefaultApi.md

@@ -4,20 +4,20 @@ All URIs are relative to *http://localhost:3000/api*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**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 |  |
+| [**v1_indexes_get**](DefaultApi.md#v1_indexes_get) | **GET** /v1/indexes | List indexes |
+| [**v1_indexes_index_bulk_index_post**](DefaultApi.md#v1_indexes_index_bulk_index_post) | **POST** /v1/indexes/{index}/bulk_index | Index a list of SMILES and associated, free-form JSON attributes which are indexed and searchable |
+| [**v1_indexes_index_get**](DefaultApi.md#v1_indexes_index_get) | **GET** /v1/indexes/{index} | Get extended information about an index |
+| [**v1_indexes_index_post**](DefaultApi.md#v1_indexes_index_post) | **POST** /v1/indexes/{index} | Create an index |
+| [**v1_indexes_index_search_substructure_get**](DefaultApi.md#v1_indexes_index_search_substructure_get) | **GET** /v1/indexes/{index}/search/substructure | Perform substructure search against index |
+| [**v1_schemas_get**](DefaultApi.md#v1_schemas_get) | **GET** /v1/schemas | List schemas available for creating indexes |
+| [**v1_standardize_post**](DefaultApi.md#v1_standardize_post) | **POST** /v1/standardize | Pass a list of SMILES through fragment_parent, uncharger, and canonicalization routines |
 
 
 ## v1_indexes_get
 
 > <Array<IndexMeta>> v1_indexes_get
 
-
+List indexes
 
 ### Examples
 
@@ -28,7 +28,7 @@ require 'cheminee'
 api_instance = Cheminee::DefaultApi.new
 
 begin
-  
+  # List indexes
   result = api_instance.v1_indexes_get
   p result
 rescue Cheminee::ApiError => e
@@ -44,7 +44,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  
+  # List indexes
   data, status_code, headers = api_instance.v1_indexes_get_with_http_info
   p status_code # => 2xx
   p headers # => { ... }
@@ -76,7 +76,7 @@ No authorization required
 
 > <PostIndexBulkResponseOk> v1_indexes_index_bulk_index_post(index, bulk_request)
 
-
+Index a list of SMILES and associated, free-form JSON attributes which are indexed and searchable
 
 ### Examples
 
@@ -89,7 +89,7 @@ index = 'index_example' # String |
 bulk_request = Cheminee::BulkRequest.new({docs: [Cheminee::BulkRequestDoc.new({smile: 'smile_example'})]}) # BulkRequest | 
 
 begin
-  
+  # Index a list of SMILES and associated, free-form JSON attributes which are indexed and searchable
   result = api_instance.v1_indexes_index_bulk_index_post(index, bulk_request)
   p result
 rescue Cheminee::ApiError => e
@@ -105,7 +105,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  
+  # Index a list of SMILES and associated, free-form JSON attributes which are indexed and searchable
   data, status_code, headers = api_instance.v1_indexes_index_bulk_index_post_with_http_info(index, bulk_request)
   p status_code # => 2xx
   p headers # => { ... }
@@ -140,7 +140,7 @@ No authorization required
 
 > <Array<IndexMeta>> v1_indexes_index_get(index)
 
-
+Get extended information about an index
 
 ### Examples
 
@@ -152,7 +152,7 @@ api_instance = Cheminee::DefaultApi.new
 index = 'index_example' # String | 
 
 begin
-  
+  # Get extended information about an index
   result = api_instance.v1_indexes_index_get(index)
   p result
 rescue Cheminee::ApiError => e
@@ -168,7 +168,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  
+  # Get extended information about an index
   data, status_code, headers = api_instance.v1_indexes_index_get_with_http_info(index)
   p status_code # => 2xx
   p headers # => { ... }
@@ -202,7 +202,7 @@ No authorization required
 
 > <IndexMeta> v1_indexes_index_post(index, schema, opts)
 
-
+Create an index
 
 ### Examples
 
@@ -218,7 +218,7 @@ opts = {
 }
 
 begin
-  
+  # Create an index
   result = api_instance.v1_indexes_index_post(index, schema, opts)
   p result
 rescue Cheminee::ApiError => e
@@ -234,7 +234,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  
+  # Create an index
   data, status_code, headers = api_instance.v1_indexes_index_post_with_http_info(index, schema, opts)
   p status_code # => 2xx
   p headers # => { ... }
@@ -270,7 +270,7 @@ No authorization required
 
 > <Array<SubstructureSearchHit>> v1_indexes_index_search_substructure_get(index, q)
 
-
+Perform substructure search against index
 
 ### Examples
 
@@ -283,7 +283,7 @@ index = 'index_example' # String |
 q = 'q_example' # String | 
 
 begin
-  
+  # Perform substructure search against index
   result = api_instance.v1_indexes_index_search_substructure_get(index, q)
   p result
 rescue Cheminee::ApiError => e
@@ -299,7 +299,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  
+  # Perform substructure search against index
   data, status_code, headers = api_instance.v1_indexes_index_search_substructure_get_with_http_info(index, q)
   p status_code # => 2xx
   p headers # => { ... }
@@ -334,7 +334,7 @@ No authorization required
 
 > <Array<Schema>> v1_schemas_get
 
-
+List schemas available for creating indexes
 
 ### Examples
 
@@ -345,7 +345,7 @@ require 'cheminee'
 api_instance = Cheminee::DefaultApi.new
 
 begin
-  
+  # List schemas available for creating indexes
   result = api_instance.v1_schemas_get
   p result
 rescue Cheminee::ApiError => e
@@ -361,7 +361,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  
+  # List schemas available for creating indexes
   data, status_code, headers = api_instance.v1_schemas_get_with_http_info
   p status_code # => 2xx
   p headers # => { ... }
@@ -393,7 +393,7 @@ No authorization required
 
 > <Array<StandardizedSmile>> v1_standardize_post(smile)
 
-
+Pass a list of SMILES through fragment_parent, uncharger, and canonicalization routines
 
 ### Examples
 
@@ -405,7 +405,7 @@ api_instance = Cheminee::DefaultApi.new
 smile = [Cheminee::Smile.new({smile: 'smile_example'})] # Array<Smile> | 
 
 begin
-  
+  # Pass a list of SMILES through fragment_parent, uncharger, and canonicalization routines
   result = api_instance.v1_standardize_post(smile)
   p result
 rescue Cheminee::ApiError => e
@@ -421,7 +421,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  
+  # Pass a list of SMILES through fragment_parent, uncharger, and canonicalization routines
   data, status_code, headers = api_instance.v1_standardize_post_with_http_info(smile)
   p status_code # => 2xx
   p headers # => { ... }

data/lib/cheminee/api/default_api.rb

@@ -19,6 +19,7 @@ module Cheminee
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+    # List indexes
     # @param [Hash] opts the optional parameters
     # @return [Array<IndexMeta>]
     def v1_indexes_get(opts = {})
@@ -26,6 +27,7 @@ module Cheminee
       data
     end
 
+    # List indexes
     # @param [Hash] opts the optional parameters
     # @return [Array<(Array<IndexMeta>, Integer, Hash)>] Array<IndexMeta> data, response status code and response headers
     def v1_indexes_get_with_http_info(opts = {})
@@ -72,6 +74,7 @@ module Cheminee
       return data, status_code, headers
     end
 
+    # Index a list of SMILES and associated, free-form JSON attributes which are indexed and searchable
     # @param index [String] 
     # @param bulk_request [BulkRequest] 
     # @param [Hash] opts the optional parameters
@@ -81,6 +84,7 @@ module Cheminee
       data
     end
 
+    # Index a list of SMILES and associated, free-form JSON attributes which are indexed and searchable
     # @param index [String] 
     # @param bulk_request [BulkRequest] 
     # @param [Hash] opts the optional parameters
@@ -142,6 +146,7 @@ module Cheminee
       return data, status_code, headers
     end
 
+    # Get extended information about an index
     # @param index [String] 
     # @param [Hash] opts the optional parameters
     # @return [Array<IndexMeta>]
@@ -150,6 +155,7 @@ module Cheminee
       data
     end
 
+    # Get extended information about an index
     # @param index [String] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(Array<IndexMeta>, Integer, Hash)>] Array<IndexMeta> data, response status code and response headers
@@ -201,6 +207,7 @@ module Cheminee
       return data, status_code, headers
     end
 
+    # Create an index
     # @param index [String] 
     # @param schema [String] 
     # @param [Hash] opts the optional parameters
@@ -211,6 +218,7 @@ module Cheminee
       data
     end
 
+    # Create an index
     # @param index [String] 
     # @param schema [String] 
     # @param [Hash] opts the optional parameters
@@ -270,6 +278,7 @@ module Cheminee
       return data, status_code, headers
     end
 
+    # Perform substructure search against index
     # @param index [String] 
     # @param q [String] 
     # @param [Hash] opts the optional parameters
@@ -279,6 +288,7 @@ module Cheminee
       data
     end
 
+    # Perform substructure search against index
     # @param index [String] 
     # @param q [String] 
     # @param [Hash] opts the optional parameters
@@ -336,6 +346,7 @@ module Cheminee
       return data, status_code, headers
     end
 
+    # List schemas available for creating indexes
     # @param [Hash] opts the optional parameters
     # @return [Array<Schema>]
     def v1_schemas_get(opts = {})
@@ -343,6 +354,7 @@ module Cheminee
       data
     end
 
+    # List schemas available for creating indexes
     # @param [Hash] opts the optional parameters
     # @return [Array<(Array<Schema>, Integer, Hash)>] Array<Schema> data, response status code and response headers
     def v1_schemas_get_with_http_info(opts = {})
@@ -389,6 +401,7 @@ module Cheminee
       return data, status_code, headers
     end
 
+    # Pass a list of SMILES through fragment_parent, uncharger, and canonicalization routines
     # @param smile [Array<Smile>] 
     # @param [Hash] opts the optional parameters
     # @return [Array<StandardizedSmile>]
@@ -397,6 +410,7 @@ module Cheminee
       data
     end
 
+    # Pass a list of SMILES through fragment_parent, uncharger, and canonicalization routines
     # @param smile [Array<Smile>] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(Array<StandardizedSmile>, Integer, Hash)>] Array<StandardizedSmile> data, response status code and response headers

data/lib/cheminee/models/bulk_request_doc.rb

@@ -17,6 +17,7 @@ module Cheminee
   class BulkRequestDoc
     attr_accessor :smile
 
+    # This value can store an arbitrary JSON object like '{}'
     attr_accessor :extra_data
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/cheminee/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 7.1.0-SNAPSHOT
 =end
 
 module Cheminee
-  VERSION = '0.1.6'
+  VERSION = '0.1.7'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cheminee
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Xavier Lange
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-10-18 00:00:00.000000000 Z
+date: 2023-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -98,7 +98,7 @@ files:
 - lib/cheminee/version.rb
 - openapi-generator-config.json
 - openapi.json
-- pkg/cheminee-0.1.6.gem
+- pkg/cheminee-0.1.7.gem
 - spec/api/default_api_spec.rb
 - spec/api_client_spec.rb
 - spec/configuration_spec.rb