@asyncapi/cli 0.25.5 → 0.26.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/assets/examples/anyof.yml +1 -1
- package/assets/examples/application-headers.yml +1 -1
- package/assets/examples/correlation-id.yml +1 -1
- package/assets/examples/examples.json +13 -1
- package/assets/examples/gitter-streaming.yml +2 -2
- package/assets/examples/mercure.yml +1 -1
- package/assets/examples/not.yml +1 -1
- package/assets/examples/oneof.yml +1 -1
- package/assets/examples/operation-security.yml +106 -0
- package/assets/examples/rpc-client.yml +2 -2
- package/assets/examples/rpc-server.yml +2 -2
- package/assets/examples/simple.yml +1 -1
- package/assets/examples/slack-rtm.yml +2 -2
- package/assets/examples/streetlights-kafka.yml +27 -4
- package/assets/examples/streetlights-mqtt.yml +8 -1
- package/assets/examples/streetlights-operation-security.yml +212 -0
- package/assets/examples/tutorial.yml +37 -0
- package/assets/examples/websocket-gemini.yml +1 -1
- package/oclif.manifest.json +1 -1
- package/package.json +2 -2
|
@@ -31,6 +31,10 @@
|
|
|
31
31
|
"name": "Not example",
|
|
32
32
|
"value": "not.yml"
|
|
33
33
|
},
|
|
34
|
+
{
|
|
35
|
+
"name": "Notifications",
|
|
36
|
+
"value": "operation-security.yml"
|
|
37
|
+
},
|
|
34
38
|
{
|
|
35
39
|
"name": "OneOf example",
|
|
36
40
|
"value": "oneof.yml"
|
|
@@ -48,9 +52,17 @@
|
|
|
48
52
|
"value": "slack-rtm.yml"
|
|
49
53
|
},
|
|
50
54
|
{
|
|
51
|
-
"name": "Streetlights
|
|
55
|
+
"name": "Streetlights API Simplified - (protocols: mqtt)",
|
|
56
|
+
"value": "tutorial.yml"
|
|
57
|
+
},
|
|
58
|
+
{
|
|
59
|
+
"name": "Streetlights Kafka API - (protocols: kafka-secure,kafka-secure)",
|
|
52
60
|
"value": "streetlights-kafka.yml"
|
|
53
61
|
},
|
|
62
|
+
{
|
|
63
|
+
"name": "Streetlights Kafka API - (protocols: kafka-secure,kafka-secure)",
|
|
64
|
+
"value": "streetlights-operation-security.yml"
|
|
65
|
+
},
|
|
54
66
|
{
|
|
55
67
|
"name": "Streetlights MQTT API - (protocols: mqtt)",
|
|
56
68
|
"value": "streetlights-mqtt.yml"
|
package/assets/examples/not.yml
CHANGED
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
asyncapi: 2.5.0
|
|
2
|
+
info:
|
|
3
|
+
title: Notifications
|
|
4
|
+
version: 1.0.0
|
|
5
|
+
description: >-
|
|
6
|
+
This contract defines HTTP Push notification for
|
|
7
|
+
application authorization revocation topic
|
|
8
|
+
channels:
|
|
9
|
+
AUTHORIZATION_REVOCATION:
|
|
10
|
+
subscribe:
|
|
11
|
+
message:
|
|
12
|
+
$ref: '#/components/messages/message'
|
|
13
|
+
bindings:
|
|
14
|
+
http:
|
|
15
|
+
type: request
|
|
16
|
+
method: POST
|
|
17
|
+
headers:
|
|
18
|
+
type: object
|
|
19
|
+
properties:
|
|
20
|
+
Content-Type:
|
|
21
|
+
type: string
|
|
22
|
+
enum:
|
|
23
|
+
- application/json
|
|
24
|
+
security:
|
|
25
|
+
- petstore_auth:
|
|
26
|
+
- subscribe:auth_revocations
|
|
27
|
+
components:
|
|
28
|
+
messages:
|
|
29
|
+
message:
|
|
30
|
+
headers:
|
|
31
|
+
type: object
|
|
32
|
+
properties:
|
|
33
|
+
X-SIGNATURE:
|
|
34
|
+
description: ECC message signature
|
|
35
|
+
type: string
|
|
36
|
+
payload:
|
|
37
|
+
type: object
|
|
38
|
+
properties:
|
|
39
|
+
metadata:
|
|
40
|
+
$ref: '#/components/schemas/MetaData'
|
|
41
|
+
notification:
|
|
42
|
+
$ref: '#/components/schemas/Notification'
|
|
43
|
+
schemas:
|
|
44
|
+
MetaData:
|
|
45
|
+
type: object
|
|
46
|
+
properties:
|
|
47
|
+
topic:
|
|
48
|
+
type: string
|
|
49
|
+
description: Topic subscribed to.
|
|
50
|
+
schemaVersion:
|
|
51
|
+
type: string
|
|
52
|
+
description: The schema for this topic.
|
|
53
|
+
deprecated:
|
|
54
|
+
type: boolean
|
|
55
|
+
description: If this is a deprecated schema or topic.
|
|
56
|
+
default: 'false'
|
|
57
|
+
Notification:
|
|
58
|
+
type: object
|
|
59
|
+
properties:
|
|
60
|
+
notificationId:
|
|
61
|
+
type: string
|
|
62
|
+
description: The notification Id.
|
|
63
|
+
eventDate:
|
|
64
|
+
type: string
|
|
65
|
+
description: The event date associated with this notification in UTC.
|
|
66
|
+
publishDate:
|
|
67
|
+
type: string
|
|
68
|
+
description: The message publish date in UTC.
|
|
69
|
+
publishAttemptCount:
|
|
70
|
+
type: integer
|
|
71
|
+
description: The number of attempts made to publish this message.
|
|
72
|
+
data:
|
|
73
|
+
$ref: '#/components/schemas/AuthorizationRevocationData'
|
|
74
|
+
AuthorizationRevocationData:
|
|
75
|
+
type: object
|
|
76
|
+
description: The Authorization Revocation payload.
|
|
77
|
+
properties:
|
|
78
|
+
username:
|
|
79
|
+
type: string
|
|
80
|
+
description: The username for the user.
|
|
81
|
+
userId:
|
|
82
|
+
type: string
|
|
83
|
+
description: The immutable public userId for the user
|
|
84
|
+
eiasToken:
|
|
85
|
+
type: string
|
|
86
|
+
description: The legacy eiasToken specific to the user
|
|
87
|
+
revokeReason:
|
|
88
|
+
type: string
|
|
89
|
+
enum:
|
|
90
|
+
- REVOKED_BY_APP
|
|
91
|
+
- REVOKED_BY_USER
|
|
92
|
+
- REVOKED_BY_ADMIN
|
|
93
|
+
- PASSWORD_CHANGE
|
|
94
|
+
description: The reason for authorization revocation
|
|
95
|
+
revocationDate:
|
|
96
|
+
type: string
|
|
97
|
+
description: Date and time when the authorization was revoked
|
|
98
|
+
securitySchemes:
|
|
99
|
+
petstore_auth:
|
|
100
|
+
type: oauth2
|
|
101
|
+
description: The oauth security descriptions
|
|
102
|
+
flows:
|
|
103
|
+
clientCredentials:
|
|
104
|
+
tokenUrl: 'https://example.com/api/oauth/dialog'
|
|
105
|
+
scopes:
|
|
106
|
+
subscribe:auth_revocations: Scope required for authorization revocation topic
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
asyncapi: '2.
|
|
1
|
+
asyncapi: '2.5.0'
|
|
2
2
|
info:
|
|
3
3
|
title: Streetlights Kafka API
|
|
4
4
|
version: '1.0.0'
|
|
@@ -15,12 +15,32 @@ info:
|
|
|
15
15
|
url: https://www.apache.org/licenses/LICENSE-2.0
|
|
16
16
|
|
|
17
17
|
servers:
|
|
18
|
-
|
|
19
|
-
url: test.mykafkacluster.org:
|
|
18
|
+
scram-connections:
|
|
19
|
+
url: test.mykafkacluster.org:18092
|
|
20
20
|
protocol: kafka-secure
|
|
21
|
-
description: Test broker
|
|
21
|
+
description: Test broker secured with scramSha256
|
|
22
22
|
security:
|
|
23
23
|
- saslScram: []
|
|
24
|
+
tags:
|
|
25
|
+
- name: "env:test-scram"
|
|
26
|
+
description: "This environment is meant for running internal tests through scramSha256"
|
|
27
|
+
- name: "kind:remote"
|
|
28
|
+
description: "This server is a remote server. Not exposed by the application"
|
|
29
|
+
- name: "visibility:private"
|
|
30
|
+
description: "This resource is private and only available to certain users"
|
|
31
|
+
mtls-connections:
|
|
32
|
+
url: test.mykafkacluster.org:28092
|
|
33
|
+
protocol: kafka-secure
|
|
34
|
+
description: Test broker secured with X509
|
|
35
|
+
security:
|
|
36
|
+
- certs: []
|
|
37
|
+
tags:
|
|
38
|
+
- name: "env:test-mtls"
|
|
39
|
+
description: "This environment is meant for running internal tests through mtls"
|
|
40
|
+
- name: "kind:remote"
|
|
41
|
+
description: "This server is a remote server. Not exposed by the application"
|
|
42
|
+
- name: "visibility:private"
|
|
43
|
+
description: "This resource is private and only available to certain users"
|
|
24
44
|
|
|
25
45
|
defaultContentType: application/json
|
|
26
46
|
|
|
@@ -139,6 +159,9 @@ components:
|
|
|
139
159
|
saslScram:
|
|
140
160
|
type: scramSha256
|
|
141
161
|
description: Provide your username and password for SASL/SCRAM authentication
|
|
162
|
+
certs:
|
|
163
|
+
type: X509
|
|
164
|
+
description: Download the certificate files from service provider
|
|
142
165
|
|
|
143
166
|
parameters:
|
|
144
167
|
streetlightId:
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
asyncapi: '2.
|
|
1
|
+
asyncapi: '2.5.0'
|
|
2
2
|
info:
|
|
3
3
|
title: Streetlights MQTT API
|
|
4
4
|
version: '1.0.0'
|
|
@@ -33,6 +33,13 @@ servers:
|
|
|
33
33
|
- streetlights:off
|
|
34
34
|
- streetlights:dim
|
|
35
35
|
- openIdConnectWellKnown: []
|
|
36
|
+
tags:
|
|
37
|
+
- name: "env:production"
|
|
38
|
+
description: "This environment is meant for production use case"
|
|
39
|
+
- name: "kind:remote"
|
|
40
|
+
description: "This server is a remote server. Not exposed by the application"
|
|
41
|
+
- name: "visibility:public"
|
|
42
|
+
description: "This resource is public and available to everyone"
|
|
36
43
|
|
|
37
44
|
defaultContentType: application/json
|
|
38
45
|
|
|
@@ -0,0 +1,212 @@
|
|
|
1
|
+
asyncapi: '2.5.0'
|
|
2
|
+
info:
|
|
3
|
+
title: Streetlights Kafka API
|
|
4
|
+
version: '1.0.0'
|
|
5
|
+
description: |
|
|
6
|
+
The Smartylighting Streetlights API allows you to remotely manage the city lights.
|
|
7
|
+
|
|
8
|
+
### Check out its awesome features:
|
|
9
|
+
|
|
10
|
+
* Turn a specific streetlight on/off 🌃
|
|
11
|
+
* Dim a specific streetlight 😎
|
|
12
|
+
* Receive real-time information about environmental lighting conditions 📈
|
|
13
|
+
license:
|
|
14
|
+
name: Apache 2.0
|
|
15
|
+
url: https://www.apache.org/licenses/LICENSE-2.0
|
|
16
|
+
|
|
17
|
+
servers:
|
|
18
|
+
test:
|
|
19
|
+
url: test.mykafkacluster.org:8092
|
|
20
|
+
protocol: kafka-secure
|
|
21
|
+
description: Test broker
|
|
22
|
+
security:
|
|
23
|
+
- saslScram: []
|
|
24
|
+
test_oauth:
|
|
25
|
+
url: test.mykafkacluster.org:8093
|
|
26
|
+
protocol: kafka-secure
|
|
27
|
+
description: Test port for oauth
|
|
28
|
+
security:
|
|
29
|
+
- streetlights_auth:
|
|
30
|
+
- streetlights:write
|
|
31
|
+
- streetlights:read
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
defaultContentType: application/json
|
|
35
|
+
|
|
36
|
+
channels:
|
|
37
|
+
smartylighting.streetlights.1.0.event.{streetlightId}.lighting.measured:
|
|
38
|
+
description: The topic on which measured values may be produced and consumed.
|
|
39
|
+
servers:
|
|
40
|
+
- test
|
|
41
|
+
parameters:
|
|
42
|
+
streetlightId:
|
|
43
|
+
$ref: '#/components/parameters/streetlightId'
|
|
44
|
+
publish:
|
|
45
|
+
summary: Inform about environmental lighting conditions of a particular streetlight.
|
|
46
|
+
operationId: receiveLightMeasurement
|
|
47
|
+
traits:
|
|
48
|
+
- $ref: '#/components/operationTraits/kafka'
|
|
49
|
+
message:
|
|
50
|
+
$ref: '#/components/messages/lightMeasured'
|
|
51
|
+
|
|
52
|
+
smartylighting.streetlights.1.0.action.{streetlightId}.turn.on:
|
|
53
|
+
servers:
|
|
54
|
+
- test_oauth
|
|
55
|
+
parameters:
|
|
56
|
+
streetlightId:
|
|
57
|
+
$ref: '#/components/parameters/streetlightId'
|
|
58
|
+
subscribe:
|
|
59
|
+
operationId: turnOn
|
|
60
|
+
traits:
|
|
61
|
+
- $ref: '#/components/operationTraits/kafka'
|
|
62
|
+
message:
|
|
63
|
+
$ref: '#/components/messages/turnOnOff'
|
|
64
|
+
security:
|
|
65
|
+
# This operation level security implies the ability to subscribe to messages from
|
|
66
|
+
# `smartylighting.streetlights.1.0.action.{streetlightId}.turn.on` channel with Authorization headers
|
|
67
|
+
# that have `streetlights:read` scope. Note that an operation level security must still satisfy
|
|
68
|
+
# security requirements specified at the server level.
|
|
69
|
+
- streetlights_auth:
|
|
70
|
+
- streetlights:read
|
|
71
|
+
|
|
72
|
+
smartylighting.streetlights.1.0.action.{streetlightId}.turn.off:
|
|
73
|
+
servers:
|
|
74
|
+
- test_oauth
|
|
75
|
+
parameters:
|
|
76
|
+
streetlightId:
|
|
77
|
+
$ref: '#/components/parameters/streetlightId'
|
|
78
|
+
subscribe:
|
|
79
|
+
operationId: turnOff
|
|
80
|
+
traits:
|
|
81
|
+
- $ref: '#/components/operationTraits/kafka'
|
|
82
|
+
message:
|
|
83
|
+
$ref: '#/components/messages/turnOnOff'
|
|
84
|
+
security:
|
|
85
|
+
# This operation level security implies the ability to subscribe to messages from
|
|
86
|
+
# `smartylighting.streetlights.1.0.action.{streetlightId}.turn.off` channel with Authorization headers
|
|
87
|
+
# that have `streetlights:read` scope. Note that an operation level security must still satisfy
|
|
88
|
+
# security options specified at the server level.
|
|
89
|
+
- streetlights_auth:
|
|
90
|
+
- streetlights:read
|
|
91
|
+
smartylighting.streetlights.1.0.action.{streetlightId}.dim:
|
|
92
|
+
servers:
|
|
93
|
+
- test_oauth
|
|
94
|
+
parameters:
|
|
95
|
+
streetlightId:
|
|
96
|
+
$ref: '#/components/parameters/streetlightId'
|
|
97
|
+
subscribe:
|
|
98
|
+
operationId: dimLight
|
|
99
|
+
traits:
|
|
100
|
+
- $ref: '#/components/operationTraits/kafka'
|
|
101
|
+
message:
|
|
102
|
+
$ref: '#/components/messages/dimLight'
|
|
103
|
+
security:
|
|
104
|
+
# This operation level security implies the ability to subscribe to messages from
|
|
105
|
+
# `smartylighting.streetlights.1.0.action.{streetlightId}.dim` channel with Authorization headers
|
|
106
|
+
# that have `streetlights:read` scope. Note that an operation level security must still satisfy
|
|
107
|
+
# security options specified at the server level.
|
|
108
|
+
- streetlights_auth:
|
|
109
|
+
- streetlights:read
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
components:
|
|
113
|
+
messages:
|
|
114
|
+
lightMeasured:
|
|
115
|
+
name: lightMeasured
|
|
116
|
+
title: Light measured
|
|
117
|
+
summary: Inform about environmental lighting conditions of a particular streetlight.
|
|
118
|
+
contentType: application/json
|
|
119
|
+
traits:
|
|
120
|
+
- $ref: '#/components/messageTraits/commonHeaders'
|
|
121
|
+
payload:
|
|
122
|
+
$ref: "#/components/schemas/lightMeasuredPayload"
|
|
123
|
+
turnOnOff:
|
|
124
|
+
name: turnOnOff
|
|
125
|
+
title: Turn on/off
|
|
126
|
+
summary: Command a particular streetlight to turn the lights on or off.
|
|
127
|
+
traits:
|
|
128
|
+
- $ref: '#/components/messageTraits/commonHeaders'
|
|
129
|
+
payload:
|
|
130
|
+
$ref: "#/components/schemas/turnOnOffPayload"
|
|
131
|
+
dimLight:
|
|
132
|
+
name: dimLight
|
|
133
|
+
title: Dim light
|
|
134
|
+
summary: Command a particular streetlight to dim the lights.
|
|
135
|
+
traits:
|
|
136
|
+
- $ref: '#/components/messageTraits/commonHeaders'
|
|
137
|
+
payload:
|
|
138
|
+
$ref: "#/components/schemas/dimLightPayload"
|
|
139
|
+
|
|
140
|
+
schemas:
|
|
141
|
+
lightMeasuredPayload:
|
|
142
|
+
type: object
|
|
143
|
+
properties:
|
|
144
|
+
lumens:
|
|
145
|
+
type: integer
|
|
146
|
+
minimum: 0
|
|
147
|
+
description: Light intensity measured in lumens.
|
|
148
|
+
sentAt:
|
|
149
|
+
$ref: "#/components/schemas/sentAt"
|
|
150
|
+
turnOnOffPayload:
|
|
151
|
+
type: object
|
|
152
|
+
properties:
|
|
153
|
+
command:
|
|
154
|
+
type: string
|
|
155
|
+
enum:
|
|
156
|
+
- on
|
|
157
|
+
- off
|
|
158
|
+
description: Whether to turn on or off the light.
|
|
159
|
+
sentAt:
|
|
160
|
+
$ref: "#/components/schemas/sentAt"
|
|
161
|
+
dimLightPayload:
|
|
162
|
+
type: object
|
|
163
|
+
properties:
|
|
164
|
+
percentage:
|
|
165
|
+
type: integer
|
|
166
|
+
description: Percentage to which the light should be dimmed to.
|
|
167
|
+
minimum: 0
|
|
168
|
+
maximum: 100
|
|
169
|
+
sentAt:
|
|
170
|
+
$ref: "#/components/schemas/sentAt"
|
|
171
|
+
sentAt:
|
|
172
|
+
type: string
|
|
173
|
+
format: date-time
|
|
174
|
+
description: Date and time when the message was sent.
|
|
175
|
+
|
|
176
|
+
securitySchemes:
|
|
177
|
+
saslScram:
|
|
178
|
+
type: scramSha256
|
|
179
|
+
description: Provide your username and password for SASL/SCRAM authentication
|
|
180
|
+
streetlights_auth:
|
|
181
|
+
type: oauth2
|
|
182
|
+
description: The oauth security descriptions
|
|
183
|
+
flows:
|
|
184
|
+
clientCredentials:
|
|
185
|
+
tokenUrl: 'https://example.com/api/oauth/dialog'
|
|
186
|
+
scopes:
|
|
187
|
+
streetlights:read: Scope required for subscribing to channel
|
|
188
|
+
streetlights:write: Scope required for publishing to channel
|
|
189
|
+
|
|
190
|
+
parameters:
|
|
191
|
+
streetlightId:
|
|
192
|
+
description: The ID of the streetlight.
|
|
193
|
+
schema:
|
|
194
|
+
type: string
|
|
195
|
+
|
|
196
|
+
messageTraits:
|
|
197
|
+
commonHeaders:
|
|
198
|
+
headers:
|
|
199
|
+
type: object
|
|
200
|
+
properties:
|
|
201
|
+
my-app-header:
|
|
202
|
+
type: integer
|
|
203
|
+
minimum: 0
|
|
204
|
+
maximum: 100
|
|
205
|
+
|
|
206
|
+
operationTraits:
|
|
207
|
+
kafka:
|
|
208
|
+
bindings:
|
|
209
|
+
kafka:
|
|
210
|
+
clientId:
|
|
211
|
+
type: string
|
|
212
|
+
enum: ['my-app-id']
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
asyncapi: 2.5.0
|
|
2
|
+
info:
|
|
3
|
+
title: Streetlights API Simplified
|
|
4
|
+
version: 1.0.0
|
|
5
|
+
description: |
|
|
6
|
+
The Smartylighting Streetlights API allows you to remotely manage the city lights.
|
|
7
|
+
|
|
8
|
+
This is a simplified version of the Streetlights API from other examples. This version is used in AsyncAPI documentation.
|
|
9
|
+
license:
|
|
10
|
+
name: Apache 2.0
|
|
11
|
+
url: https://www.apache.org/licenses/LICENSE-2.0
|
|
12
|
+
servers:
|
|
13
|
+
mosquitto:
|
|
14
|
+
url: mqtt://test.mosquitto.org
|
|
15
|
+
protocol: mqtt
|
|
16
|
+
channels:
|
|
17
|
+
light/measured:
|
|
18
|
+
publish:
|
|
19
|
+
summary: Inform about environmental lighting conditions for a particular streetlight.
|
|
20
|
+
operationId: onLightMeasured
|
|
21
|
+
message:
|
|
22
|
+
name: LightMeasured
|
|
23
|
+
payload:
|
|
24
|
+
type: object
|
|
25
|
+
properties:
|
|
26
|
+
id:
|
|
27
|
+
type: integer
|
|
28
|
+
minimum: 0
|
|
29
|
+
description: Id of the streetlight.
|
|
30
|
+
lumens:
|
|
31
|
+
type: integer
|
|
32
|
+
minimum: 0
|
|
33
|
+
description: Light intensity measured in lumens.
|
|
34
|
+
sentAt:
|
|
35
|
+
type: string
|
|
36
|
+
format: date-time
|
|
37
|
+
description: Date and time when the message was sent.
|
package/oclif.manifest.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":"0.
|
|
1
|
+
{"version":"0.26.1","commands":{"convert":{"id":"convert","description":"Convert asyncapi documents older to newer versions","strict":true,"pluginName":"@asyncapi/cli","pluginAlias":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false},"output":{"name":"output","type":"option","char":"o","description":"path to the file where the result is saved","multiple":false},"target-version":{"name":"target-version","type":"option","char":"t","description":"asyncapi version to convert to","multiple":false,"default":"2.5.0"}},"args":[{"name":"spec-file","description":"spec path, url, or context-name","required":false}]},"diff":{"id":"diff","description":"Find diff between two asyncapi files","strict":true,"pluginName":"@asyncapi/cli","pluginAlias":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false},"format":{"name":"format","type":"option","char":"f","description":"format of the output","multiple":false,"options":["json","yaml","yml"],"default":"yaml"},"type":{"name":"type","type":"option","char":"t","description":"type of the output","multiple":false,"options":["breaking","non-breaking","unclassified","all"],"default":"all"},"overrides":{"name":"overrides","type":"option","char":"o","description":"path to JSON file containing the override properties","multiple":false},"watch":{"name":"watch","type":"boolean","char":"w","description":"Enable watch mode","allowNo":false}},"args":[{"name":"old","description":"old spec path, URL or context-name","required":true},{"name":"new","description":"new spec path, URL or context-name","required":true}]},"new":{"id":"new","description":"Creates a new asyncapi file","strict":true,"pluginName":"@asyncapi/cli","pluginAlias":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false},"file-name":{"name":"file-name","type":"option","char":"n","description":"name of the file","multiple":false},"example":{"name":"example","type":"option","char":"e","description":"name of the example to use","multiple":false},"studio":{"name":"studio","type":"boolean","char":"s","description":"open in Studio","allowNo":false},"port":{"name":"port","type":"option","char":"p","description":"port in which to start Studio","multiple":false},"no-tty":{"name":"no-tty","type":"boolean","description":"do not use an interactive terminal","allowNo":false}},"args":[]},"validate":{"id":"validate","description":"validate asyncapi file","strict":true,"pluginName":"@asyncapi/cli","pluginAlias":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false},"watch":{"name":"watch","type":"boolean","char":"w","description":"Enable watch mode","allowNo":false}},"args":[{"name":"spec-file","description":"spec path, url, or context-name","required":false}]},"config":{"id":"config","description":"CLI config settings","strict":true,"pluginName":"@asyncapi/cli","pluginAlias":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{},"args":[]},"generate:fromTemplate":{"id":"generate:fromTemplate","description":"Generates whatever you want using templates compatible with AsyncAPI Generator.","strict":true,"pluginName":"@asyncapi/cli","pluginAlias":"@asyncapi/cli","pluginType":"core","aliases":[],"examples":["asyncapi generate fromTemplate asyncapi.yaml @asyncapi/html-template --param version=1.0.0 singleFile=true --output ./docs --force-write"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false},"disable-hook":{"name":"disable-hook","type":"option","char":"d","description":"Disable a specific hook type or hooks from a given hook type","multiple":true},"install":{"name":"install","type":"boolean","char":"i","description":"Installs the template and its dependencies (defaults to false)","allowNo":false},"debug":{"name":"debug","type":"boolean","description":"Enable more specific errors in the console","allowNo":false},"no-overwrite":{"name":"no-overwrite","type":"option","char":"n","description":"Glob or path of the file(s) to skip when regenerating","multiple":true},"output":{"name":"output","type":"option","char":"o","description":"Directory where to put the generated files (defaults to current directory)","multiple":false},"force-write":{"name":"force-write","type":"boolean","description":"Force writing of the generated files to given directory even if it is a git repo with unstaged files or not empty dir (defaults to false)","allowNo":false},"watch":{"name":"watch","type":"boolean","char":"w","description":"Watches the template directory and the AsyncAPI document, and re-generate the files when changes occur. Ignores the output directory.","allowNo":false},"param":{"name":"param","type":"option","char":"p","description":"Additional param to pass to templates","multiple":true},"map-base-url":{"name":"map-base-url","type":"option","description":"Maps all schema references from base url to local folder","multiple":false}},"args":[{"name":"asyncapi","description":"- Local path, url or context-name pointing to AsyncAPI file","required":true},{"name":"template","description":"- Name of the generator template like for example @asyncapi/html-template or https://github.com/asyncapi/html-template","required":true}]},"generate":{"id":"generate","description":"Generate typed models or other things like clients, applications or docs using AsyncAPI Generator templates.","strict":true,"pluginName":"@asyncapi/cli","pluginAlias":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{},"args":[]},"generate:models":{"id":"generate:models","description":"Generates typed models","strict":true,"pluginName":"@asyncapi/cli","pluginAlias":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false},"output":{"name":"output","type":"option","char":"o","description":"The output directory where the models should be written to. Omitting this flag will write the models to `stdout`.","required":false,"multiple":false},"packageName":{"name":"packageName","type":"option","description":"Go and Java specific, define the package to use for the generated models. This is required when language is `go` or `java`.","required":false,"multiple":false},"namespace":{"name":"namespace","type":"option","description":"C# specific, define the namespace to use for the generated models. This is required when language is `csharp`.","required":false,"multiple":false}},"args":[{"name":"language","description":"The language you want the typed models generated for.","required":true,"options":["typescript","csharp","golang","java","javascript","dart"]},{"name":"file","description":"Path or URL to the AsyncAPI document, or context-name","required":true}]},"start":{"id":"start","description":"Start asyncapi studio","strict":true,"pluginName":"@asyncapi/cli","pluginAlias":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{},"args":[]},"start:studio":{"id":"start:studio","description":"starts a new local instance of Studio","strict":true,"pluginName":"@asyncapi/cli","pluginAlias":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false},"file":{"name":"file","type":"option","char":"f","description":"path to the AsyncAPI file to link with Studio","multiple":false},"port":{"name":"port","type":"option","char":"p","description":"port in which to start Studio","multiple":false}},"args":[]},"config:context:add":{"id":"config:context:add","description":"Add or modify a context in the store","strict":true,"pluginName":"@asyncapi/cli","pluginAlias":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false}},"args":[{"name":"context-name","description":"context name","required":true},{"name":"spec-file-path","description":"file path of the spec file","required":true}]},"config:context:current":{"id":"config:context:current","description":"Shows the current context that is being used","strict":true,"pluginName":"@asyncapi/cli","pluginAlias":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false}},"args":[]},"config:context":{"id":"config:context","strict":true,"pluginName":"@asyncapi/cli","pluginAlias":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{},"args":[]},"config:context:list":{"id":"config:context:list","description":"List all the stored context in the store","strict":true,"pluginName":"@asyncapi/cli","pluginAlias":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false}},"args":[]},"config:context:remove":{"id":"config:context:remove","description":"Delete a context from the store","strict":true,"pluginName":"@asyncapi/cli","pluginAlias":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false}},"args":[{"name":"context-name","description":"Name of the context to delete","required":true}]},"config:context:use":{"id":"config:context:use","description":"Set a context as current","strict":true,"pluginName":"@asyncapi/cli","pluginAlias":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false}},"args":[{"name":"context-name","description":"name of the saved context","required":true}]}}}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@asyncapi/cli",
|
|
3
3
|
"description": "All in one CLI for all AsyncAPI tools",
|
|
4
|
-
"version": "0.
|
|
4
|
+
"version": "0.26.1",
|
|
5
5
|
"author": "@asyncapi",
|
|
6
6
|
"bin": {
|
|
7
7
|
"asyncapi": "./bin/run"
|
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
"@asyncapi/generator": "^1.9.12",
|
|
14
14
|
"@asyncapi/modelina": "^0.59.8",
|
|
15
15
|
"@asyncapi/parser": "^1.17.1",
|
|
16
|
-
"@asyncapi/studio": "^0.
|
|
16
|
+
"@asyncapi/studio": "^0.14.0",
|
|
17
17
|
"@oclif/core": "^1.18.0",
|
|
18
18
|
"@oclif/errors": "^1.3.5",
|
|
19
19
|
"@oclif/plugin-not-found": "^2.3.1",
|