search

PlayFab / PlayFabMultiplayerUnreal

PlayFab Online Subsystem Plugin for Unreal Engine
https://learn.microsoft.com/en-us/gaming/playfab/features/multiplayer/networking/party-unreal-engine-oss-overview
39 stars 35 forks source link

Docs show deprecated (even breaking) apis #27

Closed dylanh724 closed 5 months ago

dylanh724 commented 1 year ago

Your Unreal quickstart guide:

https://learn.microsoft.com/en-us/gaming/playfab/sdks/unreal/quickstart

Demos in the UE4 Quickstart docs use the Client/ API call line, starting with Auth (well -- only Auth. You guys desperately could use more Unreal samples, but I digress).

You can say they are "not deprecated unless marked" all you want, but it's been nearly 2 years and your Client/Matchmaking call from the Unreal SDK (and likely other SDKs) is 100% broken since the req'd param includes GameMode that can no longer be configured, resulting in infinite "game mode not found" errors. Since you already publicly have replacements under /Multiplayer, this is the definition of deprecating old modules since there's less support for the older ones and they are going away in favor of the newer ones.

  1. Update your API docs: Mark either deprecated or obsolete and link to the new one. Obsolete for at least Matchmaking. I only tested 3 Client/ implementations and if 1:3 are obsolete/broken, that's a high probability others are, too.
  2. Update your Unreal quickstart guide.
  3. Update your sdk inline docs and mark deprecation attributes/macros.

Not even staff seem to be aware of what's going on between v1/v2 and your users are confused. No one seems to even be aware that Client/Matchmake is even broken and has likely been broken for 1.5 years (assuming the majority of your Unreal users have Legacy accounts that can still access the old calls; hence the lack of reports). Since it's been nearly 2 years and at least one of your Apis within your SDK(s) are completely broken and others are "not deprecated but with replacements that have existed for almost 2 years" , I would go as far as calling it negligence, costing your users time, money and confusion.

Folks, please -- at minimum, please update all the Client/Matchmaking docs/sdks since they literally do not work anymore unless you have a legacy account.

nassosterz-ms commented 1 year ago

Thank you for reporting that, once the doc page is updated we will close this issue!

dylanh724 commented 1 year ago

Thank you for reporting that, once the doc page is updated we will close this issue!

Thank you - Both the Api docs and the Unreal quickstart guide for the online docs (possibly other SDK quickstarts, too, if they introduce the Client line of API calls instead of Multiplayer), please. The quickstart guides become the initial architecture and template for the entire schema. If you start them off on the wrong path from the beginning, this sets your users up for failure.

Please don't forget the inline docs, too:

  1. Update your sdk inline docs and mark deprecation attributes/macros

Some people familiar with the schema may not need to look at the docs and only use inline: Please also update the inline SDK docs and mark with the proper deprecated flags. There should be 0 confusion from any perspective.

nassosterz-ms commented 1 year ago

I wanted to provide an update, that the team responsible for these APIs / documentation has been informed and is working on fixing these docs. I will keep the issue open until the update occurs and is published.

yuehanlin commented 5 months ago

The document has been updated and can be found at https://learn.microsoft.com/en-us/gaming/playfab/features/multiplayer/matchmaking/quickstart#:~:text=Note,Quickstart%20%2D%20Client%20SDK. Therefore, I'm going to close this thread.