Class: A2A::APIKeySecurityScheme

Inherits:

SecuritySchemeBase

• Object
• Dry::Struct
• ProtocolStruct
• SecuritySchemeBase
• A2A::APIKeySecurityScheme

Defined in:

lib/a2a/types/api_key_security_scheme.rb

Overview

Defines a security scheme using an API key.

Instance Method Summary

• #in ⇒ String

  The location of the API key.

• #name ⇒ String

  The name of the header, query, or cookie parameter to be used.

• #type ⇒ String

  The type of the security scheme.

Methods inherited from SecuritySchemeBase

#description

Methods included from Extensions::CaseTransformation

#camelize, included, #to_json

Instance Method Details

#in ⇒ String

Returns The location of the API key.

Returns:

• (String) —

  The location of the API key.

# File 'lib/a2a/types/api_key_security_scheme.rb', line 10

attribute :in, Types::String.enum('query', 'header', 'cookie')

#name ⇒ String

Returns The name of the header, query, or cookie parameter to be used.

Returns:

• (String) —

  The name of the header, query, or cookie parameter to be used.

# File 'lib/a2a/types/api_key_security_scheme.rb', line 13

attribute :name, Types::String

#type ⇒ String

Returns The type of the security scheme. Must be ‘apiKey’.

Returns:

• (String) —

  The type of the security scheme. Must be ‘apiKey’.

# File 'lib/a2a/types/api_key_security_scheme.rb', line 7

attribute :type, Types::String.constant('apiKey')