From a4d56a058bd524f804deef2f8b1e9d12d4de2633 Mon Sep 17 00:00:00 2001 From: fmvilas Date: Wed, 24 Jul 2019 12:20:26 +0200 Subject: [PATCH] Remove support for non-JSON schemas (i.e. Protobuf, XSD, etc.) --- versions/next/asyncapi.md | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/versions/next/asyncapi.md b/versions/next/asyncapi.md index 4f8ae48a4..4c6f95f37 100644 --- a/versions/next/asyncapi.md +++ b/versions/next/asyncapi.md @@ -972,7 +972,7 @@ traits: - docId: message-1234 ``` -Example using Google's protobuf to define the payload: +Example using Avro to define the payload: ```json { @@ -985,9 +985,9 @@ Example using Google's protobuf to define the payload: { "name": "signup" }, { "name": "register" } ], - "schemaFormat": "application/x-protobuf", + "schemaFormat": "application/vnd.apache.avro+json", "payload": { - "$ref": "path/to/user-create.proto#UserCreate" + "$ref": "path/to/user-create.avro#/UserCreate" } } ``` @@ -1001,9 +1001,9 @@ tags: - name: user - name: signup - name: register -schemaFormat: application/x-protobuf +schemaFormat: application/vnd.apache.avro+json payload: - $ref: 'path/to/user-create.proto#UserCreate' + $ref: 'path/to/user-create.avro/#UserCreate' ``` @@ -1043,13 +1043,13 @@ This object can be extended with [Specification Extensions](#specificationExtens ```json { - "schemaFormat": "application/vnd.google.protobuf;version=3", + "schemaFormat": "application/vnd.apache.avro+json", "contentType": "application/json" } ``` ```yaml -schemaFormat: 'application/vnd.google.protobuf;version=3' +schemaFormat: 'application/vnd.apache.avro+json' contentType: application/json ``` @@ -1135,10 +1135,9 @@ url: https://example.com A simple object to allow referencing other components in the specification, internally and externally. -The Reference Object is defined by [JSON Reference](https://tools.ietf.org/html/draft-pbryan-zyp-json-ref-03) and follows the same structure, behavior and rules. +The Reference Object is defined by [JSON Reference](https://tools.ietf.org/html/draft-pbryan-zyp-json-ref-03) and follows the same structure, behavior and rules. A JSON Reference SHALL only be used to refer to a schema that is formatted in either JSON or YAML. In the case of a YAML-formatted Schema, the JSON Reference SHALL be applied to the JSON representation of that schema. The JSON representation SHALL be made by applying the conversion described [here](#format). -For this specification, reference resolution is done as defined by the JSON Reference specification -and not by the JSON Schema specification. +For this specification, reference resolution is done as defined by the JSON Reference specification and not by the JSON Schema specification. ##### Fixed Fields Field Name | Type | Description