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
Show file tree
Hide file tree
Changes from 3 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
27 changes: 27 additions & 0 deletions pages/docs/reference/extensions/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
title: 'Extensions '
SGI-CAPP-AT2 marked this conversation as resolved.
Show resolved Hide resolved
weight: 11
---

## 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.
SGI-CAPP-AT2 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-`, e.g., `x-twitter`. They can be placed in the AsyncAPI document in locations specified by documentation of given extension.
SGI-CAPP-AT2 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 [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.
SGI-CAPP-AT2 marked this conversation as resolved.
Show resolved Hide resolved

## 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).
SGI-CAPP-AT2 marked this conversation as resolved.
Show resolved Hide resolved
2 changes: 1 addition & 1 deletion pages/docs/reference/extensions/x.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: 'x'
weight: 11
weight: 12
SGI-CAPP-AT2 marked this conversation as resolved.
Show resolved Hide resolved
---

# Twitter Extension
Expand Down
Loading