-
-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Co-authored-by: Lukasz Gornicki <[email protected]>
- Loading branch information
1 parent
3c5ce48
commit e8154e7
Showing
1 changed file
with
29 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,29 @@ | ||
# Linkedin Extension | ||
This document defines how to use `linkedin` extension in AsyncAPI documents. | ||
|
||
## Overview | ||
This extension allows you to provide the Linkedin username of the account representing the team/company of the API. | ||
|
||
## Version | ||
Current version is `0.1.0`. | ||
|
||
## Extension Definition | ||
|
||
### Type: String | ||
|
||
URL of the Linkedin Profile of the user or company. | ||
|
||
## Extension Location | ||
|
||
This extension can be used in the following locations: | ||
- [Info Object](https://www.asyncapi.com/docs/reference/specification/v3.0.0#infoObject) | ||
|
||
## Example | ||
|
||
```yaml | ||
asyncapi: '3.0.0' | ||
info | ||
title: AsyncAPI Initiative Example | ||
version: '1.0.0' | ||
x-linkedin: https://www.linkedin.com/company/asyncapi | ||
``` |