@tolinax/ayoune-interfaces 2024.4.12 → 2024.4.13

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 (2) hide show
  1. package/interfaces/IaYOUneApiAction.d.ts +46 -3
  2. package/package.json +1 -1
package/interfaces/IaYOUneApiAction.d.ts CHANGED
@@ -20,14 +20,55 @@ export interface IBasicAuth {
20
20
  user?: string;
21
21
  pass?: string;
22
22
  }
23
+ interface ISchema {
24
+ type: string;
25
+ items?: ISchema;
26
+ }
27
+ interface IOperation {
28
+ description?: string;
29
+ parameters?: {
30
+ name: string;
31
+ in: string;
32
+ description?: string;
33
+ required?: boolean;
34
+ schema: {
35
+ $ref: string;
36
+ };
37
+ }[];
38
+ responses: {
39
+ [responseCode: string]: {
40
+ description: string;
41
+ content?: {
42
+ [contentType: string]: {
43
+ schema: ISchema;
44
+ };
45
+ };
46
+ };
47
+ };
48
+ }
49
+ interface IPathItem {
50
+ get?: IOperation;
51
+ put?: IOperation;
52
+ post?: IOperation;
53
+ delete?: IOperation;
54
+ options?: IOperation;
55
+ head?: IOperation;
56
+ patch?: IOperation;
57
+ trace?: IOperation;
58
+ }
59
+ interface IOpenApiSpec {
60
+ [path: string]: IPathItem;
61
+ }
23
62
  export interface IaYOUneApiAction extends IDefaultFields {
24
63
  name?: string;
25
- short_description?: string;
64
+ shortDescription?: string;
26
65
  description?: string;
27
66
  method?: string;
28
- namespace?: string;
67
+ nameSpace?: string;
29
68
  modelName?: string;
30
69
  capability?: string;
70
+ action?: string;
71
+ operationId?: string;
31
72
  output?: string;
32
73
  host?: string;
33
74
  endpoint?: string;
@@ -38,6 +79,8 @@ export interface IaYOUneApiAction extends IDefaultFields {
38
79
  body?: string;
39
80
  answer?: string;
40
81
  useBasicAuth?: boolean;
41
- basicauth?: IBasicAuth;
82
+ basicAuth?: IBasicAuth;
42
83
  debug?: boolean;
84
+ responses: IOpenApiSpec;
43
85
  }
86
+ export {};
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@tolinax/ayoune-interfaces",
3
- "version": "2024.4.12",
3
+ "version": "2024.4.13",
4
4
  "description": "Houses TypeScript interfaces for aYOUne",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",