Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove support for non-JSON schemas (i.e. Protobuf, XSD, etc.) #241

Merged
merged 1 commit into from
Jul 24, 2019
Merged
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
19 changes: 9 additions & 10 deletions versions/next/asyncapi.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand All @@ -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"
}
}
```
Expand All @@ -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'
```


Expand Down Expand Up @@ -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
```

Expand Down Expand Up @@ -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
Expand Down