-
-
Notifications
You must be signed in to change notification settings - Fork 638
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(extensions): update latest extensions documentation (#2320)
- Loading branch information
1 parent
926c87b
commit 72ebf77
Showing
3 changed files
with
56 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,18 +1,22 @@ | ||
[ | ||
{ | ||
"value": "/tools/generator", | ||
"href": "https://github.com/asyncapi/generator/tree/master/docs" | ||
}, | ||
{ | ||
"value": "reference/specification/", | ||
"href": "https://github.com/asyncapi/spec/blob/master/spec/asyncapi.md" | ||
}, | ||
{ | ||
"value":"/tools/cli", | ||
"href":"https://github.com/asyncapi/cli/tree/master/docs" | ||
}, | ||
{ | ||
"value": "", | ||
"href": "https://github.com/asyncapi/website/blob/master/pages" | ||
} | ||
] | ||
{ | ||
"value": "/tools/generator", | ||
"href": "https://github.com/asyncapi/generator/tree/master/docs" | ||
}, | ||
{ | ||
"value": "reference/specification/", | ||
"href": "https://github.com/asyncapi/spec/blob/master/spec/asyncapi.md" | ||
}, | ||
{ | ||
"value": "/tools/cli", | ||
"href": "https://github.com/asyncapi/cli/tree/master/docs" | ||
}, | ||
{ | ||
"value": "", | ||
"href": "https://github.com/asyncapi/website/blob/master/pages" | ||
}, | ||
{ | ||
"value": "reference/extensions/", | ||
"href": "https://github.com/asyncapi/extensions-catalog/tree/master/extensions" | ||
} | ||
] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
--- | ||
title: Extensions | ||
weight: 10 | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
--- | ||
title: 'x' | ||
weight: 11 | ||
--- | ||
|
||
# Twitter Extension | ||
This document defines how to use `twitter` extension in AsyncAPI documents. | ||
|
||
## Overview | ||
This extension allows you to provide the Twitter username of the account representing the team/company of the API. | ||
|
||
## Extension Definition | ||
|
||
### Type: String | ||
|
||
Name of the Twitter username. | ||
|
||
## Extension Location | ||
|
||
This extension can be used in the following locations: | ||
- [Info Object](https://www.asyncapi.com/docs/reference/specification/v2.6.0#infoObject) | ||
|
||
## Example | ||
|
||
```yaml | ||
asyncapi: '2.6.0' | ||
info | ||
title: Strretlights Kafka API | ||
version: '1.0.0' | ||
x-twitter: StreetLightData | ||
``` |