Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add upgrade guide to version 2.0 #86

Merged
merged 1 commit into from
Sep 4, 2018

Conversation

OndraM
Copy link
Member

@OndraM OndraM commented Aug 31, 2018

I believe this would help API Client users a lot and encourage them for upgrade.

But I'm not quite sure all the examples are valid, so @foglcz please review :).

Also any feedback from others is welcome.

UPGRADE-2.0.md Show resolved Hide resolved
UPGRADE-2.0.md Show resolved Hide resolved
@OndraM OndraM requested a review from jirinovak August 31, 2018 23:54
Copy link
Member

@jirinovak jirinovak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, it would be helpful.

UPGRADE-2.0.md Outdated

$recommendations = $response->getRecommendation()->getData();

// $recommendations now contains array of stdClasse with item_id and other requested properties (item_title in this example)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo stdClasses

@OndraM OndraM changed the title Add upgrade guide to version 2.0 [WIP] Add upgrade guide to version 2.0 Sep 4, 2018
Copy link
Contributor

@foglcz foglcz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, thanks! :)

@ghost
Copy link

ghost commented Sep 4, 2018

Fails
🚫

Backward incompatible changes detected

Backward incompatible changes introduced by this PR

  • [BC] The return type of Lmc\Matej\Model\Command\UserForget#getForgetMethod() changed from string to the non-covariant Lmc\Matej\Model\Command\Constants\UserForgetMethod
  • [BC] The return type of Lmc\Matej\Model\Command\UserForget#getForgetMethod() changed from string to Lmc\Matej\Model\Command\Constants\UserForgetMethod
  • [BC] The parameter $minimalRelevance of Lmc\Matej\Model\Command\UserRecommendation#setMinimalRelevance() changed from string to a non-contravariant Lmc\Matej\Model\Command\Constants\MinimalRelevance
  • [BC] The parameter $minimalRelevance of Lmc\Matej\Model\Command\UserRecommendation#setMinimalRelevance() changed from string to Lmc\Matej\Model\Command\Constants\MinimalRelevance
  • [BC] Constant Lmc\Matej\Model\Command\ItemPropertySetup::PROPERTY_TYPE_INT was removed
  • [BC] Constant Lmc\Matej\Model\Command\ItemPropertySetup::PROPERTY_TYPE_DOUBLE was removed
  • [BC] Constant Lmc\Matej\Model\Command\ItemPropertySetup::PROPERTY_TYPE_STRING was removed
  • [BC] Constant Lmc\Matej\Model\Command\ItemPropertySetup::PROPERTY_TYPE_BOOLEAN was removed
  • [BC] Constant Lmc\Matej\Model\Command\ItemPropertySetup::PROPERTY_TYPE_TIMESTAMP was removed
  • [BC] Constant Lmc\Matej\Model\Command\ItemPropertySetup::PROPERTY_TYPE_SET was removed
  • [BC] Constant Lmc\Matej\Model\Command\UserForget::ANONYMIZE was removed
  • [BC] Constant Lmc\Matej\Model\Command\UserForget::DELETE was removed
  • [BC] Method Lmc\Matej\Model\Command\UserForget#setForgetMethod() was removed
  • [BC] Constant Lmc\Matej\Model\Command\UserRecommendation::MINIMAL_RELEVANCE_LOW was removed
  • [BC] Constant Lmc\Matej\Model\Command\UserRecommendation::MINIMAL_RELEVANCE_MEDIUM was removed
  • [BC] Constant Lmc\Matej\Model\Command\UserRecommendation::MINIMAL_RELEVANCE_HIGH was removed

Generated by 🚫 dangerJS

@OndraM OndraM merged commit bd955c6 into lmc-eu:master Sep 4, 2018
@OndraM OndraM deleted the feature/upgrade-guide branch January 15, 2024 13:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants