From 2b9e39f3a09728f862d48ab05dc4f39174a20b9a Mon Sep 17 00:00:00 2001 From: Big-oh-learn Date: Wed, 24 Apr 2024 09:16:58 +0530 Subject: [PATCH 1/7] #2890 : added index.md page to the /extensions --- pages/docs/reference/extensions/index.md | 26 ++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 pages/docs/reference/extensions/index.md diff --git a/pages/docs/reference/extensions/index.md b/pages/docs/reference/extensions/index.md new file mode 100644 index 00000000000..db8c3569c68 --- /dev/null +++ b/pages/docs/reference/extensions/index.md @@ -0,0 +1,26 @@ +--- +title: 'Extensions ' +--- + +## What's an extension? + +Extensions are the mechanism AsyncAPI has to allow you use custom or protocol-specific features. Extensions follow a separate release cycle and everyone can create their own. This repository is meant to contain a list of official and community supported extensions. + +> Both, JSON or YAML, are supported formats. Please, take into account that only the subset of YAML that can be translated to JSON is allowed. + + +#### Usage in an AsyncAPI document +AsyncAPI extensions are those that are preceded by `x-`, e.g., `x-twitter`. They can be placed in the AsyncAPI document in locations specified by documentation of given extension. + +## Adding your extension to the catalog + +If you'd like to add your extension to the catalog, please submit a pull request to [asyncapi/extensions-catalog](https://github.com/asyncapi/extensions-catalog) repository. Make sure the extension doesn't exist already, in which case it would be better to improve the existing one so everybody benefits from it. + +## Extending unsupported features + +If you need a feature not covered by the AsyncAPI specification, you can create an extension for it. Should this extension be useful to others, consider contributing it back to the AsyncAPI community. You can do this by [opening a spec issue](https://github.com/asyncapi/spec) in the AsyncAPI GitHub repository. Before contributing, review the [AsyncAPI contribution guidelines](https://github.com/asyncapi/spec/blob/master/CONTRIBUTING.md). + + +## Questions? + +If you have questions, please submit an issue to this repository or [join our Slack workspace](https://asyncapi.com/slack-invite). \ No newline at end of file From 61a9d2c37694094febee49838b9f6b2a1bd2cfab Mon Sep 17 00:00:00 2001 From: Big-oh-learn Date: Wed, 24 Apr 2024 09:27:43 +0530 Subject: [PATCH 2/7] #2890: Fixed weight attr from commit '909ebe2' --- pages/docs/reference/extensions/index.md | 1 + pages/docs/reference/extensions/x.md | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/pages/docs/reference/extensions/index.md b/pages/docs/reference/extensions/index.md index db8c3569c68..0ebd09e5e1e 100644 --- a/pages/docs/reference/extensions/index.md +++ b/pages/docs/reference/extensions/index.md @@ -1,5 +1,6 @@ --- title: 'Extensions ' +weight: 11 --- ## What's an extension? diff --git a/pages/docs/reference/extensions/x.md b/pages/docs/reference/extensions/x.md index 86c4bb984ae..d68254a78af 100644 --- a/pages/docs/reference/extensions/x.md +++ b/pages/docs/reference/extensions/x.md @@ -1,6 +1,6 @@ --- title: 'x' -weight: 11 +weight: 12 --- # Twitter Extension From 8274b7523ccf8e474604acee5c82448cb496ef2e Mon Sep 17 00:00:00 2001 From: Shubham Ingale <77089227+SGI-CAPP-AT2@users.noreply.github.com> Date: Wed, 24 Apr 2024 15:57:34 +0530 Subject: [PATCH 3/7] Review fixes as per https://github.com/asyncapi/website/pull/2901#pullrequestreview-2019184340 --- pages/docs/reference/extensions/index.md | 21 +++++---------------- pages/docs/reference/extensions/x.md | 2 +- 2 files changed, 6 insertions(+), 17 deletions(-) diff --git a/pages/docs/reference/extensions/index.md b/pages/docs/reference/extensions/index.md index 0ebd09e5e1e..4794f5e4296 100644 --- a/pages/docs/reference/extensions/index.md +++ b/pages/docs/reference/extensions/index.md @@ -1,27 +1,16 @@ --- -title: 'Extensions ' -weight: 11 +title: 'Overview' +weight: 10 --- ## What's an extension? -Extensions are the mechanism AsyncAPI has to allow you use custom or protocol-specific features. Extensions follow a separate release cycle and everyone can create their own. This repository is meant to contain a list of official and community supported extensions. - -> Both, JSON or YAML, are supported formats. Please, take into account that only the subset of YAML that can be translated to JSON is allowed. +Extension is a mechanism in AsyncAPI that enables you to add custom fields to AsyncAPI document. You can define your own extensions, use them only for your use case inside your company. You can also share your extensions with others. This way an extension that is adopted by others can one day become core part of AsyncAPI specification. #### Usage in an AsyncAPI document -AsyncAPI extensions are those that are preceded by `x-`, e.g., `x-twitter`. They can be placed in the AsyncAPI document in locations specified by documentation of given extension. +AsyncAPI extensions are those that are preceded by `x-`, for example `x-linkedin`. They can be placed in the AsyncAPI document in locations specified by documentation of given extension. ## Adding your extension to the catalog -If you'd like to add your extension to the catalog, please submit a pull request to [asyncapi/extensions-catalog](https://github.com/asyncapi/extensions-catalog) repository. Make sure the extension doesn't exist already, in which case it would be better to improve the existing one so everybody benefits from it. - -## Extending unsupported features - -If you need a feature not covered by the AsyncAPI specification, you can create an extension for it. Should this extension be useful to others, consider contributing it back to the AsyncAPI community. You can do this by [opening a spec issue](https://github.com/asyncapi/spec) in the AsyncAPI GitHub repository. Before contributing, review the [AsyncAPI contribution guidelines](https://github.com/asyncapi/spec/blob/master/CONTRIBUTING.md). - - -## Questions? - -If you have questions, please submit an issue to this repository or [join our Slack workspace](https://asyncapi.com/slack-invite). \ No newline at end of file +If you'd like to add your extension to the catalog, please submit a pull request to [Extensions Catalog](https://github.com/asyncapi/extensions-catalog) repository. Make sure the extension doesn't exist already, in which case it would be better to improve the existing one so everybody benefits from it. \ No newline at end of file diff --git a/pages/docs/reference/extensions/x.md b/pages/docs/reference/extensions/x.md index d68254a78af..86c4bb984ae 100644 --- a/pages/docs/reference/extensions/x.md +++ b/pages/docs/reference/extensions/x.md @@ -1,6 +1,6 @@ --- title: 'x' -weight: 12 +weight: 11 --- # Twitter Extension From f36631d8eb5cb9e3f00b83ccc444963f3749ea4f Mon Sep 17 00:00:00 2001 From: Lukasz Gornicki Date: Thu, 25 Apr 2024 12:18:51 +0200 Subject: [PATCH 4/7] Apply suggestions from code review --- pages/docs/reference/extensions/index.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/pages/docs/reference/extensions/index.md b/pages/docs/reference/extensions/index.md index 4794f5e4296..0db52a666a7 100644 --- a/pages/docs/reference/extensions/index.md +++ b/pages/docs/reference/extensions/index.md @@ -7,8 +7,7 @@ weight: 10 Extension is a mechanism in AsyncAPI that enables you to add custom fields to AsyncAPI document. You can define your own extensions, use them only for your use case inside your company. You can also share your extensions with others. This way an extension that is adopted by others can one day become core part of AsyncAPI specification. - -#### Usage in an AsyncAPI document +## Usage in an AsyncAPI document AsyncAPI extensions are those that are preceded by `x-`, for example `x-linkedin`. They can be placed in the AsyncAPI document in locations specified by documentation of given extension. ## Adding your extension to the catalog From d690aa787bb6c8e6b70ea7199ce1b5d8ae7fb208 Mon Sep 17 00:00:00 2001 From: Quetzalli Date: Thu, 9 May 2024 14:51:23 -0700 Subject: [PATCH 5/7] Update index.md --- pages/docs/reference/extensions/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/docs/reference/extensions/index.md b/pages/docs/reference/extensions/index.md index 0db52a666a7..fd931ed9e89 100644 --- a/pages/docs/reference/extensions/index.md +++ b/pages/docs/reference/extensions/index.md @@ -5,7 +5,7 @@ weight: 10 ## What's an extension? -Extension is a mechanism in AsyncAPI that enables you to add custom fields to AsyncAPI document. You can define your own extensions, use them only for your use case inside your company. You can also share your extensions with others. This way an extension that is adopted by others can one day become core part of AsyncAPI specification. +Extension is a mechanism in AsyncAPI that enables you to add custom fields to an AsyncAPI document. You can define your own extensions or use them only for your use case inside your company. You can also share your extensions with others. This way an extension that is adopted by others can one day become a core part of the AsyncAPI specification. ## Usage in an AsyncAPI document AsyncAPI extensions are those that are preceded by `x-`, for example `x-linkedin`. They can be placed in the AsyncAPI document in locations specified by documentation of given extension. From 90166e11d21075ecdc8c61ffd0f7134a7b08e815 Mon Sep 17 00:00:00 2001 From: Quetzalli Date: Thu, 9 May 2024 14:51:30 -0700 Subject: [PATCH 6/7] Update index.md --- pages/docs/reference/extensions/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/docs/reference/extensions/index.md b/pages/docs/reference/extensions/index.md index fd931ed9e89..2241e7c0367 100644 --- a/pages/docs/reference/extensions/index.md +++ b/pages/docs/reference/extensions/index.md @@ -8,7 +8,7 @@ weight: 10 Extension is a mechanism in AsyncAPI that enables you to add custom fields to an AsyncAPI document. You can define your own extensions or use them only for your use case inside your company. You can also share your extensions with others. This way an extension that is adopted by others can one day become a core part of the AsyncAPI specification. ## Usage in an AsyncAPI document -AsyncAPI extensions are those that are preceded by `x-`, for example `x-linkedin`. They can be placed in the AsyncAPI document in locations specified by documentation of given extension. +AsyncAPI extensions are those that are preceded by `x-`. (Example: `x-linkedin`) They can be placed in the AsyncAPI document in locations specified by the documentation of a given extension. ## Adding your extension to the catalog From 31cd9dea46c7aaeaefd95b8e52b5efc035093834 Mon Sep 17 00:00:00 2001 From: Quetzalli Date: Thu, 9 May 2024 14:51:36 -0700 Subject: [PATCH 7/7] Update index.md --- pages/docs/reference/extensions/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/docs/reference/extensions/index.md b/pages/docs/reference/extensions/index.md index 2241e7c0367..67b00074c9a 100644 --- a/pages/docs/reference/extensions/index.md +++ b/pages/docs/reference/extensions/index.md @@ -12,4 +12,4 @@ AsyncAPI extensions are those that are preceded by `x-`. (Example: `x-linkedin`) ## Adding your extension to the catalog -If you'd like to add your extension to the catalog, please submit a pull request to [Extensions Catalog](https://github.com/asyncapi/extensions-catalog) repository. Make sure the extension doesn't exist already, in which case it would be better to improve the existing one so everybody benefits from it. \ No newline at end of file +If you'd like to add your extension to the catalog, please submit a pull request to the [Extensions Catalog](https://github.com/asyncapi/extensions-catalog) repository. Make sure the extension doesn't exist already; otherwise, it's better to improve the existing one. \ No newline at end of file