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.

Sign up for GitHub

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

Jump to bottom

feat: adapt anypointmq bindings to v3 #203

Merged
merged 10 commits into from
Nov 22, 2023
Merged

feat: adapt anypointmq bindings to v3 #203

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
49f0d64
adapt readme
jonaslagoni Jun 13, 2023
d639d12
Merge branch 'next-major-spec' into v3_anypointmq
jonaslagoni Jun 22, 2023
814f5fa
adapt examples and docs
jonaslagoni Jun 22, 2023
51a3a5a
Update anypointmq/README.md
jonaslagoni Jun 22, 2023
5d3b77f
Update anypointmq/README.md
jonaslagoni Jun 22, 2023
683f190
Merge branch 'next-major-spec' into v3_anypointmq
jonaslagoni Jun 27, 2023
95b003c
Merge branch 'next-major-spec' into v3_anypointmq
jonaslagoni Jun 28, 2023
af8b2f7
Merge branch 'next-major-spec' into v3_anypointmq
jonaslagoni Aug 23, 2023
ec3e194
Merge branch 'next-major-spec' into v3_anypointmq
jonaslagoni Sep 13, 2023
a48e1b4
Merge branch 'next-major-spec' into v3_anypointmq
derberg Nov 21, 2023
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
15 changes: 8 additions & 7 deletions anypointmq/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ This document defines how to describe Anypoint MQ-specific information in AsyncA
<a name="version"></a>
## Versions

The version of this bindings specification is `0.0.1`.
The version of this bindings specification is `1.0.0`.
This is also the `bindingVersion` for all binding objects defined by this specification.
In any given binding object, `latest` MAY alternatively be used to refer to the currently latest published version of this bindings specification.

Expand All @@ -28,7 +28,8 @@ The fields of the standard [Server Object](https://github.com/asyncapi/spec/blob
Server Object Field Name | Values for Anypoint MQ Protocol | Description
---|:---|:---
<a name="serverObjectProtocolFieldValueAnypointMQ"></a>`protocol` | `anypointmq` | **REQUIRED**. MUST be `anypointmq` for the scope of this specification.
<a name="serverObjectUrlFieldValueAnypointMQ"></a>`url` | e.g., `https://mq-us-east-1.anypoint.mulesoft.com/api` | **REQUIRED**. MUST be the endpoint URL of the Anypoint MQ Broker REST API _excluding_ the final major version indicator (e.g., `v1`). Valid examples are `https://mq-us-east-1.anypoint.mulesoft.com/api` and `https://mq-eu-central-1.eu1.anypoint.mulesoft.com/api` (and _not_ `https://.../api/v1`).
<a name="serverObjectUrlFieldValueAnypointMQ"></a>`host` | e.g., `https://mq-us-east-1.anypoint.mulesoft.com` | **REQUIRED**. MUST be the endpoint HOST part of the URL of the Anypoint MQ Broker REST API. Valid examples are `https://mq-us-east-1.anypoint.mulesoft.com` and `https://mq-eu-central-1.eu1.anypoint.mulesoft.com` (and _not_ `https://mq-us-east-1.anypoint.mulesoft.com/api`, or `https://.../api/v1`).
<a name="serverObjectUrlFieldValueAnypointMQ"></a>`pathname` | e.g., `/api` | **REQUIRED**. MUST be the endpoint path part of the URL of the Anypoint MQ Broker REST API _excluding_ the final major version indicator (e.g., `v1`). Valid examples are `/api` and (and _not_ `https://.../api/v1`).
<a name="serverObjectProtocolVersionFieldValueAnypointMQ"></a>`protocolVersion` | e.g., `v1` | **OPTIONAL**, defaults to `v1`. If present MUST be the major version indicator of the Anypoint MQ Broker REST API omitted from the `url`, e.g. `v1`.
<a name="serverObjectSecurityFieldValueAnypointMQ"></a>`security` | suitably configured OAuth 2.0 client credentials grant type | **REQUIRED**. Authentication against the MuleSoft-hosted Anypoint MQ message brokers uses the OAuth 2.0 client credentials grant type. At runtime, the client ID and client secret values of an Anypoint MQ client app must be supplied. Also, the OAuth 2.0 scopes are currently not client-configurable. The `security` field of the server object MUST correctly match these constraints.

Expand Down Expand Up @@ -72,7 +73,7 @@ channels:
anypointmq:
destination: user-signup-exchg
destinationType: exchange
bindingVersion: '0.0.1'
bindingVersion: '1.0.0'
subscribe:
#...
```
Expand Down Expand Up @@ -128,7 +129,7 @@ channels:
properties:
messageId:
type: string
bindingVersion: '0.0.1'
bindingVersion: '1.0.0'
```

## Complete Example
Expand Down Expand Up @@ -162,7 +163,7 @@ servers:
- oauthProd: []
bindings:
anypointmq:
bindingVersion: '0.0.1'
bindingVersion: '1.0.0'

channels:
user/signup:
Expand All @@ -172,7 +173,7 @@ channels:
anypointmq:
destination: user-signup-queue
destinationType: fifo-queue
bindingVersion: '0.0.1'
bindingVersion: '1.0.0'
publish:
operationId: signUpUser
description: |
Expand Down Expand Up @@ -201,7 +202,7 @@ channels:
properties:
messageId:
type: string
bindingVersion: '0.0.1'
bindingVersion: '1.0.0'

components:
securitySchemes:
Expand Down