You are here

public function OpenApiGeneratorInterface::getSecurityDefinitions in OpenAPI 8.2

Same name and namespace in other branches
  1. 8 src/Plugin/openapi/OpenApiGeneratorInterface.php \Drupal\openapi\Plugin\openapi\OpenApiGeneratorInterface::getSecurityDefinitions()

Get a list a valid security method definitions.

Returned schema should be similar to the below structure.

``` { "api_key": { "type": "apiKey", "name": "api_key", "in": "header" }, "petstore_auth": { "type": "oauth2", "authorizationUrl": "http://swagger.io/api/oauth/dialog", "flow": "implicit", "scopes": { "write:pets": "modify pets in your account", "read:pets": "read your pets" } } } ```

Return value

array Associative array of security definitions.

1 method overrides OpenApiGeneratorInterface::getSecurityDefinitions()
OpenApiGeneratorBase::getSecurityDefinitions in src/Plugin/openapi/OpenApiGeneratorBase.php
Get a list a valid security method definitions.

File

src/Plugin/openapi/OpenApiGeneratorInterface.php, line 92

Class

OpenApiGeneratorInterface
Defines OpenApiGeneratorInterface for OpenApi Generator Plugins.

Namespace

Drupal\openapi\Plugin\openapi

Code

public function getSecurityDefinitions();