@eventcatalog/generator-openapi 7.7.2 → 7.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.
Files changed (10) hide show
  1. package/dist/index.d.mts +1 -0
  2. package/dist/index.d.ts +1 -0
  3. package/dist/index.js +159 -15
  4. package/dist/index.js.map +1 -1
  5. package/dist/index.mjs +159 -15
  6. package/dist/index.mjs.map +1 -1
  7. package/dist/types.d.mts +13 -7
  8. package/dist/types.d.ts +13 -7
  9. package/dist/types.js.map +1 -1
  10. package/package.json +2 -2
package/dist/types.d.mts CHANGED
@@ -70,23 +70,29 @@ interface OpenAPIParameter {
70
70
  schema?: any;
71
71
  description?: string;
72
72
  }
73
+ interface OpenAPIMediaType {
74
+ schema?: any;
75
+ example?: any;
76
+ examples?: {
77
+ [name: string]: {
78
+ summary?: string;
79
+ value: any;
80
+ };
81
+ };
82
+ }
73
83
  interface OpenAPIOperation {
74
84
  operationId?: string;
75
85
  parameters?: OpenAPIParameter[];
76
86
  requestBody?: {
77
87
  content?: {
78
- [contentType: string]: {
79
- schema: any;
80
- };
88
+ [contentType: string]: OpenAPIMediaType;
81
89
  };
82
90
  };
83
91
  responses?: {
84
92
  [statusCode: string]: {
85
93
  isSchema?: boolean;
86
94
  content?: {
87
- [contentType: string]: {
88
- schema: any;
89
- };
95
+ [contentType: string]: OpenAPIMediaType;
90
96
  };
91
97
  };
92
98
  };
@@ -101,4 +107,4 @@ interface OpenAPIDocument {
101
107
  paths: OpenAPIPaths;
102
108
  }
103
109
 
104
- export type { Domain, Message, MessageIdConfig, OpenAPIDocument, OpenAPIOperation, OpenAPIParameter, OpenAPIPathItem, OpenAPIPaths, Operation, Pointer, Service };
110
+ export type { Domain, Message, MessageIdConfig, OpenAPIDocument, OpenAPIMediaType, OpenAPIOperation, OpenAPIParameter, OpenAPIPathItem, OpenAPIPaths, Operation, Pointer, Service };
package/dist/types.d.ts CHANGED
@@ -70,23 +70,29 @@ interface OpenAPIParameter {
70
70
  schema?: any;
71
71
  description?: string;
72
72
  }
73
+ interface OpenAPIMediaType {
74
+ schema?: any;
75
+ example?: any;
76
+ examples?: {
77
+ [name: string]: {
78
+ summary?: string;
79
+ value: any;
80
+ };
81
+ };
82
+ }
73
83
  interface OpenAPIOperation {
74
84
  operationId?: string;
75
85
  parameters?: OpenAPIParameter[];
76
86
  requestBody?: {
77
87
  content?: {
78
- [contentType: string]: {
79
- schema: any;
80
- };
88
+ [contentType: string]: OpenAPIMediaType;
81
89
  };
82
90
  };
83
91
  responses?: {
84
92
  [statusCode: string]: {
85
93
  isSchema?: boolean;
86
94
  content?: {
87
- [contentType: string]: {
88
- schema: any;
89
- };
95
+ [contentType: string]: OpenAPIMediaType;
90
96
  };
91
97
  };
92
98
  };
@@ -101,4 +107,4 @@ interface OpenAPIDocument {
101
107
  paths: OpenAPIPaths;
102
108
  }
103
109
 
104
- export type { Domain, Message, MessageIdConfig, OpenAPIDocument, OpenAPIOperation, OpenAPIParameter, OpenAPIPathItem, OpenAPIPaths, Operation, Pointer, Service };
110
+ export type { Domain, Message, MessageIdConfig, OpenAPIDocument, OpenAPIMediaType, OpenAPIOperation, OpenAPIParameter, OpenAPIPathItem, OpenAPIPaths, Operation, Pointer, Service };
package/dist/types.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"sources":["../src/types.ts"],"sourcesContent":["import { OpenAPIV3_1, OpenAPI } from 'openapi-types';\n\nexport type Domain = {\n id: string;\n name: string;\n version: string;\n owners?: string[];\n generateMarkdown?: ({}: { domain: Domain; markdown: string }) => string;\n draft?: boolean;\n};\n\nexport type Pointer = {\n id: string;\n version?: string;\n};\n\nexport type Service = {\n id: string;\n version?: string;\n name?: string;\n summary?: string;\n path: string | string[];\n owners?: string[];\n setMessageOwnersToServiceOwners?: boolean;\n draft?: boolean;\n writesTo?: Pointer[];\n readsFrom?: Pointer[];\n generateMarkdown?: ({}: { service: Service; document: OpenAPI.Document; markdown: string }) => string;\n headers?: Record<string, string>;\n};\n\nexport type MessageIdConfig = {\n prefix?: string;\n separator?: string;\n prefixWithServiceId?: boolean;\n};\n\nexport type Message = {\n generateMarkdown?: ({}: { operation: Operation; markdown: string }) => string;\n id?: MessageIdConfig;\n};\n\nexport type Operation = {\n path: string;\n method: string;\n operationId: string;\n summary?: string;\n description?: string;\n type: string;\n action: string;\n externalDocs?: OpenAPIV3_1.ExternalDocumentationObject;\n tags: string[];\n extensions?: {\n [key: string]: any;\n };\n deprecated?:\n | boolean\n | {\n date?: string;\n message?: string;\n };\n};\n\nexport interface OpenAPIParameter {\n name: string;\n in: string;\n required?: boolean;\n schema?: any;\n description?: string;\n}\n\nexport interface OpenAPIOperation {\n operationId?: string;\n parameters?: OpenAPIParameter[];\n requestBody?: {\n content?: {\n [contentType: string]: {\n schema: any;\n };\n };\n };\n responses?: {\n [statusCode: string]: {\n isSchema?: boolean;\n content?: {\n [contentType: string]: {\n schema: any;\n };\n };\n };\n };\n}\n\nexport interface OpenAPIPathItem {\n [method: string]: OpenAPIOperation;\n}\n\nexport interface OpenAPIPaths {\n [path: string]: OpenAPIPathItem;\n}\n\nexport interface OpenAPIDocument {\n paths: OpenAPIPaths;\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
1
+ {"version":3,"sources":["../src/types.ts"],"sourcesContent":["import { OpenAPIV3_1, OpenAPI } from 'openapi-types';\n\nexport type Domain = {\n id: string;\n name: string;\n version: string;\n owners?: string[];\n generateMarkdown?: ({}: { domain: Domain; markdown: string }) => string;\n draft?: boolean;\n};\n\nexport type Pointer = {\n id: string;\n version?: string;\n};\n\nexport type Service = {\n id: string;\n version?: string;\n name?: string;\n summary?: string;\n path: string | string[];\n owners?: string[];\n setMessageOwnersToServiceOwners?: boolean;\n draft?: boolean;\n writesTo?: Pointer[];\n readsFrom?: Pointer[];\n generateMarkdown?: ({}: { service: Service; document: OpenAPI.Document; markdown: string }) => string;\n headers?: Record<string, string>;\n};\n\nexport type MessageIdConfig = {\n prefix?: string;\n separator?: string;\n prefixWithServiceId?: boolean;\n};\n\nexport type Message = {\n generateMarkdown?: ({}: { operation: Operation; markdown: string }) => string;\n id?: MessageIdConfig;\n};\n\nexport type Operation = {\n path: string;\n method: string;\n operationId: string;\n summary?: string;\n description?: string;\n type: string;\n action: string;\n externalDocs?: OpenAPIV3_1.ExternalDocumentationObject;\n tags: string[];\n extensions?: {\n [key: string]: any;\n };\n deprecated?:\n | boolean\n | {\n date?: string;\n message?: string;\n };\n};\n\nexport interface OpenAPIParameter {\n name: string;\n in: string;\n required?: boolean;\n schema?: any;\n description?: string;\n}\n\nexport interface OpenAPIMediaType {\n schema?: any;\n example?: any;\n examples?: { [name: string]: { summary?: string; value: any } };\n}\n\nexport interface OpenAPIOperation {\n operationId?: string;\n parameters?: OpenAPIParameter[];\n requestBody?: {\n content?: {\n [contentType: string]: OpenAPIMediaType;\n };\n };\n responses?: {\n [statusCode: string]: {\n isSchema?: boolean;\n content?: {\n [contentType: string]: OpenAPIMediaType;\n };\n };\n };\n}\n\nexport interface OpenAPIPathItem {\n [method: string]: OpenAPIOperation;\n}\n\nexport interface OpenAPIPaths {\n [path: string]: OpenAPIPathItem;\n}\n\nexport interface OpenAPIDocument {\n paths: OpenAPIPaths;\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@eventcatalog/generator-openapi",
3
- "version": "7.7.2",
3
+ "version": "7.9.0",
4
4
  "description": "OpenAPI generator for EventCatalog",
5
5
  "publishConfig": {
6
6
  "access": "public"
@@ -29,7 +29,7 @@
29
29
  "dependencies": {
30
30
  "@apidevtools/swagger-parser": "^10.1.0",
31
31
  "@changesets/cli": "^2.27.7",
32
- "@eventcatalog/sdk": "2.12.1",
32
+ "@eventcatalog/sdk": "2.17.4",
33
33
  "chalk": "4.1.2",
34
34
  "js-yaml": "^4.1.0",
35
35
  "openapi-types": "^12.1.3",