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

feat: add security at the operation level #584

Merged
merged 34 commits into from
Apr 14, 2022
Merged
Show file tree
Hide file tree
Changes from 26 commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
9cc3d98
docs: fix example typo (#728)
lejenome Mar 14, 2022
d4ac103
docs: add lejenome as a contributor for doc (#733)
allcontributors[bot] Mar 14, 2022
f353b1c
docs: update README with new logo banner (#732)
pk-218 Mar 14, 2022
a93ec64
chore: add 2022-04-release branch in .releaserc (#737)
smoya Mar 17, 2022
9b8dff9
docs: update release process (#722)
dalelane Mar 17, 2022
bc68645
Update asyncapi.md
sekharbans-ebay Jul 15, 2021
4e7a033
Update asyncapi.md
sekharbans-ebay Jul 30, 2021
975fc86
Update spec/asyncapi.md
sekharbans-ebay Aug 2, 2021
3616061
Update asyncapi.md
sekharbans-ebay Aug 3, 2021
52d01b4
Update asyncapi.md
sekharbans-ebay Aug 3, 2021
521fd58
Update asyncapi.md
sekharbans-ebay Aug 3, 2021
bf3961e
Update asyncapi.md
sekharbans-ebay Jan 3, 2022
3480206
Create operation-security.yml
sekharbans-ebay Jan 5, 2022
7c44dd4
Update examples/operation-security.yml
sekharbans-ebay Jan 6, 2022
8e81651
Update spec/asyncapi.md
sekharbans-ebay Jan 6, 2022
5e3763a
Update spec/asyncapi.md
sekharbans-ebay Jan 6, 2022
4739be1
Update spec/asyncapi.md
sekharbans-ebay Jan 6, 2022
c675782
Create streetlights-operation-security.yml
sekharbans-ebay Jan 25, 2022
b373afd
updated desc for operation security
sekharbans-ebay Mar 22, 2022
fb3b9bf
Update spec/asyncapi.md
sekharbans-ebay Mar 25, 2022
3460840
Update spec/asyncapi.md
sekharbans-ebay Mar 25, 2022
d1e8017
Create multiple-server-security.yml
sekharbans-ebay Mar 30, 2022
4a964f7
Update examples/streetlights-operation-security.yml
sekharbans-ebay Mar 31, 2022
4c3d916
Update examples/streetlights-operation-security.yml
sekharbans-ebay Mar 31, 2022
7a6200f
Update examples/streetlights-operation-security.yml
sekharbans-ebay Mar 31, 2022
f8f9fcb
Update examples/streetlights-operation-security.yml
sekharbans-ebay Mar 31, 2022
9ecf2a9
Merge branch '2022-04-release' into master
sekharbans-ebay Mar 31, 2022
2874072
Update README.md
sekharbans-ebay Apr 8, 2022
a57fb91
Update streetlights-operation-security.yml
sekharbans-ebay Apr 8, 2022
514b5fe
Update streetlights-operation-security.yml
sekharbans-ebay Apr 8, 2022
0d2a2d4
Update examples/operation-security.yml
sekharbans-ebay Apr 11, 2022
9e9463a
Update examples/streetlights-operation-security.yml
sekharbans-ebay Apr 11, 2022
b221433
Delete multiple-server-security.yml
sekharbans-ebay Apr 11, 2022
5a6faeb
Update examples/streetlights-operation-security.yml
sekharbans-ebay Apr 11, 2022
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
9 changes: 9 additions & 0 deletions .all-contributorsrc
Original file line number Diff line number Diff line change
Expand Up @@ -311,6 +311,15 @@
"contributions": [
"doc"
]
},
{
"login": "lejenome",
"name": "Moez Bouhlel",
"avatar_url": "https://avatars.githubusercontent.com/u/2295241?v=4",
"profile": "https://lejenome.tik.tn",
"contributions": [
"doc"
]
}
],
"commitConvention": "none"
Expand Down
61 changes: 61 additions & 0 deletions .github/ISSUE_TEMPLATE/release.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
---
name: Release issue
about: Track the progress of the next release of the AsyncAPI spec
title: ""
labels: ':shipit: Release'
assignees: ''
---

Release X.X.X is scheduled for XXXX

### Detailed info:
* https://github.com/asyncapi/spec/blob/master/RELEASE_PROCESS.md

### Kick-off:
* _link to recording of community call where the new release was started_

### Release branches:
* https://github.com/asyncapi/spec/tree/BRANCH_NAME
* https://github.com/asyncapi/spec-json-schemas/tree/BRANCH_NAME
* https://github.com/asyncapi/parser-js/tree/BRANCH_NAME

### Release notes:
* draft PR - https://github.com/asyncapi/website/pull/PULLREQUEST

### Progress:
- [ ] Create release branches
- [ ] spec
- [ ] spec-json-schemas
- [ ] parser-js
- [ ] Update release branches with new versions
- [ ] spec
- [ ] spec-json-schemas
- [ ] parser-js
- [ ] Update default branches with release branch name
- [ ] spec
- [ ] spec-json-schemas
- [ ] parser-js
- [ ] Create draft release notes
- [ ] Update release branches from forks
- [ ] spec
- [ ] spec-json-schemas
- [ ] parser-js
- [ ] Notify community about release branches
- [ ] Check for potential release contributions
- [ ] Draft announcement blog post for new features and changes
- [ ] Write release notes for new features and changes
- [ ] Prepare pull requests to merge release branches into master
- [ ] spec
- [ ] spec-json-schemas
- [ ] parser-js
- [ ] Notify tsc_members about upcoming release
- [ ] Merge release branches into master
- [ ] spec
- [ ] spec-json-schemas
- [ ] parser-js
- [ ] Write release notes for the releases on Github
- [ ] Create releases on Github
- [ ] spec
- [ ] spec-json-schemas
- [ ] parser-js
- [ ] Update RELEASE_PROCESS doc with any changes
2 changes: 1 addition & 1 deletion .releaserc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
branches:
- master
- name: 2022-01-release
- name: 2022-04-release
prerelease: true
plugins:
- - "@semantic-release/commit-analyzer"
Expand Down
27 changes: 15 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
<h1 align="center">
<br>
<a href="https://www.asyncapi.com"><img src="./assets/logo.png" alt="AsyncAPI logo" height="80"></a>
</h1>
[![AsyncAPI Logo](./assets/logo.png)](https://www.asyncapi.com)

<hr/>

Expand Down Expand Up @@ -43,47 +40,52 @@

The latest draft specification can be found at [spec/asyncapi.md](./spec/asyncapi.md) which tracks the latest commit to the master branch in this repository.

* [Version 2.3.0](https://github.com/asyncapi/spec/blob/v2.3.0/spec/asyncapi.md) (latest)
* [Version 2.2.0](https://github.com/asyncapi/spec/blob/v2.2.0/spec/asyncapi.md)
* [Version 2.1.0](https://github.com/asyncapi/spec/blob/v2.1.0/spec/asyncapi.md)
* [Version 2.0.0](https://github.com/asyncapi/spec/blob/2.0.0/versions/2.0.0/asyncapi.md)
* [Version 1.2.0](https://github.com/asyncapi/spec/blob/1.2.0/README.md) (deprecated)
* [Version 1.1.0](https://github.com/asyncapi/spec/blob/1.1.0/README.md) (deprecated)
* [Version 1.0.0](https://github.com/asyncapi/spec/blob/1.0.0/README.md) (deprecated)
- [Version 2.3.0](https://github.com/asyncapi/spec/blob/v2.3.0/spec/asyncapi.md) (latest)
- [Version 2.2.0](https://github.com/asyncapi/spec/blob/v2.2.0/spec/asyncapi.md)
- [Version 2.1.0](https://github.com/asyncapi/spec/blob/v2.1.0/spec/asyncapi.md)
- [Version 2.0.0](https://github.com/asyncapi/spec/blob/2.0.0/versions/2.0.0/asyncapi.md)
- [Version 1.2.0](https://github.com/asyncapi/spec/blob/1.2.0/README.md) (deprecated)
- [Version 1.1.0](https://github.com/asyncapi/spec/blob/1.1.0/README.md) (deprecated)
- [Version 1.0.0](https://github.com/asyncapi/spec/blob/1.0.0/README.md) (deprecated)

**Looking for the JSON Schema files?** Check out our [spec-json-schemas](https://github.com/asyncapi/spec-json-schemas) repo.

**Feel like contributing?** Check out our [community repo](https://www.github.com/asyncapi/community).


## Examples

#### :bulb: Streetlights

Demonstrates how to use AsyncAPI to define an API that controls city streetlights.

> :point_right: [See more](./examples/streetlights-mqtt.yml)

#### <img src="./assets/slack.png" width="15" alt="Slack icon">&nbsp;&nbsp; Slack Events API

Partial definition of the Slack Events API. Find the official one [here](https://github.com/slackapi/slack-api-specs/blob/master/events-api/slack_events_api_async_v1.json).

> :point_right: [See more](./examples/slack-rtm.yml)

#### <img src="./assets/gitter.png" width="15" alt="Gitter icon">&nbsp;&nbsp; Gitter Streaming API

Definition of the Gitter streaming API.

> :point_right: [See more](./examples/gitter-streaming.yml)

#### <img src="./assets/gemini.svg" width="15" alt="Gemini icon">&nbsp;&nbsp; Gemini WebSocket API

Definition of the Gemini Websocket API.

> :point_right: [See more](./examples/websocket-gemini.yml)

#### :heavy_plus_sign: and more...

Check out the [examples](https://github.com/asyncapi/asyncapi/blob/master/examples) directory for more examples.

## Contributors

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
Expand Down Expand Up @@ -119,6 +121,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
<td align="center"><a href="https://github.com/KhudaDad414"><img src="https://avatars.githubusercontent.com/u/32505158?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Khuda Dad Nomani</b></sub></a><br /><a href="#example-KhudaDad414" title="Examples">💡</a> <a href="https://github.com/asyncapi/spec/issues?q=author%3AKhudaDad414" title="Bug reports">🐛</a></td>
<td align="center"><a href="https://github.com/aaronkorver"><img src="https://avatars.githubusercontent.com/u/8387325?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Aaron Korver</b></sub></a><br /><a href="https://github.com/asyncapi/spec/commits?author=aaronkorver" title="Documentation">📖</a></td>
<td align="center"><a href="https://github.com/xunto"><img src="https://avatars.githubusercontent.com/u/5288053?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Orlov Valentine</b></sub></a><br /><a href="https://github.com/asyncapi/spec/commits?author=xunto" title="Documentation">📖</a></td>
<td align="center"><a href="https://lejenome.tik.tn"><img src="https://avatars.githubusercontent.com/u/2295241?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Moez Bouhlel</b></sub></a><br /><a href="https://github.com/asyncapi/spec/commits?author=lejenome" title="Documentation">📖</a></td>
</tr>
</table>

Expand Down
Loading