Contrib.social

Add parameter description

Open on Drupal.org →
Created on 28 February 2020, over 4 years ago
Updated 15 May 2024, 6 months ago

looking at: https://www.drupal.org/project/openapi/issues/2894623 → , suggested a way to add description to parameters.
Resources are expected to implement getPluginDefinition with 're_annotation' of the resource parameters.

public function getPluginDefinition() {
    return NestedArray::mergeDeep(
      parent::getPluginDefinition(),
      ['re_annotation' => [
        "GET" => [
          "id" => 'ID of the resource',
        ],
        "PUT" => [
          "id" => 'An array with the payload',
        ],
      ]]
    );
  }
✨ Feature request
Status

Needs review

Version

2.0

Component

Code

Created by

🇺🇸United States alianov

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Merge Requests

Comments & Activities

Not all content is available!

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

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024