Active
Project:
Drupal core
Version:
main
Component:
rest.module
Priority:
Normal
Category:
Plan
Assigned:
Unassigned
Reporter:
Created:
4 Oct 2017 at 11:29 UTC
Updated:
26 Aug 2022 at 15:09 UTC
Jump to comment: Most recent
Let's collect a list of information we don't expose yet, but might be helpful to build a partially decoupled admin UI:
- A list of all permissions #2947605: Add a user permissions resource Link
- A list of modules (enabled and disabled ones): Link
- Changing passwords: #2904451: Allow to change password through RPC endpoints through the reset password workflow
- Menu links: #2732283: Menus: ability to retrieve all menu links for a given menu, regardless of whether a menu link is defined in content/config/code / Menu Tree: https://github.com/jsdrupal/drupal-admin-ui/pull/23
- Code-based, not config-based provisioning of REST resources: #2822201: Allow contrib modules to deploy REST resources by creating routes, removing the need for config entities in that special case
- Conveying which fields can be edited: #2665602: Implement an API for REST clients to know which fields are editable
- #2919182: Web service to download private:// files
- #2771353: Support "auto-create" entity references by value (instead of by ID/UUID), just like tags are auto-created in the content creation UI
- #1869338: Support ETag + If-Match for PATCH requests to prevent concurrent updates
- #1916302: RFC 7807: "Problem Details for HTTP APIs" — serve REST error responses as application/problem+json
- #2947759: Simple configuration REST support
- State API - This would let you put a site in maintenance mode
- UserData - This is what stores whether the user contact form is enabled or not
- Cache rebuild
Comments
Comment #2
Anonymous (not verified) commentedPermissions really need care! Looks very interesting⭐
Comment #3
dawehnerDone.
I link to those examples, just to see how it could look like
Let's focus on the general meta issue here. Feel free to add issue on the repo itself ? Maybe we could also create dedicated subissues.
Comment #4
Anonymous (not verified) commentedMany thanks! I have edited my message to avoid unnecessary noise in META (sorry).
Comment #5
wim leersI looked at all existing feature request issues filed against
rest.moduleand added them here.Comment #6
dawehnerComment #7
wim leersComment #8
wim leersComment #9
wim leersComment #10
webchickComment #11
wim leersWhy tag this ? Because it blocks certain issues?
Comment #13
webchickUh. Good question, I can't remember. :D I think because it was related to the JavaScript Modernization initiative.
Comment #14
dawehnerI added an issue for a permissions resource: #2947605: Add a user permissions resource
Comment #15
dawehnerI added an issue about simple config support.
Comment #16
mrjmd commentedJust fixing a typo, nothing to see here.
Comment #17
gabesulliceOther things we might add:
Thoughts?
Comment #18
dawehner@gabesullice +1
Let's collect things in the issue summary
Comment #19
gabesulliceComment #20
dawehnerWe might need a way to expose the menu tree for the admin toolbar: https://github.com/jsdrupal/drupal-admin-ui/pull/23 shows an example of how this could look like.
Comment #21
gabesulliceWhat about
hook_helpcontent?Comment #22
gabesulliceFor those interested in implementing non-RESTful APIs for core Drupal services (like clearing cache, rebuilding the router, enabling maintenance mode etc), I'd like to encourage you to submit patches to the JSON-RPC module. Specifically, please take a look at the
jsonrpc_coresubmodule and implement service plugins there.Comment #23
rogierbom commentedI've created an issue in the JSON RPC issue queue for adding the maintenance page method: https://www.drupal.org/project/jsonrpc/issues/2983907
Comment #26
dshumaker commentedWould it be safe to say that in terms of site maintenance and missing apis, that everything drush does should be converted to a rest api? Thus paving the way for drush to make it into core and sort of merge with drupal console. This eventually would essentially make drush & console a just rest script runner (a fancy postman). I'm thinking drupal could (should) have an rest api right out of the box that looks something like https://cloudapi-docs.acquia.com/ (ie. swagger formatted)..
Comment #27
gabesullice@dshumaker, I think we're on the same page. I don't want to make a statement about how the Drush or Drupal Console projects should evolve, but I'm really excited about the idea that Drupal could have an API that supports remote administration over HTTP. That's be essential for a decoupled admin UI, but also fleet management of large Drupal deployments (like many universities have) and new developer tooling.
Comment #28
geerlingguy commented@gabesullice - That's a really good point. If Drupal could be administered via HTTP (much like most any 'cloud native' app), it would make it a lot easier to deploy and manage in environments using Docker and/or Kubernetes (and similar tech) since you wouldn't need to wire up sidecar containers or supplementary containers just to do things like run cron, clear caches, change a setting, run an upgrade, etc.
Comment #29
e0ipso@dshumaker @geerlingguy, we have been toying with the idea to create JSON-RPC commands from the drush 9 annotated commands. We would prefer to have it the other way around, where we craft the HTTP tool (with its access checks, authentication, …) and the CLI tools are a wrapper on top of them. However we understand that the drush team is far ahead of us and their agenda may be different.
Maybe we could have some (more) of those critical JSON-RPC commands listed here and start modestly from those.
Comment #30
gabesullice@geerlingguy: that's just the kind of new thinking that makes me most excited about this issue/idea :)
@e0ipso, I already started that list in the JSON-RPC issue queue :D
#3073669: [META] Add methods to perform common core administrative actions
Comment #37
jasonawantDo task links provided by LocalTaskManager class need to be provided as a separate API or are these links provided somewhere else?