Add OpenSearch documentation links

Author: stevebauman

src/Documents/DocumentManagerInterface.php

@@ -14,6 +14,8 @@ interface DocumentManagerInterface
     /**
      * Index the given documents into OpenSearch.
      *
+     * @see https://docs.opensearch.org/latest/api-reference/document-apis/bulk/
+     *
      * @param  array<int, Document>  $documents
      *
      * @throws BulkRequestException
@@ -23,6 +25,8 @@ public function index(string $index, array $documents, bool $refresh = false, ?D
     /**
      * Delete the given documents from OpenSearch.
      *
+     * @see https://docs.opensearch.org/latest/api-reference/document-apis/bulk/
+     *
      * @param  array<int, string>  $ids
      *
      * @throws BulkRequestException
@@ -32,12 +36,16 @@ public function delete(string $index, array $ids, bool $refresh = false, ?Docume
     /**
      * Delete documents that match the given OpenSearch query.
      *
+     * @see https://docs.opensearch.org/latest/api-reference/document-apis/delete-by-query/
+     *
      * @param  array<string, mixed>  $query
      */
     public function deleteByQuery(string $index, array $query, bool $refresh = false): static;
 
     /**
      * Search an index using the given search request.
+     *
+     * @see https://docs.opensearch.org/latest/api-reference/search-apis/search/
      */
     public function search(string $index, SearchRequest $request): SearchResponse;
 }

src/Indices/IndexManagerInterface.php

@@ -9,53 +9,73 @@ interface IndexManagerInterface
 {
     /**
      * Open the given index.
+     *
+     * @see https://docs.opensearch.org/latest/api-reference/index-apis/open-index/
      */
     public function open(string $index): static;
 
     /**
      * Close the given index.
+     *
+     * @see https://docs.opensearch.org/latest/api-reference/index-apis/close-index/
      */
     public function close(string $index): static;
 
     /**
      * Determine if the given index exists.
+     *
+     * @see https://docs.opensearch.org/latest/api-reference/index-apis/exists/
      */
     public function exists(string $index): bool;
 
     /**
      * Create an index from the given blueprint.
+     *
+     * @see https://docs.opensearch.org/latest/api-reference/index-apis/create-index/
      */
     public function create(IndexBlueprint $index): static;
 
     /**
      * Update the mapping for the given index.
+     *
+     * @see https://docs.opensearch.org/latest/api-reference/index-apis/put-mapping/
      */
     public function putMapping(string $index, Mapping $mapping): static;
 
     /**
      * Update the settings for the given index.
+     *
+     * @see https://docs.opensearch.org/latest/api-reference/index-apis/update-settings/
      */
     public function putSettings(string $index, Settings $settings): static;
 
     /**
      * Delete the given index.
+     *
+     * @see https://docs.opensearch.org/latest/api-reference/index-apis/delete-index/
      */
     public function delete(string $index): static;
 
     /**
      * Get the aliases for the given index.
      *
+     * @see https://docs.opensearch.org/latest/api-reference/index-apis/alias/
+     *
      * @return array<string, Alias>
      */
     public function getAliases(string $index): array;
 
     /**
      * Create or update an alias for the given index.
+     *
+     * @see https://docs.opensearch.org/latest/api-reference/index-apis/alias/
      */
     public function putAlias(string $index, Alias $alias): static;
 
     /**
      * Delete the given alias from the index.
+     *
+     * @see https://docs.opensearch.org/latest/api-reference/index-apis/alias/
      */
     public function deleteAlias(string $index, string $aliasName): static;
 }

src/Indices/Mapping.php

@@ -121,7 +121,7 @@ public function byte(string $name, array $parameters = []): self
     /**
      * Add a completion field definition.
      *
-     * @see https://docs.opensearch.org/latest/mappings/supported-field-types/autocomplete/
+     * @see https://docs.opensearch.org/latest/mappings/supported-field-types/completion/
      *
      * @param  array<string, mixed>  $parameters
      */
@@ -135,7 +135,7 @@ public function completion(string $name, array $parameters = []): self
     /**
      * Add a constant keyword field definition.
      *
-     * @see https://docs.opensearch.org/latest/mappings/supported-field-types/string/
+     * @see https://docs.opensearch.org/latest/mappings/supported-field-types/keyword/
      *
      * @param  array<string, mixed>  $parameters
      */
@@ -555,7 +555,7 @@ public function scaledFloat(string $name, array $parameters = []): self
     /**
      * Add a search-as-you-type field definition.
      *
-     * @see https://docs.opensearch.org/latest/mappings/supported-field-types/autocomplete/
+     * @see https://docs.opensearch.org/latest/mappings/supported-field-types/search-as-you-type/
      *
      * @param  array<string, mixed>  $parameters
      */
@@ -625,7 +625,7 @@ public function sparseVector(string $name, array $parameters = []): self
     /**
      * Add a text field definition.
      *
-     * @see https://docs.opensearch.org/latest/mappings/supported-field-types/string/
+     * @see https://docs.opensearch.org/latest/mappings/supported-field-types/text/
      *
      * @param  array<string, mixed>  $parameters
      */
@@ -639,7 +639,7 @@ public function text(string $name, array $parameters = []): self
     /**
      * Add a token count field definition.
      *
-     * @see https://docs.opensearch.org/latest/mappings/supported-field-types/string/
+     * @see https://docs.opensearch.org/latest/mappings/supported-field-types/token-count/
      *
      * @param  array<string, mixed>  $parameters
      */
@@ -653,7 +653,7 @@ public function tokenCount(string $name, array $parameters = []): self
     /**
      * Add a wildcard field definition.
      *
-     * @see https://docs.opensearch.org/latest/mappings/supported-field-types/string/
+     * @see https://docs.opensearch.org/latest/mappings/supported-field-types/wildcard/
      *
      * @param  array<string, mixed>  $parameters
      */