org.eclipse.microprofile.openapi.models.security

Interface Scopes

All Superinterfaces:

Constructible, Extensible, Map<String,String>

public interface Scopes
extends Constructible, Extensible, Map<String,String>

Scopes is a property of OAuth Flow Object.

See Also:

OAuthFlow Object

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Method Summary

Modifier and Type	Method and Description
Scopes	addScope(String scope, String description) Adds name of an existing scope object and item parameters to a Scopes instance as a key-value pair in a map.

Methods inherited from interface org.eclipse.microprofile.openapi.models.Extensible

addExtension, getExtensions, setExtensions

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Method Detail

addScope

Scopes addScope(String scope,
                String description)

Adds name of an existing scope object and item parameters to a Scopes instance as a key-value pair in a map.

Parameters:

scope - the name of a scope

description - description of the scope

Returns:

Scopes instance with the added key-value pair