Skip to content

Commit

Permalink
docs(extensions): update latest extensions documentation (#2320)
Browse files Browse the repository at this point in the history
  • Loading branch information
asyncapi-bot authored Nov 15, 2023
1 parent 926c87b commit 72ebf77
Show file tree
Hide file tree
Showing 3 changed files with 56 additions and 17 deletions.
38 changes: 21 additions & 17 deletions config/edit-page-config.json
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"
}
]
4 changes: 4 additions & 0 deletions pages/docs/reference/extensions/_section.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: Extensions
weight: 10
---
31 changes: 31 additions & 0 deletions pages/docs/reference/extensions/x.md
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
```

0 comments on commit 72ebf77

Please sign in to comment.