Skip to content

docs: clarify protocolVersion field to distinguish from API versioning #4500

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.

Sign up for GitHub

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

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
+82 −315
Open

docs: clarify protocolVersion field to distinguish from API versioning #4500

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
91b53c6
docs: clarify protocolVersion field to distinguish from API versioning
AnvayKharb Oct 22, 2025
e1a12f9
Merge branch 'master' into master
AnvayKharb Oct 24, 2025
8e0aaf4
Merge branch 'master' into master
AnvayKharb Oct 25, 2025
ed50843
feat: Add pagination to blog page
AnvayKharb Oct 25, 2025
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 markdown/docs/concepts/asyncapi-document/structure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ The individual `servers` field contains the following properties:

- `host`: The server hostname. It may include the port.
- `protocol`: The protocol or messaging protocol that is used by the server (for example, AMQP, MQTT, WebSocket).
- `protocolVersion`: The protocol version used for the connection.
- `protocolVersion`: The version of the **underlying communication protocol** used for connection (for example, AMQP `0.9.1`, MQTT `3.1.1`, HTTP `2.0`). This is distinct from the AsyncAPI specification version or your application's API version.
- `pathname`: The path to a resource in the host.
- `description`: A string describing the server.
- `title`: A human-friendly title for the server.
Expand Down
2 changes: 1 addition & 1 deletion markdown/docs/reference/specification/v3.0.0.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -410,7 +410,7 @@ Field Name | Type | Description
---|:---:|---
<a name="serverObjectHost"></a>host | `string` | **REQUIRED**. The server host name. It MAY include the port. This field supports [Server Variables](#serverObjectVariables). Variable substitutions will be made when a variable is named in `{`braces`}`.
<a name="serverObjectProtocol"></a>protocol | `string` | **REQUIRED**. The protocol this server supports for connection.
<a name="serverObjectProtocolVersion"></a>protocolVersion | `string` | The version of the protocol used for connection. For instance: AMQP `0.9.1`, HTTP `2.0`, Kafka `1.0.0`, etc.
<a name="serverObjectProtocolVersion"></a>protocolVersion | `string` | The version of the **underlying communication protocol** used for connection. This refers to the protocol version itself (e.g., AMQP `0.9.1`, MQTT `3.1.1`, HTTP `2.0`, Kafka `1.0.0`), **not** the AsyncAPI document version or application API version. Omit this field if the protocol has no versioning concept.
<a name="serverObjectPathname"></a>pathname | `string` | The path to a resource in the host. This field supports [Server Variables](#serverObjectVariables). Variable substitutions will be made when a variable is named in `{`braces`}`.
<a name="serverObjectDescription"></a>description | `string` | An optional string describing the server. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation.
<a name="serverObjectTitle"></a>title | `string` | A human-friendly title for the server.
Expand Down