@amqp-contract/asyncapi 0.8.0 → 0.9.0
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/docs/index.md +6 -6
- package/package.json +2 -2
package/docs/index.md
CHANGED
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
### AsyncAPIGenerator
|
|
10
10
|
|
|
11
|
-
Defined in: [index.ts:94](https://github.com/btravers/amqp-contract/blob/
|
|
11
|
+
Defined in: [index.ts:94](https://github.com/btravers/amqp-contract/blob/f058a24938d9644a82812e57d7995cb683cfd6b5/packages/asyncapi/src/index.ts#L94)
|
|
12
12
|
|
|
13
13
|
Generator for creating AsyncAPI 3.0 documentation from AMQP contracts.
|
|
14
14
|
|
|
@@ -65,7 +65,7 @@ const asyncapi = await generator.generate(contract, {
|
|
|
65
65
|
new AsyncAPIGenerator(options): AsyncAPIGenerator;
|
|
66
66
|
```
|
|
67
67
|
|
|
68
|
-
Defined in: [index.ts:102](https://github.com/btravers/amqp-contract/blob/
|
|
68
|
+
Defined in: [index.ts:102](https://github.com/btravers/amqp-contract/blob/f058a24938d9644a82812e57d7995cb683cfd6b5/packages/asyncapi/src/index.ts#L102)
|
|
69
69
|
|
|
70
70
|
Create a new AsyncAPI generator instance.
|
|
71
71
|
|
|
@@ -87,7 +87,7 @@ Create a new AsyncAPI generator instance.
|
|
|
87
87
|
generate(contract, options): Promise<AsyncAPIObject>;
|
|
88
88
|
```
|
|
89
89
|
|
|
90
|
-
Defined in: [index.ts:134](https://github.com/btravers/amqp-contract/blob/
|
|
90
|
+
Defined in: [index.ts:134](https://github.com/btravers/amqp-contract/blob/f058a24938d9644a82812e57d7995cb683cfd6b5/packages/asyncapi/src/index.ts#L134)
|
|
91
91
|
|
|
92
92
|
Generate an AsyncAPI 3.0 document from a contract definition.
|
|
93
93
|
|
|
@@ -134,7 +134,7 @@ const asyncapi = await generator.generate(contract, {
|
|
|
134
134
|
type AsyncAPIGeneratorGenerateOptions = Pick<AsyncAPIObject, "info"> & Partial<Pick<AsyncAPIObject, "id" | "servers">>;
|
|
135
135
|
```
|
|
136
136
|
|
|
137
|
-
Defined in: [index.ts:44](https://github.com/btravers/amqp-contract/blob/
|
|
137
|
+
Defined in: [index.ts:44](https://github.com/btravers/amqp-contract/blob/f058a24938d9644a82812e57d7995cb683cfd6b5/packages/asyncapi/src/index.ts#L44)
|
|
138
138
|
|
|
139
139
|
Options for generating an AsyncAPI document.
|
|
140
140
|
These correspond to the top-level AsyncAPI document fields.
|
|
@@ -147,7 +147,7 @@ These correspond to the top-level AsyncAPI document fields.
|
|
|
147
147
|
type AsyncAPIGeneratorOptions = object;
|
|
148
148
|
```
|
|
149
149
|
|
|
150
|
-
Defined in: [index.ts:32](https://github.com/btravers/amqp-contract/blob/
|
|
150
|
+
Defined in: [index.ts:32](https://github.com/btravers/amqp-contract/blob/f058a24938d9644a82812e57d7995cb683cfd6b5/packages/asyncapi/src/index.ts#L32)
|
|
151
151
|
|
|
152
152
|
Options for configuring the AsyncAPI generator.
|
|
153
153
|
|
|
@@ -166,4 +166,4 @@ const generator = new AsyncAPIGenerator({
|
|
|
166
166
|
|
|
167
167
|
| Property | Type | Description | Defined in |
|
|
168
168
|
| ------ | ------ | ------ | ------ |
|
|
169
|
-
| <a id="schemaconverters"></a> `schemaConverters?` | `ConditionalSchemaConverter`[] | Schema converters for transforming validation schemas to JSON Schema. Supports Zod, Valibot, ArkType, and other Standard Schema v1 compatible libraries. | [index.ts:37](https://github.com/btravers/amqp-contract/blob/
|
|
169
|
+
| <a id="schemaconverters"></a> `schemaConverters?` | `ConditionalSchemaConverter`[] | Schema converters for transforming validation schemas to JSON Schema. Supports Zod, Valibot, ArkType, and other Standard Schema v1 compatible libraries. | [index.ts:37](https://github.com/btravers/amqp-contract/blob/f058a24938d9644a82812e57d7995cb683cfd6b5/packages/asyncapi/src/index.ts#L37) |
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@amqp-contract/asyncapi",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.9.0",
|
|
4
4
|
"description": "AsyncAPI specification generator for amqp-contract",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"amqp",
|
|
@@ -51,7 +51,7 @@
|
|
|
51
51
|
"dependencies": {
|
|
52
52
|
"@orpc/openapi": "1.13.2",
|
|
53
53
|
"@standard-schema/spec": "1.1.0",
|
|
54
|
-
"@amqp-contract/contract": "0.
|
|
54
|
+
"@amqp-contract/contract": "0.9.0"
|
|
55
55
|
},
|
|
56
56
|
"devDependencies": {
|
|
57
57
|
"@asyncapi/parser": "3.4.0",
|