Skip to content

Commit 6b11e4e

Browse files
szabosteveszabosteve
authored
Merge pull request #1140 from szabosteve/7.x.drs.release.notes
[7.x] [DOCS] Adds Release notes section to PHP book
2 parents a1b2723 + 37b944e commit 6b11e4e

File tree

2 files changed

+359
-0
lines changed

2 files changed

+359
-0
lines changed

‎docs/index.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,6 @@ include::build/classes.asciidoc[]
1717

1818
include::helpers.asciidoc[]
1919

20+
include::release-notes.asciidoc[]
21+
2022
include::redirects.asciidoc[]

‎docs/release-notes.asciidoc

Lines changed: 357 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,357 @@
1+
[[release-notes]]
2+
== Release notes
3+
4+
* <<rn-7-12-0>>
5+
* <<rn-7-11-0>>
6+
* <<rn-7-10-0>>
7+
* <<rn-7-9-1>>
8+
* <<rn-7-9-0>>
9+
* <<rn-7-8-0>>
10+
* <<rn-7-7-0>>
11+
* <<rn-7-6-1>>
12+
* <<rn-7-6-0>>
13+
* <<rn-7-5-1>>
14+
* <<rn-7-5-0>>
15+
* <<rn-7-4-1>>
16+
* <<rn-7-4-0>>
17+
* <<rn-7-3-0>>
18+
* <<rn-7-2-2>>
19+
* <<rn-7-2-1>>
20+
* <<rn-7-2-0>>
21+
* <<rn-7-1-1>>
22+
* <<rn-7-1-0>>
23+
* <<rn-7-0-2>>
24+
* <<rn-7-0-1>>
25+
* <<rn-7-0-0>>
26+
27+
28+
[discrete]
29+
[[rn-7-12-0]]
30+
=== 7.12.0
31+
32+
* Updated the endpoints for ES 7.12 + removed `cpliakas/git-wrapper` in favor of
33+
`symplify/git-wrapper`
34+
https://github.com/elastic/elasticsearch-php/commit/136d5b9717b3806c6b34ef8a5076bfe7cee8b46e[136d5b9]
35+
* Fixed warning header as array in YAML tests generator
36+
https://github.com/elastic/elasticsearch-php/commit/0d81be131bfc7eff6ef82468e61c16077a892aab[0d81be1]
37+
* Refactored TEST_SUITE with free, platinum + removed old YamlRunnerTest
38+
https://github.com/elastic/elasticsearch-php/commit/f69d96fc283580177002b4088c279c3d0c07befe[f69d96f]
39+
40+
41+
[discrete]
42+
[[rn-7-11-0]]
43+
=== 7.11.0
44+
45+
* Added the `X-Elastic-Client-Meta` header which is used by Elastic Cloud and
46+
can be disabled with `ClientBuilder::setElasticMetaHeader(false)`
47+
https://github.com/elastic/elasticsearch-php/pull/1089[#1089]
48+
* Replaced `array_walk` with `array_map` in `Connection::getURI` for PHP 8
49+
compatibility
50+
https://github.com/elastic/elasticsearch-php/pull/1075[#1075]
51+
* Remove unnecessary `InvalidArgumentExceptions`
52+
https://github.com/elastic/elasticsearch-php/pull/1069[#1069]
53+
* Introducing PHP 8 compatibility
54+
https://github.com/elastic/elasticsearch-php/pull/1063[#1063]
55+
* Replace Sami by Doctum and fix `.gitignore`
56+
https://github.com/elastic/elasticsearch-php/pull/1062[#1062]
57+
58+
59+
[discrete]
60+
[[rn-7-10-0]]
61+
=== 7.10.0
62+
63+
* Updated endpoints and namespaces for {es} 7.10
64+
https://github.com/elastic/elasticsearch-php/commit/3ceb7484a111aa20126168460c79f098c4fe0792[3ceb748]
65+
* Fixed ClientBuilder::fromConfig allowing multiple function parameters (for
66+
example, `setApiKey`)
67+
https://github.com/elastic/elasticsearch-php/pull/1076[#1076]
68+
* Refactored the YAML tests using generated PHPUnit code
69+
[85fadc2](https://github.com/elastic/elasticsearch-php/commit/85fadc2bd4b2b309b19761a50ff13010d43a524d)
70+
71+
72+
[discrete]
73+
[[rn-7-9-1]]
74+
=== 7.9.1
75+
76+
* Fixed using object instead of array in onFailure transport event
77+
https://github.com/elastic/elasticsearch-php/pull/1066[#1066]
78+
* Fixed reset custom header after endpoint call
79+
https://github.com/elastic/elasticsearch-php/pull/1065[#1065]
80+
* Show generic error messages when server returns no response
81+
https://github.com/elastic/elasticsearch-php/pull/1056[#1056]
82+
83+
84+
[discrete]
85+
[[rn-7-9-0]]
86+
=== 7.9.0
87+
88+
* Updated endpoints and namespaces for {es} 7.9
89+
https://github.com/elastic/elasticsearch-php/commit/28bf0ed6df6bc95f83f369509431d97907bfdeb0[28bf0ed]
90+
* Moved `scroll_id` into `body` for search operations in the documentation
91+
https://github.com/elastic/elasticsearch-php/pull/1052[#1052]
92+
* Fixed PHP 7.4 preloading feature for autoload.php
93+
https://github.com/elastic/elasticsearch-php/pull/1051[#1051]
94+
* Improved message of JSON errors using `json_last_error_msg()`
95+
https://github.com/elastic/elasticsearch-php/pull/1045[#1045]
96+
97+
98+
[discrete]
99+
[[rn-7-8-0]]
100+
=== 7.8.0
101+
102+
* Updated endpoints and namespaces for {es} 7.8
103+
https://github.com/elastic/elasticsearch-php/commit/f2a0828d5ee9d126ad63e2a1d43f70b4013845e2[f2a0828]
104+
* Improved documentation
105+
https://github.com/elastic/elasticsearch-php/pull/1038[#1038],
106+
https://github.com/elastic/elasticsearch-php/pull/1027[#1027],
107+
https://github.com/elastic/elasticsearch-php/pull/1025[#1025]
108+
109+
110+
[discrete]
111+
[[rn-7-7-0]]
112+
=== 7.7.0
113+
114+
* Removed setId() into endpoints, fixed `util/GenerateEndpoints.php`
115+
https://github.com/elastic/elasticsearch-php/pull/1026[#1026]
116+
* Fixes JsonErrorException with code instead of message
117+
https://github.com/elastic/elasticsearch-php/pull/1022[#1022]
118+
* Better exception message for Could not parse URI
119+
https://github.com/elastic/elasticsearch-php/pull/1016[#1016]
120+
* Added JUnit log for PHPUnit
121+
https://github.com/elastic/elasticsearch-php/commit/88b7e1ce80a5a52c1d64d00c55fef77097bbd8a9[88b7e1c]
122+
* Added the XPack endpoints
123+
https://github.com/elastic/elasticsearch-php/commit/763d91a3d506075316b84a38b2bed7a098da5028[763d91a]
124+
125+
126+
127+
[discrete]
128+
[[rn-7-6-1]]
129+
=== 7.6.1
130+
131+
* Fixed issue with `guzzlehttp/ringphp` and `guzzle/streams` using forks
132+
`ezimuel/ringphp` and `ezimuel/guzzlestreams`
133+
https://github.com/elastic/elasticsearch-php/commit/92a6a4adda5eafd1823c7c9c386e2c7e5e75cd08[92a6a4a]
134+
135+
136+
[discrete]
137+
[[rn-7-6-0]]
138+
=== 7.6.0
139+
140+
* Generated the new endpoints for {es} 7.6.0
141+
https://github.com/elastic/elasticsearch-php/commit/be31f317af704f333b43bbcc7c01ddc7c91ec6f8[be31f31]
142+
143+
144+
[discrete]
145+
[[rn-7-5-1]]
146+
=== 7.5.1
147+
148+
* Fixes port missing in log https://github.com/elastic/elasticsearch-php/issues/925[#925]
149+
https://github.com/elastic/elasticsearch-php/commit/125594b40d167ef1509b3ee49a3f93426390c426[75e0888]
150+
* Added `ClientBuilder::includePortInHostHeader()` to add the `port` in the
151+
`Host` header. This fixes https://github.com/elastic/elasticsearch-php/issues/993[#993].
152+
By default the `port` is not included in the `Host` header.
153+
https://github.com/elastic/elasticsearch-php/pull/997[#997]
154+
* Replace abandoned packages: ringphp, streams and phpstan-shim
155+
https://github.com/elastic/elasticsearch-php/pull/996[#996]
156+
* Fixed gzip compression when setting Cloud Id
157+
https://github.com/elastic/elasticsearch-php/pull/986[#986]
158+
159+
160+
[discrete]
161+
[[rn-7-5-0]]
162+
=== 7.5.0
163+
164+
* Fixed `Client::extractArgument` iterable casting to array; this allows passing
165+
a `Traversable` body for some endpoints (for example, Bulk, Msearch,
166+
MsearchTemplate)
167+
https://github.com/elastic/elasticsearch-php/pull/983[#983]
168+
* Fixed the Response Exception if the `reason` field is null
169+
https://github.com/elastic/elasticsearch-php/pull/980[#980]
170+
* Added support for PHP 7.4
171+
https://github.com/elastic/elasticsearch-php/pull/976[#976]
172+
173+
174+
[discrete]
175+
[[rn-7-4-1]]
176+
=== 7.4.1
177+
178+
* We added the suppress operator `@` for the deprecation messages
179+
`@trigger_error()`. With this approach, we don't break existing application
180+
that convert PHP errors in Exception (for example, using Laravel with issue
181+
https://github.com/babenkoivan/scout-elasticsearch-driver/issues/297[297])
182+
Using the `@` operator is still possible to intercept the deprecation message
183+
using a custom error handler.
184+
https://github.com/elastic/elasticsearch-php/pull/973[#973]
185+
* Add missing leading slash in the URL of put mapping endpoint
186+
https://github.com/elastic/elasticsearch-php/pull/970[#970]
187+
* Fix pre 7.2 endpoint class name with aliases + reapply fix #947. This PR
188+
solved the unexpected BC break introduce in 7.4.0 with the code
189+
generation tool
190+
https://github.com/elastic/elasticsearch-php/pull/968[#968]
191+
192+
193+
[discrete]
194+
[[rn-7-4-0]]
195+
=== 7.4.0
196+
197+
* Added the code generation for endpoints and namespaces based on the
198+
https://github.com/elastic/elasticsearch/tree/v7.4.2/rest-api-spec/src/main/resources/rest-api-spec/api[REST API specification]
199+
of {es}. This tool is available in `util/GenerateEndpoints.php`.
200+
https://github.com/elastic/elasticsearch-php/pull/966[#966]
201+
* Fixed the asciidoc
202+
https://www.elastic.co/guide/en/elasticsearch/client/php-api/current/ElasticsearchPHP_Endpoints.html[endpoints documentation]
203+
based on the code generation using https://github.com/FriendsOfPHP/Sami[Sami]
204+
project https://github.com/elastic/elasticsearch-php/pull/966[#966]
205+
* All the `experimental` and `beta` APIs are now signed with a `@note` tag in
206+
the phpdoc section (for example,
207+
https://github.com/elastic/elasticsearch-php/blob/master/src/Elasticsearch/Client.php[$client->rankEval()]).
208+
For more information read the
209+
https://www.elastic.co/guide/en/elasticsearch/client/php-api/master/experimental_and_beta_apis.html[experimental and beta APIs]
210+
section in the documentation.
211+
https://github.com/elastic/elasticsearch-php/pull/966[#966]
212+
* Removed `AlreadyExpiredException` since it has been removed
213+
from {es} with https://github.com/elastic/elasticsearch/pull/24857[#24857]
214+
https://github.com/elastic/elasticsearch-php/pull/954[#954]
215+
216+
217+
[discrete]
218+
[[rn-7-3-0]]
219+
=== 7.3.0
220+
221+
* Added support for simplified access to the `X-Opaque-Id` header
222+
https://github.com/elastic/elasticsearch-php/pull/952[#952]
223+
* Added the HTTP port in the log messages
224+
https://github.com/elastic/elasticsearch-php/pull/950[#950]
225+
* Fixed hostname with underscore (ClientBuilder::prependMissingScheme)
226+
https://github.com/elastic/elasticsearch-php/pull/949[#949]
227+
* Removed unused Monolog in ClientBuilder
228+
https://github.com/elastic/elasticsearch-php/pull/948[#948]
229+
230+
231+
[discrete]
232+
[[rn-7-2-2]]
233+
=== 7.2.2
234+
235+
* Reintroduced the optional parameter in
236+
`Elasticsearch\Namespaces\IndicesNamespace::getAliases()`.
237+
This fixes the BC break introduced in 7.2.0 and 7.2.1.
238+
https://github.com/elastic/elasticsearch-php/pull/947[#947]
239+
240+
241+
[discrete]
242+
[[rn-7-2-1]]
243+
=== 7.2.1
244+
245+
* Reintroduced `Elasticsearch\Namespaces\IndicesNamespace::getAliases()` as proxy
246+
to `IndicesNamespace::getAlias()` to prevent BC breaks. The `getAliases()` is
247+
marked as deprecated and it will be removed from `elasticsearch-php 8.0`
248+
https://github.com/elastic/elasticsearch-php/pull/943[#943]
249+
250+
[discrete]
251+
==== Docs
252+
253+
* Fixed missing put mapping code snippet in code examples
254+
https://github.com/elastic/elasticsearch-php/pull/938[#938]
255+
256+
257+
[discrete]
258+
[[rn-7-2-0]]
259+
=== 7.2.0
260+
261+
* Updated the API endpoints for working with {es} 7.2.0:
262+
* added `wait_for_active_shards` parameter to `indices.close` API;
263+
* added `expand_wildcards` parameter to `cluster.health` API;
264+
* added include_unloaded_segments`, `expand_wildcards`, `forbid_closed_indices`
265+
parameters to `indices.stats` API.
266+
https://github.com/elastic/elasticsearch-php/pull/933/commits/27d721ba44b8c199388650c5a1c8bd69757229aa[27d721b]
267+
* Updated the phpdoc parameters for all the API endpoints
268+
https://github.com/elastic/elasticsearch-php/pull/933/commits/27d721ba44b8c199388650c5a1c8bd69757229aa[27d721b]
269+
* Improved the Travis CI speed using cache feature with composer
270+
https://github.com/elastic/elasticsearch-php/pull/929[#929]
271+
* Fixed `php_uname()` usage checking if it is disabled
272+
https://github.com/elastic/elasticsearch-php/pull/927[#927]
273+
* Added support of Elastic Cloud ID and API key authentication
274+
https://github.com/elastic/elasticsearch-php/pull/923[#923]
275+
276+
277+
[discrete]
278+
[[rn-7-1-1]]
279+
=== 7.1.1
280+
281+
* Fixed `ClientBuilder::setSSLVerification()` to accept string or boolean
282+
https://github.com/elastic/elasticsearch-php/pull/917[#917]
283+
* Fix type hinting for `setBody` in
284+
`Elasticsearch\Endpoints\Ingest\Pipeline\Put`
285+
https://github.com/elastic/elasticsearch-php/pull/913[#913]
286+
287+
288+
[discrete]
289+
[[rn-7-1-0]]
290+
=== 7.1.0
291+
292+
* Added warning log for {es} response containing the `Warning` header
293+
https://github.com/elastic/elasticsearch-php/pull/911[#911]
294+
* Fixed #838 hosting company is blocking ports because of `YamlRunnerTest.php`
295+
https://github.com/elastic/elasticsearch-php/pull/844[#844]
296+
* Specialized inheritance of `NoNodesAvailableException` to extend
297+
`ServerErrorResponseException` instead of the generic `\Exception`
298+
https://github.com/elastic/elasticsearch-php/pull/607[#607]
299+
* Fixed scroll TTL is extracted but not set as a body param
300+
https://github.com/elastic/elasticsearch-php/pull/907[#907]
301+
302+
[discrete]
303+
==== Testing
304+
305+
* Improved the speed of integration tests removing snapshots delete from
306+
`YamlRunnerTest::clean`
307+
https://github.com/elastic/elasticsearch-php/pull/911[#911]
308+
* Reduced the number of skipping YAML integration tests from 20 to 6
309+
https://github.com/elastic/elasticsearch-php/pull/911[#911]
310+
311+
[discrete]
312+
==== Docs
313+
314+
* Documentation updated for {es} 7
315+
https://github.com/elastic/elasticsearch-php/pull/904[#904]
316+
317+
318+
[discrete]
319+
[[rn-7-0-2]]
320+
=== 7.0.2
321+
322+
* Fixed incorrect return type hint when using async requests/futures
323+
https://github.com/elastic/elasticsearch-php/pull/905[#905]
324+
325+
326+
[discrete]
327+
[[rn-7-0-1]]
328+
=== 7.0.1
329+
330+
* Fixed SniffingConnectionPool removing the return type of Connection::sniff()
331+
https://github.com/elastic/elasticsearch-php/pull/899[#899]
332+
333+
334+
[discrete]
335+
[[rn-7-0-0]]
336+
=== 7.0.0
337+
338+
* Requirement of PHP 7.1 instead of 7.0 that is not supported since 1 Jan 2019.
339+
https://github.com/elastic/elasticsearch-php/pull/897[#897]
340+
* Code refactoring using type hints and return type declarations where possible
341+
https://github.com/elastic/elasticsearch-php/pull/897[#897]
342+
* Update vendor libraries (PHPUnit 7.5, Symfony YAML 4.3, and so on)
343+
https://github.com/elastic/elasticsearch-php/pull/897[#897]
344+
* Updated all the API endpoints using the
345+
https://github.com/elastic/elasticsearch/tree/v7.0.0/rest-api-spec/src/main/resources/rest-api-spec/api[latest 7.0.0 specs]
346+
of {es} https://github.com/elastic/elasticsearch-php/pull/897[#897]
347+
* Added the `User-Agent` in each HTTP request
348+
https://github.com/elastic/elasticsearch-php/pull/898[#898]
349+
* Simplified the logging methods
350+
`logRequestFail($request, $response, $exception)` and
351+
`logRequestSuccess($request, $response)` in
352+
`Elasticsearch\Connections\Connection`
353+
https://github.com/elastic/elasticsearch-php/pull/876[#876]
354+
* Fix `json_encode` for unicode(emoji) characters
355+
https://github.com/elastic/elasticsearch-php/pull/856[#856]
356+
* Fix HTTP port specification using CURLOPT_PORT, not anymore in the host
357+
https://github.com/elastic/elasticsearch-php/pull/782[#782]

0 commit comments

Comments
 (0)