Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
* This is the root document object for the API specification.
* It combines resource listing and API declaration together into one document.
*
* @see <a href="https://www.asyncapi.com/docs/reference/specification/v3.0.0#A2SObject">AsyncAPI</a>
* @see <a href="https://www.asyncapi.com/docs/reference/specification/v3.1.0#A2SObject">AsyncAPI</a>
*/
@Data
@Builder
Expand All @@ -29,7 +29,7 @@
@EqualsAndHashCode(callSuper = true)
public class AsyncAPI extends ExtendableObject {

public static final String ASYNCAPI_DEFAULT_VERSION = "3.0.0";
public static final String ASYNCAPI_DEFAULT_VERSION = "3.1.0";

/**
* REQUIRED. Specifies the AsyncAPI Specification version being used. It can be used by tooling Specifications and
Expand All @@ -45,7 +45,7 @@ public class AsyncAPI extends ExtendableObject {

/**
* Identifier of the
* <a href="https://www.asyncapi.com/docs/reference/specification/v3.0.0#definitionsApplication">application</a>
* <a href="https://www.asyncapi.com/docs/reference/specification/v3.1.0#definitionsApplication">application</a>
* the AsyncAPI document is defining.
* </p>
* This field represents a unique universal identifier of the application the AsyncAPI document is defining.
Expand Down Expand Up @@ -84,7 +84,7 @@ public class AsyncAPI extends ExtendableObject {

/**
* The channels used by this
* <a href="https://www.asyncapi.com/docs/reference/specification/v3.0.0#definitionsApplication">application</a>.
* <a href="https://www.asyncapi.com/docs/reference/specification/v3.1.0#definitionsApplication">application</a>.
* </p>
* An identifier for the described channel. The channelId value is case-sensitive. Tools and libraries MAY
* use the channelId to uniquely identify a channel, therefore, it is RECOMMENDED to follow common programming
Expand All @@ -97,15 +97,15 @@ public class AsyncAPI extends ExtendableObject {
* An element to hold various reusable objects for the specification. Everything that is defined inside this
* object represents a resource that MAY or MAY NOT be used in the rest of the document and MAY or MAY NOT be
* used by the implemented
* <a href="https://www.asyncapi.com/docs/reference/specification/v3.0.0#definitionsApplication">Application</a>.
* <a href="https://www.asyncapi.com/docs/reference/specification/v3.1.0#definitionsApplication">Application</a>.
*/
@JsonProperty(value = "components")
private Components components;
/**
* Holds a dictionary with all the operations this application MUST implement.
* </p>
* If you're looking for a place to define operations that MAY or MAY NOT be implemented by the
* <a href="https://www.asyncapi.com/docs/reference/specification/v3.0.0#definitionsApplication">application</a>
* <a href="https://www.asyncapi.com/docs/reference/specification/v3.1.0#definitionsApplication">application</a>
* consider defining them in components/operations.
*/
@JsonProperty(value = "operations")
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
/**
* Allows referencing an external resource for extended documentation.
*
* @see <a href="https://www.asyncapi.com/docs/reference/specification/v3.0.0#externalDocumentationObject">ExternalDocumentation</a>
* @see <a href="https://www.asyncapi.com/docs/reference/specification/v3.1.0#externalDocumentationObject">ExternalDocumentation</a>
*/
@Data
@Builder
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
* For this specification, reference resolution is done as defined by the JSON Reference specification and not by
* the JSON Schema specification.
*
* @see <a href="https://www.asyncapi.com/docs/reference/specification/v3.0.0#referenceObject">Reference</a>
* @see <a href="https://www.asyncapi.com/docs/reference/specification/v3.1.0#referenceObject">Reference</a>
*/
public interface Reference {
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
/**
* Allows adding meta data to a single tag.
*
* @see <a href="https://www.asyncapi.com/docs/reference/specification/v3.0.0#tagsObject">Tag</a>
* @see <a href="https://www.asyncapi.com/docs/reference/specification/v3.1.0#tagsObject">Tag</a>
*/
@Data
@Builder
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
/**
* Describes a shared communication channel.
*
* @see <a href="https://www.asyncapi.com/docs/reference/specification/v3.0.0#channelObject">Channel Object</a>
* @see <a href="https://www.asyncapi.com/docs/reference/specification/v3.1.0#channelObject">Channel Object</a>
*/
@Data
@Builder(toBuilder = true)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
* </p>
* If you're looking to apply traits to an operation, see the Operation Trait Object.
*
* @see <a href="https://www.asyncapi.com/docs/reference/specification/v3.0.0#messageTraitObject">Message Trait Object</a>
* @see <a href="https://www.asyncapi.com/docs/reference/specification/v3.1.0#messageTraitObject">Message Trait Object</a>
*/
@Data
@Builder
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
/**
* Contact information for the exposed API.
*
* @see <a href="https://www.asyncapi.com/docs/reference/specification/v3.0.0#contactObject">Contact</a>
* @see <a href="https://www.asyncapi.com/docs/reference/specification/v3.1.0#contactObject">Contact</a>
*/
@Data
@Builder
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
/**
* The object provides metadata about the API. The metadata can be used by the clients if needed.
*
* @see <a href="https://www.asyncapi.com/docs/reference/specification/v3.0.0#infoObject">Info</a>
* @see <a href="https://www.asyncapi.com/docs/reference/specification/v3.1.0#infoObject">Info</a>
*/
@Data
@Builder
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
/**
* License information for the exposed API.
*
* @see <a href="https://www.asyncapi.com/docs/reference/specification/v3.0.0#licenseObject">License</a>
* @see <a href="https://www.asyncapi.com/docs/reference/specification/v3.1.0#licenseObject">License</a>
*/
@Data
@Builder
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
/**
* Describes a specific operation.
*
* @see <a href="https://www.asyncapi.com/docs/reference/specification/v3.0.0#operationObject">Operation</a>
* @see <a href="https://www.asyncapi.com/docs/reference/specification/v3.1.0#operationObject">Operation</a>
*/
@Data
@Builder(toBuilder = true)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
* Describes the reply part that MAY be applied to an Operation Object. If an operation implements the request/reply
* pattern, the reply object represents the response message.
*
* @see <a href="https://www.asyncapi.com/docs/reference/specification/v3.0.0#operationReplyObject">AsyncAPI</a>
* @see <a href="https://www.asyncapi.com/docs/reference/specification/v3.1.0#operationReplyObject">AsyncAPI</a>
*/
@Data
@Builder
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
* </p>
* If you're looking to apply traits to a message, see the Message Trait Object.
*
* @see <a href="https://www.asyncapi.com/docs/reference/specification/v3.0.0#operationTraitObject">Operation Trait Object</a>
* @see <a href="https://www.asyncapi.com/docs/reference/specification/v3.1.0#operationTraitObject">Operation Trait Object</a>
*/
@Data
@Builder
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
* The Multi Format Schema Object represents a schema definition. It differs from the Schema Object in that it
* supports multiple schema formats or languages (e.g., JSON Schema, Avro, etc.).
*
* @see <a href="https://www.asyncapi.com/docs/reference/specification/v3.0.0#multiFormatSchemaObject">Multi Format Schema Object</a>
* @see <a href="https://www.asyncapi.com/docs/reference/specification/v3.1.0#multiFormatSchemaObject">Multi Format Schema Object</a>
*/
@Data
@Builder
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ public enum SchemaFormat {
ASYNCAPI_V3("application/vnd.aai.asyncapi;version=" + AsyncAPI.ASYNCAPI_DEFAULT_VERSION),
ASYNCAPI_V3_JSON("application/vnd.aai.asyncapi+json;version=" + AsyncAPI.ASYNCAPI_DEFAULT_VERSION),
ASYNCAPI_V3_YAML("application/vnd.aai.asyncapi+yaml;version=" + AsyncAPI.ASYNCAPI_DEFAULT_VERSION),
OPENAPI_V3("application/vnd.oai.openapi;version=3.0.0"),
OPENAPI_V3("application/vnd.oai.openapi;version=3.1.0"),
OPENAPI_V3_1("application/vnd.oai.openapi;version=3.1.0"),
OPENAPI_V3_JSON("application/vnd.oai.openapi+json;version=3.0.0"),
OPENAPI_V3_YAML("application/vnd.oai.openapi+yaml;version=3.0.0"),
OPENAPI_V3_JSON("application/vnd.oai.openapi+json;version=3.1.0"),
OPENAPI_V3_YAML("application/vnd.oai.openapi+yaml;version=3.1.0"),
JSON_SCHEMA_JSON("application/schema+json;version=draft-07"),
JSON_SCHEMA_YAML("application/schema+yaml;version=draft-07"),
AVRO_V1_9_0("application/vnd.apache.avro;version=1.9.0"),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
* Further information about the properties can be found in JSON Schema Core and JSON Schema Validation. Unless stated
* otherwise, the property definitions follow the JSON Schema specification as referenced here.
*
* @see <a href="https://www.asyncapi.com/docs/reference/specification/v3.0.0#schemaObject">Schema Object</a>
* @see <a href="https://www.asyncapi.com/docs/reference/specification/v3.1.0#schemaObject">Schema Object</a>
*/
@Data
@Builder
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
* <li>SASL (Simple Authentication and Security Layer) as defined in RFC4422.</li>
* </ul>
*
* @see <a href="https://www.asyncapi.com/docs/reference/specification/v3.0.0#securitySchemeObject">Schema Scheme Object</a>
* @see <a href="https://www.asyncapi.com/docs/reference/specification/v3.1.0#securitySchemeObject">Schema Scheme Object</a>
*/
@Data
@Builder
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
* Variable substitution can be used so that some details, for example usernames and passwords, can be injected by code
* generation tools.
*
* @see <a href="https://www.asyncapi.com/docs/reference/specification/v3.0.0#serverObject">Server</a>
* @see <a href="https://www.asyncapi.com/docs/reference/specification/v3.1.0#serverObject">Server</a>
*/
@Data
@Builder
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
/**
* An object representing a Server Variable for server URL template substitution.
*
* @see <a href="https://www.asyncapi.com/docs/reference/specification/v3.0.0#serverVariableObject">ServerVariable</a>
* @see <a href="https://www.asyncapi.com/docs/reference/specification/v3.1.0#serverVariableObject">ServerVariable</a>
*/
@Data
@Builder
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"asyncapi": "3.0.0",
"asyncapi": "3.1.0",
"info": {
"title": "AsyncAPI Sample App",
"version": "1.0.1",
Expand Down Expand Up @@ -43,7 +43,7 @@
"components": {
"schemas": {
"ExamplePayload": {
"schemaFormat": "application/vnd.oai.openapi;version=3.0.0",
"schemaFormat": "application/vnd.oai.openapi;version=3.1.0",
"schema": {
"type": "object",
"properties": {
Expand All @@ -57,7 +57,7 @@
"messages": {
"io.github.springwolf.core.ExamplePayload": {
"payload": {
"schemaFormat": "application/vnd.aai.asyncapi+json;version=3.0.0",
"schemaFormat": "application/vnd.aai.asyncapi+json;version=3.1.0",
"schema": {
"$ref": "#/components/schemas/ExamplePayload"
}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
asyncapi: 3.0.0
asyncapi: 3.1.0
info:
title: AsyncAPI Sample App
version: 1.0.1
Expand Down Expand Up @@ -30,7 +30,7 @@ channels:
components:
schemas:
ExamplePayload:
schemaFormat: "application/vnd.oai.openapi;version=3.0.0"
schemaFormat: "application/vnd.oai.openapi;version=3.1.0"
schema:
type: object
properties:
Expand All @@ -39,7 +39,7 @@ components:
messages:
io.github.springwolf.core.ExamplePayload:
payload:
schemaFormat: application/vnd.aai.asyncapi+json;version=3.0.0
schemaFormat: application/vnd.aai.asyncapi+json;version=3.1.0
schema:
"$ref": "#/components/schemas/ExamplePayload"
name: io.github.springwolf.core.ExamplePayload
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"asyncapi": "3.0.0",
"asyncapi": "3.1.0",
"info": {
"title": "AsyncAPI Sample App",
"version": "1.0.1",
Expand Down Expand Up @@ -54,7 +54,7 @@
"messages": {
"io.github.springwolf.core.ExamplePayload": {
"payload": {
"schemaFormat": "application/vnd.aai.asyncapi+json;version=3.0.0",
"schemaFormat": "application/vnd.aai.asyncapi+json;version=3.1.0",
"schema": {
"$ref": "#/components/schemas/ExamplePayload"
}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
asyncapi: 3.0.0
asyncapi: 3.1.0
info:
title: AsyncAPI Sample App
version: 1.0.1
Expand Down Expand Up @@ -37,7 +37,7 @@ components:
messages:
io.github.springwolf.core.ExamplePayload:
payload:
schemaFormat: application/vnd.aai.asyncapi+json;version=3.0.0
schemaFormat: application/vnd.aai.asyncapi+json;version=3.1.0
schema:
"$ref": "#/components/schemas/ExamplePayload"
name: io.github.springwolf.core.ExamplePayload
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"asyncapi": "3.0.0",
"asyncapi": "3.1.0",
"info": {
"title": "Account Service",
"version": "1.0.0",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"asyncapi": "3.0.0",
"asyncapi": "3.1.0",
"info": {
"title": "Streetlights Kafka API",
"version": "1.0.0",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@
* <li>"date-time" - RFC 3339 date-time</li>
* </ul>
*
* @see <a href="https://www.asyncapi.com/docs/reference/specification/v3.0.0#dataTypeFormat">AsyncAPI Data Type Format</a>
* @see <a href="https://www.asyncapi.com/docs/reference/specification/v3.1.0#dataTypeFormat">AsyncAPI Data Type Format</a>
* @return the format string, empty by default
*/
String format() default "";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,15 +36,15 @@ public class AsyncApiDocket {
/**
* A string representing the default content type to use when encoding/decoding a message's payload.
*
* @see <a href="https://www.asyncapi.com/docs/reference/specification/v3.0.0#defaultContentTypeString">Default Content Type</a>
* @see <a href="https://www.asyncapi.com/docs/reference/specification/v3.1.0#defaultContentTypeString">Default Content Type</a>
*/
@Builder.Default
private final String defaultContentType = MediaType.APPLICATION_JSON_VALUE;

/**
* A string representing the default content type to use when encoding/decoding a message's payload.
*
* @see <a href="https://www.asyncapi.com/docs/reference/specification/v3.0.0#A2SIdString">Identifier</a>
* @see <a href="https://www.asyncapi.com/docs/reference/specification/v3.1.0#A2SIdString">Identifier</a>
*/
private final String id;
}
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"asyncapi": "3.0.0",
"asyncapi": "3.1.0",
"info": {
"title": "springwolf-core-integration-test",
"version": "1.0.0",
Expand Down Expand Up @@ -84,7 +84,7 @@
"$ref": "#/components/schemas/HeadersNotDocumented"
},
"payload": {
"schemaFormat": "application/vnd.aai.asyncapi+json;version=3.0.0",
"schemaFormat": "application/vnd.aai.asyncapi+json;version=3.1.0",
"schema": {
"$ref": "#/components/schemas/Foo"
}
Expand All @@ -98,7 +98,7 @@
"$ref": "#/components/schemas/HeadersNotDocumented"
},
"payload": {
"schemaFormat": "application/vnd.aai.asyncapi+json;version=3.0.0",
"schemaFormat": "application/vnd.aai.asyncapi+json;version=3.1.0",
"schema": {
"type": "integer",
"format": "int32",
Expand All @@ -116,7 +116,7 @@
"$ref": "#/components/schemas/HeadersNotDocumented"
},
"payload": {
"schemaFormat": "application/vnd.aai.asyncapi+json;version=3.0.0",
"schemaFormat": "application/vnd.aai.asyncapi+json;version=3.1.0",
"schema": {
"type": "string",
"examples": [
Expand Down
Loading
Loading