Make JSONAPI documentation even better

Created on 14 February 2020, over 4 years ago
Updated 8 September 2023, 9 months ago

https://www.drupal.org/docs/8/modules/jsonapi/what-jsonapi-doesnt-do β†’ tells you how to log in with a user / password without basic auth.

The sub pages of https://www.drupal.org/docs/8/modules/jsonapi/get-post-patch-and-delete β†’ do not mention this. And, since they have the auth section three times instead of putting it there once I didn't want to go in and attempt to fix. Besides mentioning the existence, it should also be mentioned that curl -b needs to be used, just repeating the -c from the login example doesn't work.

The filtering section seems to imply the security is done by the querying party but it's not so, there's a lot of security going on (I didn't read the entire code but there's quite a bit) and when logged in as above then the results change. This needs to be documented, again with curl -b examples. Maybe just create an authentication page and link it from everywhere?

The documentation often mentions the Accept header but Accept header based routing got replaced by a query parameter β†’ . I haven't found any request that needed it. This probably needs to be removed.

https://gist.github.com/chx/4250d0bd1e760fda7870d167bff0c321 I wrote the user lifecycle up with complete examples. It seems to me the register endpoint should be in user instead of rest but I can't find an issue even discussing it. Since it requires a permission it would seem it should be easy to move it in a BC way.

πŸ“Œ Task
Status

Active

Version

11.0 πŸ”₯

Component
JSON APIΒ  β†’

Last updated 2 days ago

Created by

πŸ‡¨πŸ‡¦Canada Charlie ChX Negyesi 🍁Canada

Live updates comments and jobs are added and updated live.
  • Novice

    It would make a good project for someone who is new to the Drupal contribution process. It's preferred over Newbie.

  • Documentation

    Primarily changes documentation, not code. For Drupal core issues, select the Documentation component instead of using this tag. In general, component selection is preferred over tag selection.

Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

Production build 0.69.0 2024