Try/consistent method arguments #196
Merged
Conversation
This file contains 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
Starting with the components endpoint: Arguments generated documentation by the Restsplain plugin about the EDITABLE method of the `BP_REST_Components_Endpoint` are not consistent with what is actually expected. It should be `name` and `action` instead of a subset of the item schema.
|
Just committed the patch on https://buddypress.trac.wordpress.org/ticket/8115 and re-ran the unit tests. There are now passing successfully. |
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.
Writing the documentation for the
BP_REST_Components_EndpointI've noticed that the arguments of the generated documentation by the Restsplain plugin about the EDITABLE method are not consistent with what is actually expected.It should be
nameandactioninstead of a subset of the item schema. See:https://imath-buddydocs.pf1.wpserveur.net/bp-rest-api-reference/endpoints/buddypress/v1/components/#PUT
NB: to ease WPCS testing I've also edited the composer.json file in the first commit, you can skip this commit if you think it's a bad idea ;)
NB 2 : The unit tests should error on Trunk, that's because of this:
https://buddypress.trac.wordpress.org/ticket/8115
@renatonascalves could you do a review of all the other endpoints to make sure arguments used in EDITABLE/CREATABLE/DELETABLE methods are consistent ?