Refine OpenSearch adapter docs and dependencies

Author: stevebauman

composer.json

@@ -27,7 +27,6 @@
     },
     "require": {
         "php": "^8.2",
-        "guzzlehttp/guzzle": "^7.0",
         "opensearch-project/opensearch-php": "^2.6"
     },
     "require-dev": {

src/Documents/Document.php

@@ -2,6 +2,9 @@
 
 namespace DirectoryTree\OpenSearchAdapter\Documents;
 
+/**
+ * @see https://docs.opensearch.org/latest/api-reference/document-apis/index-document/
+ */
 class Document
 {
     /**
@@ -28,7 +31,7 @@ public function id(): string
      */
     public function content(?string $key = null): mixed
     {
-        if ($key === null) {
+        if (is_null($key)) {
             return $this->content;
         }
 

src/Documents/DocumentManager.php

@@ -7,6 +7,11 @@
 use DirectoryTree\OpenSearchAdapter\Search\SearchResponse;
 use OpenSearch\Client;
 
+/**
+ * @see https://docs.opensearch.org/latest/api-reference/document-apis/bulk/
+ * @see https://docs.opensearch.org/latest/api-reference/document-apis/delete-by-query/
+ * @see https://docs.opensearch.org/latest/api-reference/search-apis/search/
+ */
 class DocumentManager
 {
     /**

src/Documents/Routing.php

@@ -2,6 +2,9 @@
 
 namespace DirectoryTree\OpenSearchAdapter\Documents;
 
+/**
+ * @see https://docs.opensearch.org/latest/api-reference/search-apis/search-shards/
+ */
 class Routing
 {
     /**

src/Exceptions/BulkRequestException.php

@@ -4,6 +4,9 @@
 
 use ErrorException;
 
+/**
+ * @see https://docs.opensearch.org/latest/api-reference/document-apis/bulk/
+ */
 class BulkRequestException extends ErrorException
 {
     /**

src/Indices/Alias.php

@@ -2,6 +2,9 @@
 
 namespace DirectoryTree\OpenSearchAdapter\Indices;
 
+/**
+ * @see https://docs.opensearch.org/latest/api-reference/index-apis/alias/
+ */
 class Alias
 {
     /**

src/Indices/IndexBlueprint.php

@@ -2,6 +2,9 @@
 
 namespace DirectoryTree\OpenSearchAdapter\Indices;
 
+/**
+ * @see https://docs.opensearch.org/latest/api-reference/index-apis/create-index/
+ */
 class IndexBlueprint
 {
     /**

src/Indices/IndexManager.php

@@ -5,6 +5,12 @@
 use OpenSearch\Client;
 use OpenSearch\Namespaces\IndicesNamespace;
 
+/**
+ * @see https://docs.opensearch.org/latest/api-reference/index-apis/create-index/
+ * @see https://docs.opensearch.org/latest/api-reference/index-apis/put-mapping/
+ * @see https://docs.opensearch.org/latest/api-reference/index-apis/update-settings/
+ * @see https://docs.opensearch.org/latest/api-reference/index-apis/alias/
+ */
 class IndexManager
 {
     /**
@@ -63,14 +69,11 @@ public function create(IndexBlueprint $index): self
             'index' => $index->name(),
         ];
 
-        $mapping = $index->mapping() === null ? [] : $index->mapping()->toArray();
-        $settings = $index->settings() === null ? [] : $index->settings()->toArray();
-
-        if (! empty($mapping)) {
+        if ($mapping = $index->mapping()?->toArray()) {
             $params['body']['mappings'] = $mapping;
         }
 
-        if (! empty($settings)) {
+        if ($settings = $index->settings()?->toArray()) {
             $params['body']['settings'] = $settings;
         }
 

src/Indices/Mapping.php

@@ -5,6 +5,9 @@
 use Closure;
 
 /**
+ * @see https://docs.opensearch.org/latest/field-types/
+ * @see https://docs.opensearch.org/latest/mappings/
+ *
  * @method $this alias(string $name, array|null $parameters = null)
  * @method $this binary(string $name, array|null $parameters = null)
  * @method $this boolean(string $name, array|null $parameters = null)

src/Indices/MappingProperties.php

@@ -6,6 +6,9 @@
 use Closure;
 
 /**
+ * @see https://docs.opensearch.org/latest/field-types/
+ * @see https://docs.opensearch.org/latest/mappings/
+ *
  * @method $this alias(string $name, array|null $parameters = null)
  * @method $this binary(string $name, array|null $parameters = null)
  * @method $this boolean(string $name, array|null $parameters = null)