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

Add support for coap scheme #104

Closed
wants to merge 1 commit into from
Closed
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
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -298,7 +298,7 @@ An object representing a Server.
Field Name | Type | Description
---|:---:|---
<a name="serverObjectUrl"></a>url | `string` | **REQUIRED**. A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the AsyncAPI document is being served. Variable substitutions will be made when a variable is named in `{`brackets`}`.
<a name="serverObjectScheme"></a>scheme | `string` | **REQUIRED**. The scheme this URL supports for connection. The value MUST be one of the following: `kafka`, `kafka-secure`, `amqp`, `amqps`, `mqtt`, `secure-mqtt`, `ws`, `wss`, `stomp`, `stomps`.
<a name="serverObjectScheme"></a>scheme | `string` | **REQUIRED**. The scheme this URL supports for connection. The value MUST be one of the following: `kafka`, `kafka-secure`, `amqp`, `amqps`, `mqtt`, `secure-mqtt`, `ws`, `wss`, `stomp`, `stomps`, `jms` or `coap`.
<a name="serverObjectSchemeVersion"></a>schemeVersion | `string` | The version of the scheme. For instance: AMQP `0.9.1`, Kafka `1.0.0`, etc.
<a name="serverObjectDescription"></a>description | `string` | An optional string describing the host designated by the URL. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation.
<a name="serverObjectVariables"></a>variables | Map[`string`, [Server Variable Object](#serverVariableObject)] | A map between a variable name and its value. The value is used for substitution in the server's URL template.
Expand Down
5 changes: 3 additions & 2 deletions schema/asyncapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -539,7 +539,8 @@
"stomps",
"http",
"https",
"jms"
"jms",
"coap"
]
},
"schemeVersion": {
Expand Down Expand Up @@ -1341,4 +1342,4 @@
}
}
}
}
}
3 changes: 2 additions & 1 deletion schema/asyncapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -454,6 +454,7 @@ definitions:
- http
- https
- jms
- coap
schemeVersion:
description: TODO
type: string
Expand Down Expand Up @@ -1044,4 +1045,4 @@ definitions:
properties:
$ref:
type: string
format: uri
format: uri
6 changes: 6 additions & 0 deletions v2/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
* [Callback messages.](#callback-messages)
* [Support for "oneOf", "anyOf", and "not" on schemas.](#support-for-oneof-anyof-and-not-on-schemas)
* [Override default topic separator.](#override-default-topic-separator)
* [Added CoAP scheme.](#added-coap-scheme)

## Descriptions

Expand Down Expand Up @@ -81,3 +82,8 @@ Kudos to [@wout3r](https://github.com/wout3r) and [@SensibleWood](https://github
### Override default topic separator

It is now possible to override the default topic separator by specifying `defaultTopicSeparator`. This value will be used to concatenate the base topic (if it exists) with every topic. A common use case is to set it to `/` when documenting MQTT APIs.

### Added CoAP scheme

You can now use `coap` as a scheme. Thanks [@MikeRalphson](https://github.com/MikeRalphson).