Skip to content

Conversation

@sammygrey
Copy link
Contributor

@sammygrey sammygrey commented Feb 25, 2025

Changes

Added/removed/moved a ton of things for GetProductInfo():

  • Moved product id to product section.
  • Moved IconImageAssetId to asset section.
  • Removed gamepass/dev products section (these fields apply to all products and assets not just gamepasses/dev products).
  • Added seperate table for collectibles information with the appropriate fields.
  • Moved sale location information to seperate table with more information.
  • Fixed typos where "times" was instead typed as "items".
  • Added TargetId to product section which wasn't present for some reason.

With all this the page should now be consistent with the result of MarketplaceService:GetProductInfo():

image

Credit to @Valkenheim for a devforum post regarding the inconsistencies on this page, but this page was kind of a mess all around.

Checks

By submitting your pull request for review, you agree to the following:

  • This contribution was created in whole or in part by me, and I have the right to submit it under the terms of this repository's open source licenses.
  • I understand and agree that this contribution and a record of it are public, maintained indefinitely, and may be redistributed under the terms of this repository's open source licenses.
  • To the best of my knowledge, all proposed changes are accurate.

Added/removed/moved a ton of things:
moved product id to product section

moved IconImageAssetId to asset section

removed gamepass/dev products section (these items apply to all products and assets not just gamepasses/dev products)

added seperate table for collectibles information with the appropriate fields

moved sale location information to seperate table with more information

fixed typos where "times" was instead typed as "items".

Added TargetId to product section which wasn't present for some reason
@sammygrey sammygrey requested a review from a team as a code owner February 25, 2025 21:41
@github-actions github-actions bot added the engine reference Changes the Engine API Reference documentation label Feb 25, 2025
@IgnisRBX
Copy link
Contributor

IgnisRBX commented Feb 26, 2025

For a few additions in the tables, you have a row with the note "(see following lines)" to indicate the fields within that table. But since the parent table name isn't prefixed onto any following lines, it's not clear which of the following lines are members of that table vs. the overall parent dictionary that's returned. Could you please specify which are members of tables as was done for the Creator table and its various members?

@sammygrey
Copy link
Contributor Author

For a few additions in the tables, you have a row with the note "(see following lines)" to indicate the fields within that table. But since the parent table name isn't prefixed onto any following lines, it's not clear which of the following lines are members of that table vs. the overall parent dictionary that's returned. Could you please specify which are members of tables as was done for the Creator table and its various members?

I made sure that all of the lines below the line with (see following lines) are parented to the table above. I see how this can be confusing so I'll change it. I just copied this formatting from the original page where a table field is described.

@sammygrey
Copy link
Contributor Author

Fixed that issue, also noticed that the output I provided as an example had the subtables collapsed so here is a screenshot with them open:

image

@IgnisRBX
Copy link
Contributor

I did a bit more formatting, opting to "indent" the fields that are part of a dictionary table. Could you quickly check again that everything looks accurate? Thanks!

@sammygrey
Copy link
Contributor Author

I did a bit more formatting, opting to "indent" the fields that are part of a dictionary table. Could you quickly check again that everything looks accurate? Thanks!

Looks good to me, although my preview doesn't show the exact format that the docs would have. There is some questionability between how the terms "item", "product", and "asset" are used both interchangeably and mutually exclusive, but I believe this is a problem outside the scope of just documentation.

@IgnisRBX IgnisRBX merged commit 0655124 into Roblox:main Feb 28, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

engine reference Changes the Engine API Reference documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants