Skip to content

Commit

Permalink
build: fix javadocs
Browse files Browse the repository at this point in the history
  • Loading branch information
Pakisan committed May 1, 2024
1 parent 9910e2d commit a90d26b
Show file tree
Hide file tree
Showing 29 changed files with 68 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@
import java.io.IOException;

/**
* Deserialize Schema additional properties
*
* @author Guillaume LAMIRAND (guillaume.lamirand at graviteesource.com)
* @author GraviteeSource Team
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@
import java.io.IOException;

/**
* Deserialize Schema additional properties
*
* @author Guillaume LAMIRAND (guillaume.lamirand at graviteesource.com)
* @author GraviteeSource Team
*/
Expand Down
2 changes: 2 additions & 0 deletions asyncapi-core/src/main/java/com/asyncapi/v2/schema/Type.java
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
package com.asyncapi.v2.schema;

/**
* Json Schema type.
*
* @author Pavel Bodiachevskii
*/
public class Type {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@
import org.jetbrains.annotations.Nullable;

/**
* API Key Security Scheme
*
* @version 2.6.0
* @see <a href="https://www.asyncapi.com/docs/reference/specification/v2.6.0#securitySchemeObject">SecurityScheme</a>
* @author Pavel Bodiachevskii
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@
import org.jetbrains.annotations.Nullable;

/**
* OpenID Connect Security Scheme
*
* @version 2.6.0
* @see <a href="https://www.asyncapi.com/docs/reference/specification/v2.6.0#securitySchemeObject">SecurityScheme</a>
* @author Pavel Bodiachevskii
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@
import org.jetbrains.annotations.Nullable;

/**
* HTTP API Key Security Scheme
*
* @version 2.6.0
* @see <a href="https://www.asyncapi.com/docs/reference/specification/v2.6.0#securitySchemeObject">SecurityScheme</a>
* @author Pavel Bodiachevskii
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@
import org.jetbrains.annotations.Nullable;

/**
* HTTP Security Scheme
*
* @version 2.6.0
* @see <a href="https://www.asyncapi.com/docs/reference/specification/v2.6.0#securitySchemeObject">SecurityScheme</a>
* @author Pavel Bodiachevskii
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@
import org.jetbrains.annotations.Nullable;

/**
* OAuth2 Security Scheme
*
* @version 2.6.0
* @see <a href="https://www.asyncapi.com/docs/reference/specification/v2.6.0#securitySchemeObject">SecurityScheme</a>
* @author Pavel Bodiachevskii
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@
import java.util.Map;

/**
* Configuration for the OAuth Client Credentials flow
* <p>
* This object MAY be extended with {@link com.asyncapi.ExtendableObject}.
*
* @version 2.6.0
* @see <a href="https://www.asyncapi.com/docs/reference/specification/v2.6.0#oauthFlowObject">OAuth Flow Object</a>
* @author Pavel Bodiachevskii
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@
import java.util.Map;

/**
* Configuration for the OAuth Implicit flow
* <p>
* This object MAY be extended with {@link com.asyncapi.ExtendableObject}.
*
* @version 2.6.0
* @see <a href="https://www.asyncapi.com/docs/reference/specification/v2.6.0#oauthFlowObject">OAuth Flow Object</a>
* @author Pavel Bodiachevskii
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@
import java.util.Map;

/**
* Configuration for the OAuth Resource Owner Protected Credentials flow
* <p>
* This object MAY be extended with {@link com.asyncapi.ExtendableObject}.
*
* @version 2.6.0
* @see <a href="https://www.asyncapi.com/docs/reference/specification/v2.6.0#oauthFlowObject">OAuth Flow Object</a>
* @author Pavel Bodiachevskii
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@
import java.io.IOException;

/**
* AsyncAPI Schema additional properties deserializer
*
* @author Guillaume LAMIRAND (guillaume.lamirand at graviteesource.com)
* @author GraviteeSource Team
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
import com.asyncapi.v3.schema.AsyncAPISchema;

/**
* AsyncAPI Schema any value deserializer
*
* @author Pavel Bodiachevskii
*/
public class AsyncAPISchemaAnyValueDeserializer extends SchemaAnyValueDeserializer<AsyncAPISchema> {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@
import java.util.ArrayList;
import java.util.List;

/**
* AsyncAPI Schema items deserializer
*/
public class AsyncAPISchemaItemsDeserializer extends SchemaItemsDeserializer<AsyncAPISchema> {

public Class<AsyncAPISchema> schemaClass() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
import com.asyncapi.v3.schema.JsonSchema;

/**
* Json Schema any value deserializer
*
* @author Pavel Bodiachevskii
*/
public class JsonSchemaAnyValueDeserializer extends SchemaAnyValueDeserializer<JsonSchema> {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
import com.asyncapi.v3.jackson.SchemaItemsDeserializer;
import com.asyncapi.v3.schema.JsonSchema;

/**
* Json Schema items deserializer
*/
public class JsonSchemaItemsDeserializer extends SchemaItemsDeserializer<JsonSchema> {

public Class<JsonSchema> schemaClass() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@
import java.io.IOException;

/**
* Json Schema properties deserializer.
*
* @author Guillaume LAMIRAND (guillaume.lamirand at graviteesource.com)
* @author GraviteeSource Team
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@
import java.util.List;

/**
* Abstract Schema any value deserializer
*
* @param <Schema> schema to deserialize
* @author Pavel Bodiachevskii
*/
public abstract class SchemaAnyValueDeserializer<Schema> extends JsonDeserializer<Object> {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@
import java.io.IOException;

/**
* OpenAPI Schema additional properties deserializer
*
* @author Pavel Bodiachevskii
* @version 3.0.0
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
import com.asyncapi.v3.schema.openapi.v3._0_0.OpenAPISchema;

/**
* OpenAPI Schema any value deserializer
*
* @author Pavel Bodiachevskii
*/
public class OpenAPISchemaAnyValueDeserializer extends SchemaAnyValueDeserializer<OpenAPISchema> {
Expand Down
2 changes: 2 additions & 0 deletions asyncapi-core/src/main/java/com/asyncapi/v3/schema/Type.java
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
package com.asyncapi.v3.schema;

/**
* Json Schema type.
*
* @author Pavel Bodiachevskii
*/
public class Type {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@
import java.util.Map;

/**
* Avro Array Schema
*
* @see <a href="https://avro.apache.org/docs/1.9.0/spec.html#Arrays">Arrays</a>
*/
@Data
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@
import java.util.Map;

/**
* Avro Fixed Schema
*
* @see <a href="https://avro.apache.org/docs/1.9.0/spec.html#Arrays">Arrays</a>
*/
@Data
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

import com.fasterxml.jackson.annotation.JsonProperty;

/**
* Avro Schema logical types
*/
public class AvroSchemaLogicalType {

@JsonProperty("decimal")
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@
import java.util.Map;

/**
* Avro Map Schema
*
* @see <a href="https://avro.apache.org/docs/1.9.0/spec.html#Maps">Maps</a>
*/
@Data
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@
import java.util.HashMap;
import java.util.Map;

/**
* Avro Schema metadata
*/
@Data
@JsonIgnoreProperties({"metadata"})
public class AvroSchemaMetadata {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
* The Multi Format Schema Object represents a schema definition. It differs from the {@link AsyncAPISchema} in that it supports
* multiple schema formats or languages (e.g., JSON Schema, Avro, etc.).
*
* @param <Schema> schema to use
* @see <a href="https://www.asyncapi.com/docs/reference/specification/v3.0.0#multiFormatSchemaObject">Multi Format Schema</a>
* @see <a href="https://www.asyncapi.com/docs/reference/specification/v3.0.0#schemaObject">Schema</a>
* @author Pavel Bodiachevskii
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ public class OpenAPISchema extends Extensions {

/**
* The word “exclusive” in {@link #exclusiveMinimum} and {@link #exclusiveMaximum} means the corresponding boundary is excluded:
* <table summary="exclusive description">
* <table caption="exclusive description">
* <tr>
* <th>Keyword</th>
* <th>Description</th>
Expand Down Expand Up @@ -166,7 +166,7 @@ public class OpenAPISchema extends Extensions {

/**
* The word “exclusive” in {@link #exclusiveMinimum} and {@link #exclusiveMaximum} means the corresponding boundary is excluded:
* <table summary="exclusive description">
* <table caption="exclusive description">
* <tr>
* <th>Keyword</th>
* <th>Description</th>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@
import java.util.regex.Pattern;

/**
* Allows to extend AsyncAPI specification
*
* @see <a href="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.0.md#specification-extensions">Specification Extensions</a>
*/
@Data
Expand Down

0 comments on commit a90d26b

Please sign in to comment.