Skip to content

Commit

Permalink
Auto-reformat changes from #525
Browse files Browse the repository at this point in the history
I forgot to allow the auto-formatter to run before submitting that PR
  • Loading branch information
Azquelt committed Apr 19, 2022
1 parent b4d990a commit 27c463c
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 22 deletions.
Expand Up @@ -69,8 +69,8 @@
/**
* A declaration of which security mechanisms can be used across the API.
* <p>
* Adding a {@code SecurityRequirement} to this array is equivalent to adding a {@code SecurityRequirementsSet} containing
* a single {@code SecurityRequirement} to {@link #securitySets()}.
* Adding a {@code SecurityRequirement} to this array is equivalent to adding a {@code SecurityRequirementsSet}
* containing a single {@code SecurityRequirement} to {@link #securitySets()}.
*
* @return the array of security requirements for this API
*/
Expand Down
Expand Up @@ -25,8 +25,8 @@
/**
* Container annotation for repeated {@link SecurityRequirement} annotations.
* <p>
* Note that <em>each</em> {@code SecurityRequirement} annotation is equivalent to a {@link SecurityRequirementsSet} annotation containing only that
* annotation.
* Note that <em>each</em> {@code SecurityRequirement} annotation is equivalent to a {@link SecurityRequirementsSet}
* annotation containing only that annotation.
*
* <pre>
* <b>Example:</b>
Expand Down
Expand Up @@ -26,18 +26,21 @@
import org.eclipse.microprofile.openapi.annotations.OpenAPIDefinition;

/**
* This annotation represents a set of security requirements which permit access to an operation if all of them are satisfied.
* This annotation represents a set of security requirements which permit access to an operation if all of them are
* satisfied.
* <p>
* If this annotation is applied to a method which corresponds to an operation, then the requirements will be added to that operation.
* If this annotation is applied to a method which corresponds to an operation, then the requirements will be added to
* that operation.
* <p>
* If this annotation is applied to a class which contains methods which correspond to operations, then the requirements will be added to all
* operations corresponding to methods within that class which don't specify any other requirements.
* If this annotation is applied to a class which contains methods which correspond to operations, then the requirements
* will be added to all operations corresponding to methods within that class which don't specify any other
* requirements.
* <p>
* Security requirements can be specified for the whole API using {@link OpenAPIDefinition#securitySets()}. Security requirements specified
* for individual operations override those specified for the whole API.
* Security requirements can be specified for the whole API using {@link OpenAPIDefinition#securitySets()}. Security
* requirements specified for individual operations override those specified for the whole API.
* <p>
* If multiple security requirement sets are specified for an operation, then a user must satisfy all of the requirements within any one of the sets
* to access the operation.
* If multiple security requirement sets are specified for an operation, then a user must satisfy all of the
* requirements within any one of the sets to access the operation.
* <p>
* An empty security requirement set indicates that authentication is not required.
* <p>
Expand All @@ -51,8 +54,8 @@
* </pre>
*
* @see <a href=
* "https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#security-requirement-object">SecurityRequirement
* Object</a>
* "https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#security-requirement-object">SecurityRequirement
* Object</a>
**/
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
Expand Down
Expand Up @@ -24,18 +24,23 @@
import java.lang.annotation.Target;

/**
* Represents an array of security requirement sets that apply to an operation. Only one of requirement sets needs be satisfied to access the
* operation.
* Represents an array of security requirement sets that apply to an operation. Only one of requirement sets needs be
* satisfied to access the operation.
* <p>
* If this annotation is applied to a method which corresponds to an operation, then the requirements will be added to that operation.
* If this annotation is applied to a method which corresponds to an operation, then the requirements will be added to
* that operation.
* <p>
* If this annotation is applied to a class which contains methods which correspond to operations, then the requirements will be added to all
* operations corresponding to methods within that class which don't specify any other requirements.
* If this annotation is applied to a class which contains methods which correspond to operations, then the requirements
* will be added to all operations corresponding to methods within that class which don't specify any other
* requirements.
* <p>
* This annotation may be used with {@code value} set to an empty array. When applied like this to a method or class, it indicates that no security
* requirements apply to the corresponding operations. This can be used to override security requirements which are specified for the whole API.
* This annotation may be used with {@code value} set to an empty array. When applied like this to a method or class, it
* indicates that no security requirements apply to the corresponding operations. This can be used to override security
* requirements which are specified for the whole API.
* <p>
* A {@code SecurityRequirementSets} annotation corresponds to an array of maps of security requirements in an OpenAPI document.
* A {@code SecurityRequirementSets} annotation corresponds to an array of maps of security requirements in an OpenAPI
* document.
*
* <pre>
* <b>Example:</b>
* security:
Expand Down

0 comments on commit 27c463c

Please sign in to comment.