Repository navigation
docs: document the 2.0.0 BC breaks - #54
Merged
Merged
Conversation
Add UPGRADE-2.0.md with a before/after migration note for every public API change since the last release (1.4), and CHANGELOG.md with the unreleased 2.0.0 entry. The README links both and shows the current callRequest() signature instead of an outdated one. Closes #53
pekral
marked this pull request as ready for review
November 12, 2026 14:45
Collaborator
Author
Code ReviewStatus: clean Summary: 0 Critical · 0 Moderate · 0 Minor · 0 Refactoring · assignment conformance: conformant (#53: UPGRADE-2.0.md covers every public API change since 1.4, CHANGELOG.md has the unreleased 2.0.0 entry, README links both) · reviewer comments: none |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #53
TL;DR
Dokumentace BC breaků pro verzi 2.0.0: návod pro přechod z 1.4 (
UPGRADE-2.0.md) a changelog (CHANGELOG.md, záznam 2.0.0 bez data). Release se dělá ručně, tento PR žádný tag ani release nevytváří.Změny
UPGRADE-2.0.md: každá změna veřejného API proti poslední vydané verzi 1.4 s ukázkou před/po:new Client(new Config(...))místo samostatných parametrů,$logFilePath→$debugMode,Methodjako nativní enum,SearchQueryOperator,CHANGELOG.md: BC breaky, novinky, opravy a závislosti. Mezi opravami jsou jen chyby, které byly ve vydané verzi 1.4. Chyby, které vznikly a opravily se mezi 1.4 a 2.0, tam nejsou.README.md: odkaz na oba soubory a aktuální signaturacallRequest()(původní ukázka měla tři parametry místo pěti).Ověření
Každé tvrzení jsem porovnal se zdrojovým kódem tagu
1.4(git show 1.4:…): konstruktorClient/Configs$logFilePath,MethodaSearchQueryOperatordědící zConsistence\Enum\Enum, vypnuté TLS přiauthSessionId,json_encode()bez výjimky, chybějící timeouty a nekódovaný název firmy v restore URL.Merge danger
Testování
composer checkprochází (bez změny kódu).