Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: added index.md file to /extensions to fix unexpected 404 #2901

Merged
Merged
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions pages/docs/reference/extensions/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: 'Overview'
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.
quetzalliwrites marked this conversation as resolved.
Show resolved Hide resolved

derberg marked this conversation as resolved.
Show resolved Hide resolved

#### Usage in an AsyncAPI document
derberg marked this conversation as resolved.
Show resolved Hide resolved
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.
quetzalliwrites marked this conversation as resolved.
Show resolved Hide resolved

## 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.
quetzalliwrites marked this conversation as resolved.
Show resolved Hide resolved
Loading