Skip to content

Commit 7801d8e

Browse files
JcabreraCJcabreraC
authored
Merge pull request wazuh#29427 from wazuh/enhancemnet/29242-document-mandatory-fields
Add a required tag to the fields that need it in the request for each…
2 parents 2757c95 + 4b6c0bb commit 7801d8e

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

‎docs/ref/modules/engine/spec.yaml

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -392,6 +392,7 @@ paths:
392392
application/json:
393393
schema:
394394
type: object
395+
required: [policy]
395396
properties:
396397
policy:
397398
$ref: "#/components/schemas/PolicyName"
@@ -435,6 +436,7 @@ paths:
435436
application/json:
436437
schema:
437438
type: object
439+
required: [policy]
438440
properties:
439441
policy:
440442
$ref: "#/components/schemas/PolicyName"
@@ -478,6 +480,7 @@ paths:
478480
application/json:
479481
schema:
480482
type: object
483+
required: [policy]
481484
properties:
482485
policy:
483486
$ref: "#/components/schemas/PolicyName"
@@ -529,6 +532,7 @@ paths:
529532
application/json:
530533
schema:
531534
type: object
535+
required: [policy, asset, namespace]
532536
properties:
533537
policy:
534538
$ref: "#/components/schemas/PolicyName"
@@ -593,6 +597,7 @@ paths:
593597
application/json:
594598
schema:
595599
type: object
600+
required: [policy, asset, namespace]
596601
properties:
597602
policy:
598603
$ref: "#/components/schemas/PolicyName"
@@ -662,6 +667,7 @@ paths:
662667
application/json:
663668
schema:
664669
type: object
670+
required: [policy, namespace]
665671
properties:
666672
policy:
667673
$ref: "#/components/schemas/PolicyName"
@@ -721,6 +727,7 @@ paths:
721727
application/json:
722728
schema:
723729
type: object
730+
required: [policy]
724731
properties:
725732
policy:
726733
$ref: "#/components/schemas/PolicyName"
@@ -938,6 +945,7 @@ paths:
938945
application/json:
939946
schema:
940947
type: object
948+
required: [policy]
941949
properties:
942950
policy:
943951
$ref: "#/components/schemas/PolicyName"
@@ -2406,6 +2414,7 @@ components:
24062414

24072415
ResourcePost_Request:
24082416
type: object
2417+
required: [type, format, content, namespaceid]
24092418
properties:
24102419
type:
24112420
$ref: "#/components/schemas/ResourceType"
@@ -2419,6 +2428,7 @@ components:
24192428

24202429
ResourceGet_Request:
24212430
type: object
2431+
required: [name, format, namespaceid]
24222432
properties:
24232433
name:
24242434
$ref: "#/components/schemas/ResourceName"
@@ -2439,6 +2449,7 @@ components:
24392449

24402450
ResourcePut_Request:
24412451
type: object
2452+
required: [name, format, content, namespaceid]
24422453
properties:
24432454
name:
24442455
$ref: "#/components/schemas/ResourceName"
@@ -2452,6 +2463,7 @@ components:
24522463

24532464
ResourceDelete_Request:
24542465
type: object
2466+
required: [name, namespaceid]
24552467
properties:
24562468
name:
24572469
$ref: "#/components/schemas/ResourceName"
@@ -2460,6 +2472,7 @@ components:
24602472

24612473
ResourceValidate_Request:
24622474
type: object
2475+
required: [name, format, content, namespaceid]
24632476
properties:
24642477
name:
24652478
$ref: "#/components/schemas/ResourceName"
@@ -2547,6 +2560,7 @@ components:
25472560

25482561
PolicyDefaultParentGet_Request:
25492562
type: object
2563+
required: [policy, namespace]
25502564
properties:
25512565
policy:
25522566
$ref: "#/components/schemas/PolicyName"
@@ -2566,6 +2580,7 @@ components:
25662580

25672581
PolicyDefaultParentPost_Request:
25682582
type: object
2583+
required: [policy, namespace, default_parent]
25692584
properties:
25702585
policy:
25712586
$ref: "#/components/schemas/PolicyName"
@@ -2576,6 +2591,7 @@ components:
25762591

25772592
PolicyDefaultParentDelete_Request:
25782593
type: object
2594+
required: [policy, namespace, default_parent]
25792595
properties:
25802596
policy:
25812597
$ref: "#/components/schemas/PolicyName"
@@ -2646,6 +2662,7 @@ components:
26462662

26472663
RoutePost_Request:
26482664
type: object
2665+
required: [name, policy, filter, priority]
26492666
properties:
26502667
name:
26512668
type: string
@@ -2663,13 +2680,15 @@ components:
26632680

26642681
RouteDelete_Request:
26652682
type: object
2683+
required: [name]
26662684
properties:
26672685
name:
26682686
type: string
26692687
description: "Name of the route"
26702688

26712689
RouteGet_Request:
26722690
type: object
2691+
required: [name]
26732692
properties:
26742693
name:
26752694
type: string
@@ -2686,13 +2705,15 @@ components:
26862705

26872706
RouteReload_Request:
26882707
type: object
2708+
required: [name]
26892709
properties:
26902710
name:
26912711
type: string
26922712
description: "Name of the route"
26932713

26942714
RoutePatchPriority_Request:
26952715
type: object
2716+
required: [name, priority]
26962717
properties:
26972718
name:
26982719
type: string
@@ -2721,6 +2742,7 @@ components:
27212742

27222743
EpsUpdate_Request:
27232744
type: object
2745+
required: [eps, refresh_interval]
27242746
properties:
27252747
eps:
27262748
type: integer
@@ -2787,6 +2809,7 @@ components:
27872809

27882810
KVDBGet_Request:
27892811
type: object
2812+
required: [name, key]
27902813
properties:
27912814
name:
27922815
$ref: "#/components/schemas/KVDBName"
@@ -2803,6 +2826,7 @@ components:
28032826

28042827
KVDBSearch_Request:
28052828
type: object
2829+
required: [name, prefix]
28062830
properties:
28072831
name:
28082832
$ref: "#/components/schemas/KVDBName"
@@ -2832,6 +2856,7 @@ components:
28322856

28332857
KVDBDelete_Request:
28342858
type: object
2859+
required: [name, key]
28352860
properties:
28362861
name:
28372862
$ref: "#/components/schemas/KVDBName"
@@ -2840,6 +2865,7 @@ components:
28402865

28412866
KVDBPut_Request:
28422867
type: object
2868+
required: [name, entry]
28432869
properties:
28442870
name:
28452871
$ref: "#/components/schemas/KVDBName"
@@ -2869,6 +2895,7 @@ components:
28692895

28702896
KVDBManagerPost_Request:
28712897
type: object
2898+
required: [name]
28722899
properties:
28732900
name:
28742901
$ref: "#/components/schemas/KVDBName"
@@ -2879,12 +2906,14 @@ components:
28792906

28802907
KVDBManagerDelete_Request:
28812908
type: object
2909+
required: [name]
28822910
properties:
28832911
name:
28842912
$ref: "#/components/schemas/KVDBName"
28852913

28862914
KVDBManagerDump_Request:
28872915
type: object
2916+
required: [name]
28882917
properties:
28892918
name:
28902919
$ref: "#/components/schemas/KVDBName"
@@ -2925,6 +2954,7 @@ components:
29252954

29262955
TesterSessionPost:
29272956
type: object
2957+
required: [name, policy]
29282958
properties:
29292959
name:
29302960
$ref: "#/components/schemas/TesterSessionName"
@@ -2978,6 +3008,7 @@ components:
29783008

29793009
TesterRunPost_Request:
29803010
type: object
3011+
required: [name, ndjson_event]
29813012
properties:
29823013
name:
29833014
$ref: "#/components/schemas/TesterSessionName"
@@ -3023,12 +3054,14 @@ components:
30233054

30243055
TesterSessionReload_Request:
30253056
type: object
3057+
required: [name]
30263058
properties:
30273059
name:
30283060
$ref: "#/components/schemas/TesterSessionName"
30293061

30303062
TesterSessionGet_Request:
30313063
type: object
3064+
required: [name]
30323065
properties:
30333066
name:
30343067
$ref: "#/components/schemas/TesterSessionName"
@@ -3044,6 +3077,7 @@ components:
30443077

30453078
TesterSessionDelete_Request:
30463079
type: object
3080+
required: [name]
30473081
properties:
30483082
name:
30493083
$ref: "#/components/schemas/TesterSessionName"
@@ -3072,6 +3106,7 @@ components:
30723106

30733107
GeoDbPost_Request:
30743108
type: object
3109+
required: [path, type]
30753110
properties:
30763111
path:
30773112
type: string
@@ -3082,6 +3117,7 @@ components:
30823117

30833118
GeoDbDelete_Request:
30843119
type: object
3120+
required: [path]
30853121
properties:
30863122
path:
30873123
type: string
@@ -3100,6 +3136,7 @@ components:
31003136

31013137
GeoDbRemoteUpsert_Request:
31023138
type: object
3139+
required: [path, type, dbUrl, hashUrl]
31033140
properties:
31043141
path:
31053142
type: string

0 commit comments

Comments
 (0)