From 7de0af8240a30009f15e4b1b5e673e2dde3e4de5 Mon Sep 17 00:00:00 2001 From: asyncapi-bot Date: Wed, 15 Nov 2023 09:04:45 +0000 Subject: [PATCH] docs(extension): update latest extensions docs --- config/edit-page-config.json | 38 ++++++++++++--------- pages/docs/reference/extensions/_section.md | 4 +++ pages/docs/reference/extensions/x.md | 31 +++++++++++++++++ 3 files changed, 56 insertions(+), 17 deletions(-) create mode 100644 pages/docs/reference/extensions/_section.md create mode 100644 pages/docs/reference/extensions/x.md diff --git a/config/edit-page-config.json b/config/edit-page-config.json index a622b600facc..dbd5fa50b9eb 100644 --- a/config/edit-page-config.json +++ b/config/edit-page-config.json @@ -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" + } +] \ No newline at end of file diff --git a/pages/docs/reference/extensions/_section.md b/pages/docs/reference/extensions/_section.md new file mode 100644 index 000000000000..5e4249cbc90c --- /dev/null +++ b/pages/docs/reference/extensions/_section.md @@ -0,0 +1,4 @@ +--- +title: Extensions +weight: 10 +--- \ No newline at end of file diff --git a/pages/docs/reference/extensions/x.md b/pages/docs/reference/extensions/x.md new file mode 100644 index 000000000000..4950e2b395ce --- /dev/null +++ b/pages/docs/reference/extensions/x.md @@ -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 +```