REST resource plugin annotation class misses some properties

I'm working to create a Rest Resource where anonymous users can register user accounts.

For this resource there's no canonical path and when using Restui module the path is empty.So, can we add for example a "path" to "uri_paths" ?

Attached image with the expected result.

#1839346: REST module: POST/create and #2019123: Use the same canonical URI paths as for HTML routes should have updated the annotation class, but they did not.

In fact, the deriver (originally derivative) goes back to when this module was first created (#1816354: Add a REST module, starting with DELETE). When the concept of plugin type-specific annotations was added, it was simply forgotten in #2195571: Add a dedicated @RestResource annotation class.

It looks like annotations are not strict enough…

In fact:

1. deriver is something supported by \Drupal\Component\Plugin\Discovery\DerivativeDiscoveryDecorator, it does not belong in the annotation definition apparently. (Messy, but apparently that's the way it is intended.)
2. it looks like entity resources just abuse annotations's lack of validation to add a bunch things that REST module does not care about at all: id and entity_type.

Moving to plugin system to gather feedback.

This part is actually used by \Drupal\rest\RequestHandler::handle(), so at least this seems to belong on the annotation.

Completely new patch, #5 didn't apply anymore.

+++ b/core/modules/rest/src/Annotation/RestResource.php
@@ -41,8 +41,31 @@ class RestResource extends Plugin {
+   * @var string[]
...
+  public $uri_paths;

Should this default to an empty array?

That's probably better, yes.

+++ b/core/modules/rest/src/Annotation/RestResource.php
@@ -41,8 +41,31 @@ class RestResource extends Plugin {
+  /**
+   * The deriver class for this resource plugin, if any.
+   *
+   * @see \Drupal\Component\Plugin\Discovery\DerivativeDiscoveryDecorator::getDeriverClass()
+   *
+   * @var string|null
+   */
+  public $deriver;

Do we want this?

No other plugin annotation has this… (as I already pointed out in #4.1).

No other plugin annotation has this… (as I already pointed out in #4.1).

Seems unneeded then. We should that better add to the base class, IMHO.

Done.

index 790440d..3c78ede 100644
--- a/core/lib/Drupal/Component/Annotation/Plugin.php

--- a/core/lib/Drupal/Component/Annotation/Plugin.php
+++ b/core/lib/Drupal/Component/Annotation/Plugin.php

@@ -27,6 +27,15 @@ class Plugin implements AnnotationInterface {
   /**
+   * The deriver class for this resource plugin, if any.
+   *

Now the documentation ideally should make clear that there are plugin types which don't support deriver

1. +++ b/core/lib/Drupal/Component/Annotation/Plugin.php
   @@ -27,6 +27,15 @@ class Plugin implements AnnotationInterface {
   +   * The deriver class for this resource plugin, if any.
   

   "if any"

2. +++ b/core/lib/Drupal/Component/Annotation/Plugin.php
   @@ -27,6 +27,15 @@ class Plugin implements AnnotationInterface {
   +   * @var string|null
   

   string|null

Isn't this sufficiently clear?

Well, the question is, do we want to distinct between the case: Someone hasn't defined a deriver class in their annotation vs. the plugin type don't support them.

Okay, how about this: we don't deal with deriver at all here, it's out of scope for the REST module anyway :)

Okay, how about this: we don't deal with deriver at all here, it's out of scope for the REST module anyway :)

I 100% agree with that

Random fail in Drupal\Tests\inline_form_errors\FunctionalJavascript\FormErrorHandlerCKEditorTest.

Random CI infra fail.

The "new" uri_paths key was a bit puzzling to me but I see it is already being used on these resources:

core/modules/dblog/src/Plugin/rest/resource/DBLogResource.php: *   uri_paths = {
core/modules/rest/src/Plugin/rest/resource/EntityResource.php: *   uri_paths = {
core/modules/user/src/Plugin/rest/resource/UserRegistrationResource.php: *   uri_paths = {

So we are indeed just documenting what we already have. Thanks all!

Indeed :)

This tag is probably also relevant.