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 product custom fields documentation #245

Merged
merged 5 commits into from
Jul 11, 2024

Conversation

octaedro
Copy link
Contributor

@octaedro octaedro commented Jul 4, 2024

Changes proposed in this Pull Request:

The WooCommerce PR woocommerce/woocommerce#48504 added a new REST API endpoint meant to get the product custom field names.

Closes woocommerce/woocommerce#46921

This PR adds the documentation necessary for that new endpoint.

How to test the changes in this Pull Request:

  1. Checkout this branch and build the project
sh build.sh
  1. After running the build process, you will see a build folder in your project.
  2. Go to the build folder and open the file ./index.html in your browser.
  3. Go to Product custom fields in the sidebar.
  4. Verify that the documentation looks correct.

@octaedro octaedro self-assigned this Jul 4, 2024
@octaedro octaedro requested review from mdperez86 and mattsherman July 4, 2024 18:54
Copy link
Contributor

@mdperez86 mdperez86 left a comment

Choose a reason for hiding this comment

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

I left some comments that can help improve the documentation a little bit.

Thanks for your hands on this @octaedro

@octaedro
Copy link
Contributor Author

Thank you @mdperez86 for the review. I just addressed your suggestions.
Could you take another look at this PR?

@octaedro octaedro requested a review from mdperez86 July 10, 2024 15:37
Copy link
Contributor

@mdperez86 mdperez86 left a comment

Choose a reason for hiding this comment

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

Thanks for addressing my suggestions! I left one more comment related to the parameters that the endpoint receives.

@octaedro octaedro requested a review from mdperez86 July 11, 2024 16:31
Copy link
Contributor

@mdperez86 mdperez86 left a comment

Choose a reason for hiding this comment

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

The parameters were updated correctly.
The documentation looks good.
Nice job @octaedro !

@mdperez86 mdperez86 merged commit a9e60e6 into trunk Jul 11, 2024
@mdperez86 mdperez86 deleted the add/46921_product_custom_fields_docs branch July 11, 2024 20:21
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.

[Custom fields] - Add REST API documentation
2 participants