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

Properly distinguish list-item and get-item routes in Application Passwords reference #148

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

2704jakob
Copy link

I'm new to contributing so please tell me, if I did something wrong.
In the Application Passwords reference were 2 duplicates.
Retrieve and Delete. The first retrieve and delete missed the / at the end of the example.
And after the Schema Section was a stry which I removed aswell.

@kadamwhite
Copy link
Contributor

The /reference/ folder is auto-generated from the code, so removing these from the generated markdown will not be a permanent change. Thanks for calling out the duplication -- we'll need to look at the templating for these reference files to see if we can protect against this issue.

@kadamwhite kadamwhite added the /reference/ An issue with the schema-derived /reference/ documentation label Aug 31, 2023
@kadamwhite
Copy link
Contributor

kadamwhite commented Aug 31, 2023

@2704jakob I re-read the documentation, and realized what's going on: There are two separate routes contained in this reference page,

  • GET /wp/v2/users/<user_id>)/application-passwords
  • GET /wp/v2/users/<user_id>)/application-passwords/<uuid>

These are different routes, not a duplication. I agree it is very unclear what's going on, and think we actually have an issue with the list endpoint (the one without the ) being generated with the get-item template instead of the list-item template.

The first endpoint should read, "List Application Passwords". We'll look into why this is getting mis-paired.

@kadamwhite kadamwhite changed the title Removed duplicates from Application Passwords reference Properly distinguish list-item and get-item routes in Application Passwords reference Jan 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
/reference/ An issue with the schema-derived /reference/ documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants