docs/DefaultApi.md in cheminee-0.1.6 vs docs/DefaultApi.md in cheminee-0.1.7
- old
+ new
@@ -2,35 +2,35 @@
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
```ruby
require 'time'
require 'cheminee'
api_instance = Cheminee::DefaultApi.new
begin
-
+ # List indexes
result = api_instance.v1_indexes_get
p result
rescue Cheminee::ApiError => e
puts "Error when calling DefaultApi->v1_indexes_get: #{e}"
end
@@ -42,11 +42,11 @@
> <Array(<Array<IndexMeta>>, Integer, Hash)> v1_indexes_get_with_http_info
```ruby
begin
-
+ # List indexes
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
@@ -74,12 +74,12 @@
## v1_indexes_index_bulk_index_post
> <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
```ruby
require 'time'
require 'cheminee'
@@ -87,11 +87,11 @@
api_instance = Cheminee::DefaultApi.new
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
puts "Error when calling DefaultApi->v1_indexes_index_bulk_index_post: #{e}"
end
@@ -103,11 +103,11 @@
> <Array(<PostIndexBulkResponseOk>, Integer, Hash)> v1_indexes_index_bulk_index_post_with_http_info(index, bulk_request)
```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 # => { ... }
p data # => <PostIndexBulkResponseOk>
rescue Cheminee::ApiError => e
@@ -138,23 +138,23 @@
## v1_indexes_index_get
> <Array<IndexMeta>> v1_indexes_index_get(index)
+Get extended information about an index
-
### Examples
```ruby
require 'time'
require 'cheminee'
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
puts "Error when calling DefaultApi->v1_indexes_index_get: #{e}"
end
@@ -166,11 +166,11 @@
> <Array(<Array<IndexMeta>>, Integer, Hash)> v1_indexes_index_get_with_http_info(index)
```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 # => { ... }
p data # => <Array<IndexMeta>>
rescue Cheminee::ApiError => e
@@ -200,12 +200,12 @@
## v1_indexes_index_post
> <IndexMeta> v1_indexes_index_post(index, schema, opts)
+Create an index
-
### Examples
```ruby
require 'time'
require 'cheminee'
@@ -216,11 +216,11 @@
opts = {
sort_by: 'sort_by_example' # String |
}
begin
-
+ # Create an index
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
@@ -232,11 +232,11 @@
> <Array(<IndexMeta>, Integer, Hash)> v1_indexes_index_post_with_http_info(index, schema, opts)
```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 # => { ... }
p data # => <IndexMeta>
rescue Cheminee::ApiError => e
@@ -268,12 +268,12 @@
## v1_indexes_index_search_substructure_get
> <Array<SubstructureSearchHit>> v1_indexes_index_search_substructure_get(index, q)
+Perform substructure search against index
-
### Examples
```ruby
require 'time'
require 'cheminee'
@@ -281,11 +281,11 @@
api_instance = Cheminee::DefaultApi.new
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
puts "Error when calling DefaultApi->v1_indexes_index_search_substructure_get: #{e}"
end
@@ -297,11 +297,11 @@
> <Array(<Array<SubstructureSearchHit>>, Integer, Hash)> v1_indexes_index_search_substructure_get_with_http_info(index, q)
```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 # => { ... }
p data # => <Array<SubstructureSearchHit>>
rescue Cheminee::ApiError => e
@@ -332,22 +332,22 @@
## v1_schemas_get
> <Array<Schema>> v1_schemas_get
+List schemas available for creating indexes
-
### Examples
```ruby
require 'time'
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
puts "Error when calling DefaultApi->v1_schemas_get: #{e}"
end
@@ -359,11 +359,11 @@
> <Array(<Array<Schema>>, Integer, Hash)> v1_schemas_get_with_http_info
```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 # => { ... }
p data # => <Array<Schema>>
rescue Cheminee::ApiError => e
@@ -391,23 +391,23 @@
## v1_standardize_post
> <Array<StandardizedSmile>> v1_standardize_post(smile)
+Pass a list of SMILES through fragment_parent, uncharger, and canonicalization routines
-
### Examples
```ruby
require 'time'
require 'cheminee'
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
puts "Error when calling DefaultApi->v1_standardize_post: #{e}"
end
@@ -419,10 +419,10 @@
> <Array(<Array<StandardizedSmile>>, Integer, Hash)> v1_standardize_post_with_http_info(smile)
```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 # => { ... }
p data # => <Array<StandardizedSmile>>
rescue Cheminee::ApiError => e