Skip to content

Commit

Permalink
Updated opensearch-php to reflect the latest OpenSearch API spec (202…
Browse files Browse the repository at this point in the history
…4-10-24)

Signed-off-by: GitHub <[email protected]>
  • Loading branch information
dblock authored Oct 24, 2024
1 parent 3da6b1d commit caccec0
Show file tree
Hide file tree
Showing 71 changed files with 3,466 additions and 451 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
### Fixed
- Fixed PHP 8.4 deprecations
### Updated APIs
- Updated opensearch-php APIs to reflect [opensearch-api-specification@abc7163](https://github.com/opensearch-project/opensearch-api-specification/commit/abc7163185733c1008fb7c28117cf36c051f3292)
- Updated opensearch-php APIs to reflect [opensearch-api-specification@cb320b5](https://github.com/opensearch-project/opensearch-api-specification/commit/cb320b5482551c4f28afa26ff0d1653332699722)
### Security
### Dependencies
Expand Down
286 changes: 190 additions & 96 deletions src/OpenSearch/Client.php

Large diffs are not rendered by default.

52 changes: 52 additions & 0 deletions src/OpenSearch/Endpoints/AsynchronousSearch/Delete.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
<?php

declare(strict_types=1);

/**
* SPDX-License-Identifier: Apache-2.0
*
* The OpenSearch Contributors require contributions made to
* this file be licensed under the Apache-2.0 license or a
* compatible open source license.
*
* Modifications Copyright OpenSearch Contributors. See
* GitHub history for details.
*/

namespace OpenSearch\Endpoints\AsynchronousSearch;

use OpenSearch\Common\Exceptions\RuntimeException;
use OpenSearch\Endpoints\AbstractEndpoint;

/**
* NOTE: This file is autogenerated using util/GenerateEndpoints.php
*/
class Delete extends AbstractEndpoint
{
public function getURI(): string
{
if (isset($this->id) !== true) {
throw new RuntimeException(
'id is required for delete'
);
}
$id = $this->id;
return "/_plugins/_asynchronous_search/$id";
}

public function getParamWhitelist(): array
{
return [
'pretty',
'human',
'error_trace',
'source',
'filter_path'
];
}

public function getMethod(): string
{
return 'DELETE';
}
}
52 changes: 52 additions & 0 deletions src/OpenSearch/Endpoints/AsynchronousSearch/Get.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
<?php

declare(strict_types=1);

/**
* SPDX-License-Identifier: Apache-2.0
*
* The OpenSearch Contributors require contributions made to
* this file be licensed under the Apache-2.0 license or a
* compatible open source license.
*
* Modifications Copyright OpenSearch Contributors. See
* GitHub history for details.
*/

namespace OpenSearch\Endpoints\AsynchronousSearch;

use OpenSearch\Common\Exceptions\RuntimeException;
use OpenSearch\Endpoints\AbstractEndpoint;

/**
* NOTE: This file is autogenerated using util/GenerateEndpoints.php
*/
class Get extends AbstractEndpoint
{
public function getURI(): string
{
if (isset($this->id) !== true) {
throw new RuntimeException(
'id is required for get'
);
}
$id = $this->id;
return "/_plugins/_asynchronous_search/$id";
}

public function getParamWhitelist(): array
{
return [
'pretty',
'human',
'error_trace',
'source',
'filter_path'
];
}

public function getMethod(): string
{
return 'GET';
}
}
59 changes: 59 additions & 0 deletions src/OpenSearch/Endpoints/AsynchronousSearch/Search.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
<?php

declare(strict_types=1);

/**
* SPDX-License-Identifier: Apache-2.0
*
* The OpenSearch Contributors require contributions made to
* this file be licensed under the Apache-2.0 license or a
* compatible open source license.
*
* Modifications Copyright OpenSearch Contributors. See
* GitHub history for details.
*/

namespace OpenSearch\Endpoints\AsynchronousSearch;

use OpenSearch\Endpoints\AbstractEndpoint;

/**
* NOTE: This file is autogenerated using util/GenerateEndpoints.php
*/
class Search extends AbstractEndpoint
{
public function getURI(): string
{
return "/_plugins/_asynchronous_search";
}

public function getParamWhitelist(): array
{
return [
'index',
'keep_alive',
'keep_on_completion',
'wait_for_completion_timeout',
'pretty',
'human',
'error_trace',
'source',
'filter_path'
];
}

public function getMethod(): string
{
return 'POST';
}

public function setBody($body): Search
{
if (isset($body) !== true) {
return $this;
}
$this->body = $body;

return $this;
}
}
45 changes: 45 additions & 0 deletions src/OpenSearch/Endpoints/AsynchronousSearch/Stats.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
<?php

declare(strict_types=1);

/**
* SPDX-License-Identifier: Apache-2.0
*
* The OpenSearch Contributors require contributions made to
* this file be licensed under the Apache-2.0 license or a
* compatible open source license.
*
* Modifications Copyright OpenSearch Contributors. See
* GitHub history for details.
*/

namespace OpenSearch\Endpoints\AsynchronousSearch;

use OpenSearch\Endpoints\AbstractEndpoint;

/**
* NOTE: This file is autogenerated using util/GenerateEndpoints.php
*/
class Stats extends AbstractEndpoint
{
public function getURI(): string
{
return "/_plugins/_asynchronous_search/stats";
}

public function getParamWhitelist(): array
{
return [
'pretty',
'human',
'error_trace',
'source',
'filter_path'
];
}

public function getMethod(): string
{
return 'GET';
}
}
88 changes: 88 additions & 0 deletions src/OpenSearch/Endpoints/BulkStream.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
<?php

declare(strict_types=1);

/**
* SPDX-License-Identifier: Apache-2.0
*
* The OpenSearch Contributors require contributions made to
* this file be licensed under the Apache-2.0 license or a
* compatible open source license.
*
* Modifications Copyright OpenSearch Contributors. See
* GitHub history for details.
*/

namespace OpenSearch\Endpoints;

use OpenSearch\Common\Exceptions\InvalidArgumentException;
use OpenSearch\Endpoints\AbstractEndpoint;
use OpenSearch\Serializers\SerializerInterface;
use Traversable;

/**
* NOTE: This file is autogenerated using util/GenerateEndpoints.php
*/
class BulkStream extends AbstractEndpoint
{
public function __construct(SerializerInterface $serializer)
{
$this->serializer = $serializer;
}

public function getURI(): string
{
$index = $this->index ?? null;
if (isset($index)) {
return "/$index/_bulk/stream";
}
return "/_bulk/stream";
}

public function getParamWhitelist(): array
{
return [
'_source',
'_source_excludes',
'_source_includes',
'batch_interval',
'batch_size',
'pipeline',
'refresh',
'require_alias',
'routing',
'timeout',
'wait_for_active_shards',
'pretty',
'human',
'error_trace',
'source',
'filter_path'
];
}

public function getMethod(): string
{
return 'PUT';
}

public function setBody($body): BulkStream
{
if (isset($body) !== true) {
return $this;
}
if (is_array($body) === true || $body instanceof Traversable) {
foreach ($body as $item) {
$this->body .= $this->serializer->serialize($item) . "\n";
}
} elseif (is_string($body)) {
$this->body = $body;
if (substr($body, -1) != "\n") {
$this->body .= "\n";
}
} else {
throw new InvalidArgumentException("Body must be an array, traversable object or string");
}
return $this;
}
}
10 changes: 10 additions & 0 deletions src/OpenSearch/Endpoints/Cluster/DeleteWeightedRouting.php
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,14 @@ public function getMethod(): string
{
return 'DELETE';
}

public function setBody($body): DeleteWeightedRouting
{
if (isset($body) !== true) {
return $this;
}
$this->body = $body;

return $this;
}
}
10 changes: 10 additions & 0 deletions src/OpenSearch/Endpoints/Cluster/PutWeightedRouting.php
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,16 @@ public function getMethod(): string
return 'PUT';
}

public function setBody($body): PutWeightedRouting
{
if (isset($body) !== true) {
return $this;
}
$this->body = $body;

return $this;
}

public function setAttribute($attribute): PutWeightedRouting
{
if (isset($attribute) !== true) {
Expand Down
Loading

0 comments on commit caccec0

Please sign in to comment.