Skip to content

Commit

Permalink
point links to openapis
Browse files Browse the repository at this point in the history
  • Loading branch information
benjamin-confino committed May 3, 2024
1 parent 0d8cc8e commit 38d1cf5
Show file tree
Hide file tree
Showing 69 changed files with 73 additions and 73 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
* Describes the Components object that holds various reusable objects for different aspects of the OpenAPI
* Specification (OAS).
*
* @see <a href= "https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#components-object"> OpenAPI
* @see <a href= "https://spec.openapis.org/oas/v3.1.0.html##components-object"> OpenAPI
* Specification Components Object</a>
*/
@Target({})
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
* externalDocs field of the OpenAPIDefinition annotation is supplied the results are not defined.
*
* @see <a href=
* "https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#external-documentation-object">OpenAPI
* "https://spec.openapis.org/oas/v3.1.0.html##external-documentation-object">OpenAPI
* Specification External Documentation Object</a>
**/
@Target({ElementType.METHOD, ElementType.TYPE})
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
* <p>
* This is the root document object of the OpenAPI document. It contains required and optional fields.
*
* @see <a href= "https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#openapi-object">OpenAPI
* @see <a href= "https://spec.openapis.org/oas/v3.1.0.html##openapi-object">OpenAPI
* Specification OpenAPI Object</a>
*/

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
/**
* Describes a single API operation on a path.
*
* @see <a href= "https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#operation-object">OpenAPI
* @see <a href= "https://spec.openapis.org/oas/v3.1.0.html##operation-object">OpenAPI
* Specification Operation Object</a>
**/
@Target({ElementType.METHOD})
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
/**
* This object represents a callback URL that will be invoked.
*
* @see <a href="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#callback-object">OpenAPI
* @see <a href="https://spec.openapis.org/oas/v3.1.0.html##callback-object">OpenAPI
* Specification Callback Object</a>
**/
@Target({ElementType.METHOD, ElementType.TYPE})
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
/**
* Describes a single API callback operation.
*
* @see <a href= "https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#operation-object">OpenAPI
* @see <a href= "https://spec.openapis.org/oas/v3.1.0.html##operation-object">OpenAPI
* Specification Operation Object</a>
**/
@Target({})
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
/**
* This object represents an array of Callback URLs that can be invoked.
*
* @see <a href="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#callback-object">OpenAPI
* @see <a href="https://spec.openapis.org/oas/v3.1.0.html##callback-object">OpenAPI
* Specification Callback Object</a>
**/
@Target({ElementType.METHOD})
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
/**
* Describes a single header object
*
* @see <a href= "https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#header-object">OpenAPI
* @see <a href= "https://spec.openapis.org/oas/v3.1.0.html##header-object">OpenAPI
* Specification Header Object</a>
**/
@Target({})
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
/**
* Contact information for the exposed API.
*
* @see "https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#contact-object"
* @see "https://spec.openapis.org/oas/v3.1.0.html##contact-object"
**/
@Target({})
@Retention(RetentionPolicy.RUNTIME)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
/**
* This annotation provides metadata about the API, and maps to the Info object in OpenAPI Specification 3.
*
* @see "https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#info-object"
* @see "https://spec.openapis.org/oas/v3.1.0.html##info-object"
**/
@Target({})
@Retention(RetentionPolicy.RUNTIME)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
/**
* License information for the exposed API.
*
* @see "https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#license-object"
* @see "https://spec.openapis.org/oas/v3.1.0.html##license-object"
**/
@Target({})
@Retention(RetentionPolicy.RUNTIME)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
* caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between
* responses and other operations.
*
* @see <a href= "https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#link-object"> OpenAPI
* @see <a href= "https://spec.openapis.org/oas/v3.1.0.html##link-object"> OpenAPI
* Specification Link Object</a>
**/
@Target({})
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
/**
* This object provides schema and examples for a particular media type.
*
* @see <a href="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#media-type-object">OpenAPI
* @see <a href="https://spec.openapis.org/oas/v3.1.0.html##media-type-object">OpenAPI
* Specification Media Type Object</a>
**/
@Target({})
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
* This object maps payload values to a particular Schema.
*
* @see <a href=
* "https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#discriminator-object">OpenAPI
* "https://spec.openapis.org/oas/v3.1.0.html##discriminator-object">OpenAPI
* Specification Discriminator Object</a>
**/
@Target({})
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
/**
* Single encoding definition to be applied to single Schema Object
*
* @see <a href="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#encoding-object">Encoding
* @see <a href="https://spec.openapis.org/oas/v3.1.0.html##encoding-object">Encoding
* Object</a>
**/

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
/**
* This object illustrates an example of a particular content
*
* @see <a href= "https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#example-object">OpenAPI
* @see <a href= "https://spec.openapis.org/oas/v3.1.0.html##example-object">OpenAPI
* Specification Example Object</a>
**/
@Target({})
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
* The Schema Object allows the definition of input and output data types. These types can be objects, but also
* primitives and arrays. This object is an extended subset of the JSON Schema Specification Wright Draft 00.
*
* @see <a href= "https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#schema-object">OpenAPI
* @see <a href= "https://spec.openapis.org/oas/v3.1.0.html##schema-object">OpenAPI
* Specification Schema Object</a>
**/
@Target({ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER, ElementType.TYPE})
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
*
* This object is an extended subset of the JSON Schema Specification Wright Draft 00.
*
* @see <a href= "https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#schema-object">OpenAPI
* @see <a href= "https://spec.openapis.org/oas/v3.1.0.html##schema-object">OpenAPI
* Specification Schema Object</a>
*
* @since 2.0
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
/**
* Describes a single operation parameter
*
* @see <a href= "https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#parameter-object">OpenAPI
* @see <a href= "https://spec.openapis.org/oas/v3.1.0.html##parameter-object">OpenAPI
* Specification Parameter Object</a>
**/
@Target({ElementType.PARAMETER, ElementType.METHOD, ElementType.FIELD})
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
/**
* This object encapsulates input parameters
*
* @see <a href= "https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#parameter-object">OpenAPI
* @see <a href= "https://spec.openapis.org/oas/v3.1.0.html##parameter-object">OpenAPI
* Specification Parameter Object</a>
*/
@Retention(RetentionPolicy.RUNTIME)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
* Describes a single request body.
*
* @see <a href=
* "https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#request-body-object">RequestBody
* "https://spec.openapis.org/oas/v3.1.0.html##request-body-object">RequestBody
* Object</a>
**/
@Target({ElementType.PARAMETER, ElementType.METHOD})
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@
* </pre>
*
* @see RequestBody
* @see <a href="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#request-body-object">OpenAPI
* @see <a href="https://spec.openapis.org/oas/v3.1.0.html##request-body-object">OpenAPI
* requestBody Object</a>
**/
@Target({ElementType.PARAMETER, ElementType.METHOD})
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@
* }
* </pre>
*
* @see "https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#response-object"
* @see "https://spec.openapis.org/oas/v3.1.0.html##response-object"
*
**/
@Target({ElementType.METHOD, ElementType.TYPE})
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@
*
* @since 2.0
* @see APIResponse
* @see "https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#response-object"
* @see "https://spec.openapis.org/oas/v3.1.0.html##response-object"
*
**/
@Target({ElementType.METHOD})
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
* The ApiResponses annotation is a container for @ApiResponse annotations. When used on a method it is treated as if
* each ApiResponse annotation were applied individually.
*
* @see <a href="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#responses-object">Responses
* @see <a href="https://spec.openapis.org/oas/v3.1.0.html##responses-object">Responses
* Object</a>
**/
@Target({ElementType.METHOD, ElementType.TYPE})
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
/**
* Configuration details for a supported OAuth Flow.
*
* @see <a href="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#oauth-flow-object">OAuthFlow
* @see <a href="https://spec.openapis.org/oas/v3.1.0.html##oauth-flow-object">OAuthFlow
* Object</a>
**/
@Target({})
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
/**
* Allows configuration of the supported OAuth Flows.
*
* @see <a href="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#oauth-flows-object">OAuthFlows
* @see <a href="https://spec.openapis.org/oas/v3.1.0.html##oauth-flows-object">OAuthFlows
* Object</a>
**/
@Target({})
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
/**
* Represents an OAuth scope.
*
* @see <a href="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#oauth-flow-object">OAuthFlow
* @see <a href="https://spec.openapis.org/oas/v3.1.0.html##oauth-flow-object">OAuthFlow
* Object</a>
**/
@Target({})
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
* containing only this annotation.
*
* @see <a href=
* "https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#security-requirement-object">SecuirtyRequirement
* "https://spec.openapis.org/oas/v3.1.0.html##security-requirement-object">SecuirtyRequirement
* Object</a>
**/
@Target({ElementType.METHOD, ElementType.TYPE})
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
* </pre>
*
* @see <a href=
* "https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#security-requirement-object">-security-requirement
* "https://spec.openapis.org/oas/v3.1.0.html##security-requirement-object">-security-requirement
* Object</a>
**/
@Target({ElementType.METHOD, ElementType.TYPE})
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@
* </pre>
*
* @see <a href=
* "https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#security-requirement-object">-security-requirement
* "https://spec.openapis.org/oas/v3.1.0.html##security-requirement-object">-security-requirement
* Object</a>
**/
@Target({ElementType.METHOD, ElementType.TYPE})
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
* </pre>
*
* @see <a href=
* "https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#security-requirement-object">-security-requirement
* "https://spec.openapis.org/oas/v3.1.0.html##security-requirement-object">-security-requirement
* Object</a>
**/
@Retention(RUNTIME)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
* (either as a header or as a query parameter), OAuth2's common flows (implicit, password, application and access code)
* as defined in RFC6749, and OpenID Connect Discovery.
*
* @see "https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#security-scheme-object"
* @see "https://spec.openapis.org/oas/v3.1.0.html##security-scheme-object"
**/
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
/**
* This object represents an array of SecurityScheme annotations that can be specified at the definition level.
*
* @see "https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#security-scheme-object"
* @see "https://spec.openapis.org/oas/v3.1.0.html##security-scheme-object"
**/
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
* {@link org.eclipse.microprofile.openapi.annotations.servers.Servers Servers} annotation are specified on the same
* type, the server definitions will be combined.
*
* @see <a href= "https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#server-object"> OpenAPI
* @see <a href= "https://spec.openapis.org/oas/v3.1.0.html##server-object"> OpenAPI
* Specification Server Object</a>
**/
@Target({ElementType.TYPE, ElementType.METHOD})
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
* An object representing a Server Variable for server URL template substitution.
*
* @see <a href=
* "https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#server-variable-object">ServerVariable
* "https://spec.openapis.org/oas/v3.1.0.html##server-variable-object">ServerVariable
* Object</a>
**/
@Target({})
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
* {@link org.eclipse.microprofile.openapi.annotations.servers.Servers Servers} annotation are specified on the same
* type, the server definitions will be combined.
*
* @see <a href="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#server-object">Server
* @see <a href="https://spec.openapis.org/oas/v3.1.0.html##server-object">Server
* Object</a>
*
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@
* }
* </pre>
*
* @see <a href= "https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#tag-object"> OpenAPI
* @see <a href= "https://spec.openapis.org/oas/v3.1.0.html##tag-object"> OpenAPI
* Specification Tag Object</a>
*/
@Target({ElementType.TYPE, ElementType.METHOD})
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
* {@link org.eclipse.microprofile.openapi.annotations.tags.Tags Tags} annotations are specified on the same
* method/class, then both tag definitions should be applied to method/class.
*
* @see <a href= "https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#tag-object">OpenAPI
* @see <a href= "https://spec.openapis.org/oas/v3.1.0.html##tag-object">OpenAPI
* Specification Tag Object</a>
*
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
* <li>my.org.User</li>
* </ul>
*
* @see <a href= "https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#components-object"> OpenAPI
* @see <a href= "https://spec.openapis.org/oas/v3.1.0.html##components-object"> OpenAPI
* Specification Components Object</a>
*/
public interface Components extends Constructible, Extensible<Components> {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
* <p>
*
* @see <a href=
* "https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#external-documentation-object">OpenAPI
* "https://spec.openapis.org/oas/v3.1.0.html##external-documentation-object">OpenAPI
* Specification External Documentation Object</a>
*/
public interface ExternalDocumentation extends Constructible, Extensible<ExternalDocumentation> {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
* <p>
* This is the root document object of the OpenAPI document. It contains required and optional fields.
*
* @see <a href= "https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#openapi-object">OpenAPI
* @see <a href= "https://spec.openapis.org/oas/v3.1.0.html##openapi-object">OpenAPI
* Specification OpenAPI Object</a>
*/
public interface OpenAPI extends Constructible, Extensible<OpenAPI> {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
* Describes a single API operation on a path.
* <p>
*
* @see <a href= "https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#operation-object">OpenAPI
* @see <a href= "https://spec.openapis.org/oas/v3.1.0.html##operation-object">OpenAPI
* Specification Operation Object</a>
*/
public interface Operation extends Constructible, Extensible<Operation> {
Expand Down
Loading

0 comments on commit 38d1cf5

Please sign in to comment.