-
-
Notifications
You must be signed in to change notification settings - Fork 681
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix: added index.md file to /extensions to fix unexpected 404 (#2901)
- Loading branch information
1 parent
c432532
commit 8b58b33
Showing
1 changed file
with
15 additions
and
0 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 |
---|---|---|
@@ -0,0 +1,15 @@ | ||
--- | ||
title: 'Overview' | ||
weight: 10 | ||
--- | ||
|
||
## What's an extension? | ||
|
||
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-`. (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 | ||
|
||
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. |