@robinmordasiewicz/f5xc-api-mcp 2.0.13-2601051957 → 2.0.19-2601071557

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 (47) hide show
  1. package/dist/tools/generated/ce_management/index.d.ts.map +1 -1
  2. package/dist/tools/generated/ce_management/index.js +179 -1582
  3. package/dist/tools/generated/ce_management/index.js.map +1 -1
  4. package/dist/tools/generated/dependency-graph.json +2 -265
  5. package/dist/version.d.ts +2 -2
  6. package/dist/version.js +2 -2
  7. package/manifest.json +1 -1
  8. package/package.json +1 -1
  9. package/specs/domains/admin_console_and_ui.json +111 -25
  10. package/specs/domains/ai_services.json +114 -35
  11. package/specs/domains/api.json +1082 -177
  12. package/specs/domains/authentication.json +205 -45
  13. package/specs/domains/bigip.json +593 -101
  14. package/specs/domains/billing_and_usage.json +440 -82
  15. package/specs/domains/blindfold.json +713 -110
  16. package/specs/domains/bot_and_threat_defense.json +359 -65
  17. package/specs/domains/cdn.json +2131 -194
  18. package/specs/domains/ce_management.json +9110 -15844
  19. package/specs/domains/certificates.json +362 -75
  20. package/specs/domains/cloud_infrastructure.json +802 -119
  21. package/specs/domains/container_services.json +613 -95
  22. package/specs/domains/data_and_privacy_security.json +364 -66
  23. package/specs/domains/data_intelligence.json +324 -63
  24. package/specs/domains/ddos.json +766 -159
  25. package/specs/domains/dns.json +820 -161
  26. package/specs/domains/managed_kubernetes.json +455 -85
  27. package/specs/domains/marketplace.json +670 -104
  28. package/specs/domains/network.json +1620 -238
  29. package/specs/domains/network_security.json +1401 -191
  30. package/specs/domains/nginx_one.json +326 -62
  31. package/specs/domains/object_storage.json +49 -15
  32. package/specs/domains/observability.json +999 -147
  33. package/specs/domains/rate_limiting.json +300 -55
  34. package/specs/domains/secops_and_incident_response.json +189 -36
  35. package/specs/domains/service_mesh.json +955 -124
  36. package/specs/domains/shape.json +2150 -397
  37. package/specs/domains/sites.json +3830 -364
  38. package/specs/domains/statistics.json +2117 -235
  39. package/specs/domains/support.json +602 -108
  40. package/specs/domains/telemetry_and_insights.json +753 -79
  41. package/specs/domains/tenant_and_identity.json +1874 -308
  42. package/specs/domains/threat_campaign.json +637 -71
  43. package/specs/domains/users.json +278 -66
  44. package/specs/domains/virtual.json +2803 -260
  45. package/specs/domains/vpm_and_node_management.json +3 -1
  46. package/specs/domains/waf.json +1125 -148
  47. package/specs/index.json +24 -24
@@ -3,121 +3,6 @@
3
3
  * DO NOT EDIT - This file is auto-generated by scripts/generate.ts
4
4
  */
5
5
  export const ce_managementTools = [
6
- {
7
- toolName: "f5xc-api-cemanagement-approve-create",
8
- method: "POST",
9
- path: "/api/register/namespaces/{namespace}/registration/{name}/approve",
10
- operation: "create",
11
- domain: "ce_management",
12
- resource: "approve",
13
- summary: "Registration Approve.",
14
- description: "RegistrationApprove approved pending registration and it can also decommission by changing state to RETIRED.",
15
- pathParameters: [
16
- {
17
- description: 'Name\n\nx-required\nRegistration name (= "r-" + uid) to approve. Registration name is taken from listing pending registrations.',
18
- in: "path",
19
- name: "name",
20
- required: true,
21
- schema: {
22
- type: "string",
23
- },
24
- "x-displayname": "Name",
25
- },
26
- {
27
- description: 'Namespace\n\nx-required\nRegistration namespace, only "system" namespaces is accepted.',
28
- in: "path",
29
- name: "namespace",
30
- required: true,
31
- schema: {
32
- type: "string",
33
- },
34
- "x-displayname": "Namespace",
35
- },
36
- ],
37
- queryParameters: [],
38
- requestBodySchema: {
39
- $ref: "#/components/schemas/registrationApprovalReq",
40
- },
41
- responseSchema: {
42
- $ref: "#/components/schemas/registrationObjectChangeResp",
43
- },
44
- requiredParams: ["body", "name", "namespace"],
45
- operationId: "ves.io.schema.registration.CustomAPI.RegistrationApprove",
46
- tags: ["Infrastructure"],
47
- sourceFile: "domains/ce_management.json",
48
- displayName: null,
49
- dangerLevel: "medium",
50
- sideEffects: {
51
- creates: ["approve"],
52
- },
53
- requiredFields: ["metadata.name", "metadata.namespace", "path.name", "path.namespace"],
54
- confirmationRequired: false,
55
- parameterExamples: {},
56
- validationRules: {},
57
- operationMetadata: {
58
- common_errors: [
59
- {
60
- code: 401,
61
- message: "Authentication required",
62
- solution: "Provide valid API credentials",
63
- },
64
- {
65
- code: 403,
66
- message: "Permission denied",
67
- solution: "Check access permissions for this operation",
68
- },
69
- {
70
- code: 404,
71
- message: "Resource not found",
72
- solution: "Verify resource name, namespace, and path",
73
- },
74
- {
75
- code: 409,
76
- message: "Resource already exists",
77
- solution: "Use different name or update existing resource",
78
- },
79
- {
80
- code: 429,
81
- message: "Rate limit exceeded",
82
- solution: "Wait before retrying the operation",
83
- },
84
- {
85
- code: 500,
86
- message: "Server error",
87
- solution: "Retry operation or contact support",
88
- },
89
- ],
90
- conditions: {
91
- postconditions: ["Approve resource created", "Resource assigned unique identifier"],
92
- prerequisites: ["Active namespace"],
93
- },
94
- confirmation_required: false,
95
- danger_level: "medium",
96
- field_docs: {},
97
- optional_fields: [],
98
- performance_impact: {
99
- latency: "low",
100
- resource_usage: "low",
101
- },
102
- purpose: "Create new approve",
103
- required_fields: ["metadata.name", "metadata.namespace", "path.name", "path.namespace"],
104
- side_effects: {
105
- creates: ["approve"],
106
- },
107
- },
108
- curlExample: null,
109
- dependencies: [
110
- {
111
- domain: "",
112
- fieldPath: "tunnel_type",
113
- inline: false,
114
- required: false,
115
- resourceType: "schema-site-to-site-tunnel",
116
- },
117
- ],
118
- oneOfGroups: [],
119
- subscriptionRequirements: [],
120
- },
121
6
  {
122
7
  toolName: "f5xc-api-cemanagement-fleet-create",
123
8
  method: "POST",
@@ -765,32 +650,43 @@ export const ce_managementTools = [
765
650
  ],
766
651
  },
767
652
  {
768
- toolName: "f5xc-api-cemanagement-get-image-download-url-create",
653
+ toolName: "f5xc-api-cemanagement-network-interface-create",
769
654
  method: "POST",
770
- path: "/api/register/namespaces/system/get-image-download-url",
655
+ path: "/api/config/namespaces/{metadata.namespace}/network_interfaces",
771
656
  operation: "create",
772
657
  domain: "ce_management",
773
- resource: "get-image-download-url",
774
- summary: "GET Image Download URL.",
775
- description: "Returns image download URL for each provider.",
776
- pathParameters: [],
658
+ resource: "network-interface",
659
+ summary: "Create Network Interface.",
660
+ description: "Network interface represents configuration of a network device.\nIt is created by users in system namespace.",
661
+ pathParameters: [
662
+ {
663
+ description: 'Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be ""',
664
+ in: "path",
665
+ name: "metadata.namespace",
666
+ required: true,
667
+ schema: {
668
+ type: "string",
669
+ },
670
+ "x-displayname": "Namespace",
671
+ },
672
+ ],
777
673
  queryParameters: [],
778
674
  requestBodySchema: {
779
- $ref: "#/components/schemas/registrationGetImageDownloadUrlReq",
675
+ $ref: "#/components/schemas/network_interfaceCreateRequest",
780
676
  },
781
677
  responseSchema: {
782
- $ref: "#/components/schemas/registrationGetImageDownloadUrlResp",
678
+ $ref: "#/components/schemas/network_interfaceCreateResponse",
783
679
  },
784
- requiredParams: ["body"],
785
- operationId: "ves.io.schema.registration.CustomAPI.GetImageDownloadUrl",
680
+ requiredParams: ["body", "metadata.namespace"],
681
+ operationId: "ves.io.schema.network_interface.API.Create",
786
682
  tags: ["Other"],
787
683
  sourceFile: "domains/ce_management.json",
788
684
  displayName: null,
789
685
  dangerLevel: "medium",
790
686
  sideEffects: {
791
- creates: ["get-image-download-url"],
687
+ creates: ["network-interface"],
792
688
  },
793
- requiredFields: ["metadata.name", "metadata.namespace"],
689
+ requiredFields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
794
690
  confirmationRequired: false,
795
691
  parameterExamples: {},
796
692
  validationRules: {},
@@ -829,7 +725,7 @@ export const ce_managementTools = [
829
725
  ],
830
726
  conditions: {
831
727
  postconditions: [
832
- "Get-image-download-url resource created",
728
+ "Network-interface resource created",
833
729
  "Resource assigned unique identifier",
834
730
  ],
835
731
  prerequisites: ["Active namespace"],
@@ -842,45 +738,86 @@ export const ce_managementTools = [
842
738
  latency: "low",
843
739
  resource_usage: "low",
844
740
  },
845
- purpose: "Create new get-image-download-url",
846
- required_fields: ["metadata.name", "metadata.namespace"],
741
+ purpose: "Create new network-interface",
742
+ required_fields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
847
743
  side_effects: {
848
- creates: ["get-image-download-url"],
744
+ creates: ["network-interface"],
849
745
  },
850
746
  },
851
747
  curlExample: null,
852
- dependencies: [],
748
+ dependencies: [
749
+ {
750
+ domain: "",
751
+ fieldPath: "",
752
+ inline: false,
753
+ required: false,
754
+ resourceType: "network-interface",
755
+ },
756
+ {
757
+ domain: "",
758
+ fieldPath: "metadata",
759
+ inline: false,
760
+ required: false,
761
+ resourceType: "schema-object-create-meta",
762
+ },
763
+ {
764
+ domain: "",
765
+ fieldPath: "spec",
766
+ inline: false,
767
+ required: false,
768
+ resourceType: "network-interface-create",
769
+ },
770
+ ],
853
771
  oneOfGroups: [],
854
772
  subscriptionRequirements: [],
855
773
  },
856
774
  {
857
- toolName: "f5xc-api-cemanagement-get-registrations-by-token-create",
858
- method: "POST",
859
- path: "/api/register/namespaces/system/get-registrations-by-token",
860
- operation: "create",
775
+ toolName: "f5xc-api-cemanagement-network-interface-delete",
776
+ method: "DELETE",
777
+ path: "/api/config/namespaces/{namespace}/network_interfaces/{name}",
778
+ operation: "delete",
861
779
  domain: "ce_management",
862
- resource: "get-registrations-by-token",
863
- summary: "GET Registration UID by Site Token.",
864
- description: "Returns list of registration uids that are using particular site token.",
865
- pathParameters: [],
780
+ resource: "network-interface",
781
+ summary: "DELETE Network Interface.",
782
+ description: "DELETE the specified network_interface.",
783
+ pathParameters: [
784
+ {
785
+ description: "Name\nName of the configuration object.",
786
+ in: "path",
787
+ name: "name",
788
+ required: true,
789
+ schema: {
790
+ type: "string",
791
+ },
792
+ "x-displayname": "Name",
793
+ },
794
+ {
795
+ description: "Namespace\nNamespace in which the configuration object is present.",
796
+ in: "path",
797
+ name: "namespace",
798
+ required: true,
799
+ schema: {
800
+ type: "string",
801
+ },
802
+ "x-displayname": "Namespace",
803
+ },
804
+ ],
866
805
  queryParameters: [],
867
806
  requestBodySchema: {
868
- $ref: "#/components/schemas/registrationGetRegistrationsBySiteTokenReq",
869
- },
870
- responseSchema: {
871
- $ref: "#/components/schemas/registrationGetRegistrationsBySiteTokenResp",
807
+ $ref: "#/components/schemas/network_interfaceDeleteRequest",
872
808
  },
873
- requiredParams: ["body"],
874
- operationId: "ves.io.schema.registration.CustomAPI.GetRegistrationsBySiteToken",
809
+ responseSchema: {},
810
+ requiredParams: ["body", "name", "namespace"],
811
+ operationId: "ves.io.schema.network_interface.API.Delete",
875
812
  tags: ["Other"],
876
813
  sourceFile: "domains/ce_management.json",
877
814
  displayName: null,
878
- dangerLevel: "medium",
815
+ dangerLevel: "high",
879
816
  sideEffects: {
880
- creates: ["get-registrations-by-token"],
817
+ deletes: ["network-interface", "contained_resources"],
881
818
  },
882
- requiredFields: ["metadata.name", "metadata.namespace"],
883
- confirmationRequired: false,
819
+ requiredFields: ["path.name", "path.namespace"],
820
+ confirmationRequired: true,
884
821
  parameterExamples: {},
885
822
  validationRules: {},
886
823
  operationMetadata: {
@@ -917,1231 +854,58 @@ export const ce_managementTools = [
917
854
  },
918
855
  ],
919
856
  conditions: {
920
- postconditions: [
921
- "Get-registrations-by-token resource created",
922
- "Resource assigned unique identifier",
923
- ],
857
+ postconditions: ["Resource removed from system", "Associated resources may be affected"],
924
858
  prerequisites: ["Active namespace"],
925
859
  },
926
- confirmation_required: false,
927
- danger_level: "medium",
860
+ confirmation_required: true,
861
+ danger_level: "high",
928
862
  field_docs: {},
929
863
  optional_fields: [],
930
864
  performance_impact: {
931
- latency: "low",
932
- resource_usage: "low",
865
+ latency: "high",
866
+ resource_usage: "moderate",
933
867
  },
934
- purpose: "Create new get-registrations-by-token",
935
- required_fields: ["metadata.name", "metadata.namespace"],
868
+ purpose: "Delete network-interface",
869
+ required_fields: ["path.name", "path.namespace"],
936
870
  side_effects: {
937
- creates: ["get-registrations-by-token"],
871
+ deletes: ["network-interface", "contained_resources"],
938
872
  },
939
873
  },
940
874
  curlExample: null,
941
- dependencies: [],
942
- oneOfGroups: [],
943
- subscriptionRequirements: [
875
+ dependencies: [
944
876
  {
945
- addonService: "f5xc_site_management_standard",
946
- displayName: "F5XC Site Management Standard",
877
+ domain: "",
878
+ fieldPath: "",
879
+ inline: false,
947
880
  required: false,
948
- tier: "standard",
881
+ resourceType: "network-interface",
949
882
  },
950
883
  ],
884
+ oneOfGroups: [],
885
+ subscriptionRequirements: [],
951
886
  },
952
887
  {
953
- toolName: "f5xc-api-cemanagement-listregistrationsbystate-create",
954
- method: "POST",
955
- path: "/api/register/namespaces/{namespace}/listregistrationsbystate",
956
- operation: "create",
888
+ toolName: "f5xc-api-cemanagement-network-interface-get",
889
+ method: "GET",
890
+ path: "/api/config/namespaces/{namespace}/network_interfaces/{name}",
891
+ operation: "get",
957
892
  domain: "ce_management",
958
- resource: "listregistrationsbystate",
959
- summary: "List Registrations By State.",
960
- description: "API endpoint for returning Registrations by status, e.g APPROVED, NEW, or RETIRED.",
893
+ resource: "network-interface",
894
+ summary: "GET Network Interface.",
895
+ description: "GET network interface from system namespace.",
961
896
  pathParameters: [
962
897
  {
963
- description: 'Namespace\n\nx-required\nRegistration namespace, only "system" namespaces is accepted.',
964
- in: "path",
965
- name: "namespace",
966
- required: true,
967
- schema: {
968
- type: "string",
969
- },
970
- "x-displayname": "Namespace",
971
- },
972
- ],
973
- queryParameters: [],
974
- requestBodySchema: {
975
- $ref: "#/components/schemas/registrationListStateReq",
976
- },
977
- responseSchema: {
978
- $ref: "#/components/schemas/registrationListResponse",
979
- },
980
- requiredParams: ["body", "namespace"],
981
- operationId: "ves.io.schema.registration.CustomAPI.ListRegistrationsByState",
982
- tags: ["Other"],
983
- sourceFile: "domains/ce_management.json",
984
- displayName: null,
985
- dangerLevel: "medium",
986
- sideEffects: {
987
- creates: ["listregistrationsbystate"],
988
- },
989
- requiredFields: ["metadata.name", "metadata.namespace", "path.namespace"],
990
- confirmationRequired: false,
991
- parameterExamples: {},
992
- validationRules: {},
993
- operationMetadata: {
994
- common_errors: [
995
- {
996
- code: 401,
997
- message: "Authentication required",
998
- solution: "Provide valid API credentials",
999
- },
1000
- {
1001
- code: 403,
1002
- message: "Permission denied",
1003
- solution: "Check access permissions for this operation",
1004
- },
1005
- {
1006
- code: 404,
1007
- message: "Resource not found",
1008
- solution: "Verify resource name, namespace, and path",
1009
- },
1010
- {
1011
- code: 409,
1012
- message: "Resource already exists",
1013
- solution: "Use different name or update existing resource",
1014
- },
1015
- {
1016
- code: 429,
1017
- message: "Rate limit exceeded",
1018
- solution: "Wait before retrying the operation",
1019
- },
1020
- {
1021
- code: 500,
1022
- message: "Server error",
1023
- solution: "Retry operation or contact support",
1024
- },
1025
- ],
1026
- conditions: {
1027
- postconditions: [
1028
- "Listregistrationsbystate resource created",
1029
- "Resource assigned unique identifier",
1030
- ],
1031
- prerequisites: ["Active namespace"],
1032
- },
1033
- confirmation_required: false,
1034
- danger_level: "medium",
1035
- field_docs: {},
1036
- optional_fields: [],
1037
- performance_impact: {
1038
- latency: "low",
1039
- resource_usage: "low",
1040
- },
1041
- purpose: "Create new listregistrationsbystate",
1042
- required_fields: ["metadata.name", "metadata.namespace", "path.namespace"],
1043
- side_effects: {
1044
- creates: ["listregistrationsbystate"],
1045
- },
1046
- },
1047
- curlExample: null,
1048
- dependencies: [],
1049
- oneOfGroups: [],
1050
- subscriptionRequirements: [],
1051
- },
1052
- {
1053
- toolName: "f5xc-api-cemanagement-network-interface-create",
1054
- method: "POST",
1055
- path: "/api/config/namespaces/{metadata.namespace}/network_interfaces",
1056
- operation: "create",
1057
- domain: "ce_management",
1058
- resource: "network-interface",
1059
- summary: "Create Network Interface.",
1060
- description: "Network interface represents configuration of a network device.\nIt is created by users in system namespace.",
1061
- pathParameters: [
1062
- {
1063
- description: 'Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be ""',
1064
- in: "path",
1065
- name: "metadata.namespace",
1066
- required: true,
1067
- schema: {
1068
- type: "string",
1069
- },
1070
- "x-displayname": "Namespace",
1071
- },
1072
- ],
1073
- queryParameters: [],
1074
- requestBodySchema: {
1075
- $ref: "#/components/schemas/network_interfaceCreateRequest",
1076
- },
1077
- responseSchema: {
1078
- $ref: "#/components/schemas/network_interfaceCreateResponse",
1079
- },
1080
- requiredParams: ["body", "metadata.namespace"],
1081
- operationId: "ves.io.schema.network_interface.API.Create",
1082
- tags: ["Other"],
1083
- sourceFile: "domains/ce_management.json",
1084
- displayName: null,
1085
- dangerLevel: "medium",
1086
- sideEffects: {
1087
- creates: ["network-interface"],
1088
- },
1089
- requiredFields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
1090
- confirmationRequired: false,
1091
- parameterExamples: {},
1092
- validationRules: {},
1093
- operationMetadata: {
1094
- common_errors: [
1095
- {
1096
- code: 401,
1097
- message: "Authentication required",
1098
- solution: "Provide valid API credentials",
1099
- },
1100
- {
1101
- code: 403,
1102
- message: "Permission denied",
1103
- solution: "Check access permissions for this operation",
1104
- },
1105
- {
1106
- code: 404,
1107
- message: "Resource not found",
1108
- solution: "Verify resource name, namespace, and path",
1109
- },
1110
- {
1111
- code: 409,
1112
- message: "Resource already exists",
1113
- solution: "Use different name or update existing resource",
1114
- },
1115
- {
1116
- code: 429,
1117
- message: "Rate limit exceeded",
1118
- solution: "Wait before retrying the operation",
1119
- },
1120
- {
1121
- code: 500,
1122
- message: "Server error",
1123
- solution: "Retry operation or contact support",
1124
- },
1125
- ],
1126
- conditions: {
1127
- postconditions: [
1128
- "Network-interface resource created",
1129
- "Resource assigned unique identifier",
1130
- ],
1131
- prerequisites: ["Active namespace"],
1132
- },
1133
- confirmation_required: false,
1134
- danger_level: "medium",
1135
- field_docs: {},
1136
- optional_fields: [],
1137
- performance_impact: {
1138
- latency: "low",
1139
- resource_usage: "low",
1140
- },
1141
- purpose: "Create new network-interface",
1142
- required_fields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
1143
- side_effects: {
1144
- creates: ["network-interface"],
1145
- },
1146
- },
1147
- curlExample: null,
1148
- dependencies: [
1149
- {
1150
- domain: "",
1151
- fieldPath: "",
1152
- inline: false,
1153
- required: false,
1154
- resourceType: "network-interface",
1155
- },
1156
- {
1157
- domain: "",
1158
- fieldPath: "metadata",
1159
- inline: false,
1160
- required: false,
1161
- resourceType: "schema-object-create-meta",
1162
- },
1163
- {
1164
- domain: "",
1165
- fieldPath: "spec",
1166
- inline: false,
1167
- required: false,
1168
- resourceType: "network-interface-create",
1169
- },
1170
- ],
1171
- oneOfGroups: [],
1172
- subscriptionRequirements: [],
1173
- },
1174
- {
1175
- toolName: "f5xc-api-cemanagement-network-interface-delete",
1176
- method: "DELETE",
1177
- path: "/api/config/namespaces/{namespace}/network_interfaces/{name}",
1178
- operation: "delete",
1179
- domain: "ce_management",
1180
- resource: "network-interface",
1181
- summary: "DELETE Network Interface.",
1182
- description: "DELETE the specified network_interface.",
1183
- pathParameters: [
1184
- {
1185
- description: "Name\nName of the configuration object.",
1186
- in: "path",
1187
- name: "name",
1188
- required: true,
1189
- schema: {
1190
- type: "string",
1191
- },
1192
- "x-displayname": "Name",
1193
- },
1194
- {
1195
- description: "Namespace\nNamespace in which the configuration object is present.",
1196
- in: "path",
1197
- name: "namespace",
1198
- required: true,
1199
- schema: {
1200
- type: "string",
1201
- },
1202
- "x-displayname": "Namespace",
1203
- },
1204
- ],
1205
- queryParameters: [],
1206
- requestBodySchema: {
1207
- $ref: "#/components/schemas/network_interfaceDeleteRequest",
1208
- },
1209
- responseSchema: {},
1210
- requiredParams: ["body", "name", "namespace"],
1211
- operationId: "ves.io.schema.network_interface.API.Delete",
1212
- tags: ["Other"],
1213
- sourceFile: "domains/ce_management.json",
1214
- displayName: null,
1215
- dangerLevel: "high",
1216
- sideEffects: {
1217
- deletes: ["network-interface", "contained_resources"],
1218
- },
1219
- requiredFields: ["path.name", "path.namespace"],
1220
- confirmationRequired: true,
1221
- parameterExamples: {},
1222
- validationRules: {},
1223
- operationMetadata: {
1224
- common_errors: [
1225
- {
1226
- code: 401,
1227
- message: "Authentication required",
1228
- solution: "Provide valid API credentials",
1229
- },
1230
- {
1231
- code: 403,
1232
- message: "Permission denied",
1233
- solution: "Check access permissions for this operation",
1234
- },
1235
- {
1236
- code: 404,
1237
- message: "Resource not found",
1238
- solution: "Verify resource name, namespace, and path",
1239
- },
1240
- {
1241
- code: 409,
1242
- message: "Resource already exists",
1243
- solution: "Use different name or update existing resource",
1244
- },
1245
- {
1246
- code: 429,
1247
- message: "Rate limit exceeded",
1248
- solution: "Wait before retrying the operation",
1249
- },
1250
- {
1251
- code: 500,
1252
- message: "Server error",
1253
- solution: "Retry operation or contact support",
1254
- },
1255
- ],
1256
- conditions: {
1257
- postconditions: ["Resource removed from system", "Associated resources may be affected"],
1258
- prerequisites: ["Active namespace"],
1259
- },
1260
- confirmation_required: true,
1261
- danger_level: "high",
1262
- field_docs: {},
1263
- optional_fields: [],
1264
- performance_impact: {
1265
- latency: "high",
1266
- resource_usage: "moderate",
1267
- },
1268
- purpose: "Delete network-interface",
1269
- required_fields: ["path.name", "path.namespace"],
1270
- side_effects: {
1271
- deletes: ["network-interface", "contained_resources"],
1272
- },
1273
- },
1274
- curlExample: null,
1275
- dependencies: [
1276
- {
1277
- domain: "",
1278
- fieldPath: "",
1279
- inline: false,
1280
- required: false,
1281
- resourceType: "network-interface",
1282
- },
1283
- ],
1284
- oneOfGroups: [],
1285
- subscriptionRequirements: [],
1286
- },
1287
- {
1288
- toolName: "f5xc-api-cemanagement-network-interface-get",
1289
- method: "GET",
1290
- path: "/api/config/namespaces/{namespace}/network_interfaces/{name}",
1291
- operation: "get",
1292
- domain: "ce_management",
1293
- resource: "network-interface",
1294
- summary: "GET Network Interface.",
1295
- description: "GET network interface from system namespace.",
1296
- pathParameters: [
1297
- {
1298
- description: "Name\nThe name of the configuration object to be fetched.",
1299
- in: "path",
1300
- name: "name",
1301
- required: true,
1302
- schema: {
1303
- type: "string",
1304
- },
1305
- "x-displayname": "Name",
1306
- },
1307
- {
1308
- description: "Namespace\nThe namespace in which the configuration object is present.",
1309
- in: "path",
1310
- name: "namespace",
1311
- required: true,
1312
- schema: {
1313
- type: "string",
1314
- },
1315
- "x-displayname": "Namespace",
1316
- },
1317
- ],
1318
- queryParameters: [
1319
- {
1320
- description: "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referrred by this object.",
1321
- in: "query",
1322
- name: "response_format",
1323
- required: false,
1324
- schema: {
1325
- default: "GET_RSP_FORMAT_DEFAULT",
1326
- enum: [
1327
- "GET_RSP_FORMAT_DEFAULT",
1328
- "GET_RSP_FORMAT_FOR_CREATE",
1329
- "GET_RSP_FORMAT_FOR_REPLACE",
1330
- "GET_RSP_FORMAT_STATUS",
1331
- "GET_RSP_FORMAT_READ",
1332
- "GET_RSP_FORMAT_REFERRING_OBJECTS",
1333
- "GET_RSP_FORMAT_BROKEN_REFERENCES",
1334
- ],
1335
- type: "string",
1336
- },
1337
- "x-displayname": "Broken Referred Objects.",
1338
- },
1339
- ],
1340
- requestBodySchema: null,
1341
- responseSchema: {
1342
- $ref: "#/components/schemas/network_interfaceGetResponse",
1343
- },
1344
- requiredParams: ["name", "namespace"],
1345
- operationId: "ves.io.schema.network_interface.API.Get",
1346
- tags: ["Other"],
1347
- sourceFile: "domains/ce_management.json",
1348
- displayName: null,
1349
- dangerLevel: "low",
1350
- sideEffects: null,
1351
- requiredFields: ["path.name", "path.namespace"],
1352
- confirmationRequired: false,
1353
- parameterExamples: {},
1354
- validationRules: {},
1355
- operationMetadata: {
1356
- common_errors: [
1357
- {
1358
- code: 401,
1359
- message: "Authentication required",
1360
- solution: "Provide valid API credentials",
1361
- },
1362
- {
1363
- code: 403,
1364
- message: "Permission denied",
1365
- solution: "Check access permissions for this operation",
1366
- },
1367
- {
1368
- code: 404,
1369
- message: "Resource not found",
1370
- solution: "Verify resource name, namespace, and path",
1371
- },
1372
- {
1373
- code: 409,
1374
- message: "Resource already exists",
1375
- solution: "Use different name or update existing resource",
1376
- },
1377
- {
1378
- code: 429,
1379
- message: "Rate limit exceeded",
1380
- solution: "Wait before retrying the operation",
1381
- },
1382
- {
1383
- code: 500,
1384
- message: "Server error",
1385
- solution: "Retry operation or contact support",
1386
- },
1387
- ],
1388
- conditions: {
1389
- postconditions: [],
1390
- prerequisites: ["Active namespace"],
1391
- },
1392
- confirmation_required: false,
1393
- danger_level: "low",
1394
- field_docs: {},
1395
- optional_fields: [],
1396
- performance_impact: {
1397
- latency: "low",
1398
- resource_usage: "low",
1399
- },
1400
- purpose: "Retrieve specific network-interface",
1401
- required_fields: ["path.name", "path.namespace"],
1402
- side_effects: {},
1403
- },
1404
- curlExample: null,
1405
- dependencies: [],
1406
- oneOfGroups: [],
1407
- subscriptionRequirements: [],
1408
- },
1409
- {
1410
- toolName: "f5xc-api-cemanagement-network-interface-list",
1411
- method: "GET",
1412
- path: "/api/config/namespaces/{namespace}/network_interfaces",
1413
- operation: "list",
1414
- domain: "ce_management",
1415
- resource: "network-interface",
1416
- summary: "List Network Interface.",
1417
- description: "List the set of network_interface in a namespace.",
1418
- pathParameters: [
1419
- {
1420
- description: "Namespace\nNamespace to scope the listing of network_interface.",
1421
- in: "path",
1422
- name: "namespace",
1423
- required: true,
1424
- schema: {
1425
- type: "string",
1426
- },
1427
- "x-displayname": "Namespace",
1428
- },
1429
- ],
1430
- queryParameters: [
1431
- {
1432
- description: "A LabelSelectorType expression that every item in list response will satisfy.",
1433
- in: "query",
1434
- name: "label_filter",
1435
- required: false,
1436
- schema: {
1437
- type: "string",
1438
- },
1439
- "x-displayname": "Label Filter.",
1440
- },
1441
- {
1442
- description: 'X-example: ""\nExtra fields to return along with summary fields.',
1443
- in: "query",
1444
- name: "report_fields",
1445
- required: false,
1446
- schema: {
1447
- items: {
1448
- type: "string",
1449
- },
1450
- type: "array",
1451
- },
1452
- "x-displayname": "Report Fields.",
1453
- },
1454
- {
1455
- description: 'X-example: ""\nExtra status fields to return along with summary fields.',
1456
- in: "query",
1457
- name: "report_status_fields",
1458
- required: false,
1459
- schema: {
1460
- items: {
1461
- type: "string",
1462
- },
1463
- type: "array",
1464
- },
1465
- "x-displayname": "Report Status Fields.",
1466
- },
1467
- ],
1468
- requestBodySchema: null,
1469
- responseSchema: {
1470
- $ref: "#/components/schemas/network_interfaceListResponse",
1471
- },
1472
- requiredParams: ["namespace"],
1473
- operationId: "ves.io.schema.network_interface.API.List",
1474
- tags: ["Other"],
1475
- sourceFile: "domains/ce_management.json",
1476
- displayName: null,
1477
- dangerLevel: "low",
1478
- sideEffects: null,
1479
- requiredFields: ["path.namespace"],
1480
- confirmationRequired: false,
1481
- parameterExamples: {},
1482
- validationRules: {},
1483
- operationMetadata: {
1484
- common_errors: [
1485
- {
1486
- code: 401,
1487
- message: "Authentication required",
1488
- solution: "Provide valid API credentials",
1489
- },
1490
- {
1491
- code: 403,
1492
- message: "Permission denied",
1493
- solution: "Check access permissions for this operation",
1494
- },
1495
- {
1496
- code: 404,
1497
- message: "Resource not found",
1498
- solution: "Verify resource name, namespace, and path",
1499
- },
1500
- {
1501
- code: 409,
1502
- message: "Resource already exists",
1503
- solution: "Use different name or update existing resource",
1504
- },
1505
- {
1506
- code: 429,
1507
- message: "Rate limit exceeded",
1508
- solution: "Wait before retrying the operation",
1509
- },
1510
- {
1511
- code: 500,
1512
- message: "Server error",
1513
- solution: "Retry operation or contact support",
1514
- },
1515
- ],
1516
- conditions: {
1517
- postconditions: [],
1518
- prerequisites: ["Active namespace"],
1519
- },
1520
- confirmation_required: false,
1521
- danger_level: "low",
1522
- field_docs: {},
1523
- optional_fields: [],
1524
- performance_impact: {
1525
- latency: "moderate",
1526
- resource_usage: "moderate",
1527
- },
1528
- purpose: "List all network-interfaces",
1529
- required_fields: ["path.namespace"],
1530
- side_effects: {},
1531
- },
1532
- curlExample: null,
1533
- dependencies: [],
1534
- oneOfGroups: [],
1535
- subscriptionRequirements: [],
1536
- },
1537
- {
1538
- toolName: "f5xc-api-cemanagement-network-interface-update",
1539
- method: "PUT",
1540
- path: "/api/config/namespaces/{metadata.namespace}/network_interfaces/{metadata.name}",
1541
- operation: "update",
1542
- domain: "ce_management",
1543
- resource: "network-interface",
1544
- summary: "Replace Network Interface.",
1545
- description: "Network interface represents configuration of a network device.\nReplace network interface will replace the contents of given network interface object.",
1546
- pathParameters: [
1547
- {
1548
- description: "Name\nThe configuration object to be replaced will be looked up by name.",
1549
- in: "path",
1550
- name: "metadata.name",
1551
- required: true,
1552
- schema: {
1553
- type: "string",
1554
- },
1555
- "x-displayname": "Name",
1556
- },
1557
- {
1558
- description: 'Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be ""',
1559
- in: "path",
1560
- name: "metadata.namespace",
1561
- required: true,
1562
- schema: {
1563
- type: "string",
1564
- },
1565
- "x-displayname": "Namespace",
1566
- },
1567
- ],
1568
- queryParameters: [],
1569
- requestBodySchema: {
1570
- $ref: "#/components/schemas/network_interfaceReplaceRequest",
1571
- },
1572
- responseSchema: {
1573
- $ref: "#/components/schemas/network_interfaceReplaceResponse",
1574
- },
1575
- requiredParams: ["body", "metadata.name", "metadata.namespace"],
1576
- operationId: "ves.io.schema.network_interface.API.Replace",
1577
- tags: ["Other"],
1578
- sourceFile: "domains/ce_management.json",
1579
- displayName: null,
1580
- dangerLevel: "medium",
1581
- sideEffects: {
1582
- modifies: ["network-interface"],
1583
- },
1584
- requiredFields: ["path.metadata.name", "path.metadata.namespace"],
1585
- confirmationRequired: false,
1586
- parameterExamples: {},
1587
- validationRules: {},
1588
- operationMetadata: {
1589
- common_errors: [
1590
- {
1591
- code: 401,
1592
- message: "Authentication required",
1593
- solution: "Provide valid API credentials",
1594
- },
1595
- {
1596
- code: 403,
1597
- message: "Permission denied",
1598
- solution: "Check access permissions for this operation",
1599
- },
1600
- {
1601
- code: 404,
1602
- message: "Resource not found",
1603
- solution: "Verify resource name, namespace, and path",
1604
- },
1605
- {
1606
- code: 409,
1607
- message: "Resource already exists",
1608
- solution: "Use different name or update existing resource",
1609
- },
1610
- {
1611
- code: 429,
1612
- message: "Rate limit exceeded",
1613
- solution: "Wait before retrying the operation",
1614
- },
1615
- {
1616
- code: 500,
1617
- message: "Server error",
1618
- solution: "Retry operation or contact support",
1619
- },
1620
- ],
1621
- conditions: {
1622
- postconditions: ["Resource updated with new values"],
1623
- prerequisites: ["Active namespace"],
1624
- },
1625
- confirmation_required: false,
1626
- danger_level: "medium",
1627
- field_docs: {},
1628
- optional_fields: [],
1629
- performance_impact: {
1630
- latency: "low",
1631
- resource_usage: "low",
1632
- },
1633
- purpose: "Replace existing network-interface",
1634
- required_fields: ["path.metadata.name", "path.metadata.namespace"],
1635
- side_effects: {
1636
- modifies: ["network-interface"],
1637
- },
1638
- },
1639
- curlExample: null,
1640
- dependencies: [
1641
- {
1642
- domain: "",
1643
- fieldPath: "",
1644
- inline: false,
1645
- required: false,
1646
- resourceType: "network-interface",
1647
- },
1648
- {
1649
- domain: "",
1650
- fieldPath: "metadata",
1651
- inline: false,
1652
- required: false,
1653
- resourceType: "schema-object-replace-meta",
1654
- },
1655
- {
1656
- domain: "",
1657
- fieldPath: "spec",
1658
- inline: false,
1659
- required: false,
1660
- resourceType: "network-interface-replace",
1661
- },
1662
- ],
1663
- oneOfGroups: [],
1664
- subscriptionRequirements: [],
1665
- },
1666
- {
1667
- toolName: "f5xc-api-cemanagement-pre-upgrade-check-get",
1668
- method: "GET",
1669
- path: "/api/maurice/namespaces/{namespace}/sites/{name}/pre_upgrade_check",
1670
- operation: "get",
1671
- domain: "ce_management",
1672
- resource: "pre-upgrade-check",
1673
- summary: "Pre upgrade check.",
1674
- description: "API to check if site is ready for upgrade.",
1675
- pathParameters: [
1676
- {
1677
- description: "Name\nFetch upgrade status for the name of site.",
1678
- in: "path",
1679
- name: "name",
1680
- required: true,
1681
- schema: {
1682
- type: "string",
1683
- },
1684
- "x-displayname": "Site Name",
1685
- },
1686
- {
1687
- description: "Namespace\nFetch upgrade status for the given namespace.",
1688
- in: "path",
1689
- name: "namespace",
1690
- required: true,
1691
- schema: {
1692
- type: "string",
1693
- },
1694
- "x-displayname": "Namespace",
1695
- },
1696
- ],
1697
- queryParameters: [
1698
- {
1699
- description: "Software version to upgrade to.",
1700
- in: "query",
1701
- name: "sw_version",
1702
- required: false,
1703
- schema: {
1704
- type: "string",
1705
- },
1706
- "x-displayname": "SW Version to upgrade to.",
1707
- },
1708
- ],
1709
- requestBodySchema: null,
1710
- responseSchema: {
1711
- $ref: "#/components/schemas/upgrade_statusPreUpgradeCheckResponse",
1712
- },
1713
- requiredParams: ["name", "namespace"],
1714
- operationId: "ves.io.schema.upgrade_status.UpgradeStatusCustomApi.PreUpgradeCheck",
1715
- tags: ["Other"],
1716
- sourceFile: "domains/ce_management.json",
1717
- displayName: null,
1718
- dangerLevel: "low",
1719
- sideEffects: null,
1720
- requiredFields: ["path.name", "path.namespace"],
1721
- confirmationRequired: false,
1722
- parameterExamples: {},
1723
- validationRules: {},
1724
- operationMetadata: {
1725
- common_errors: [
1726
- {
1727
- code: 401,
1728
- message: "Authentication required",
1729
- solution: "Provide valid API credentials",
1730
- },
1731
- {
1732
- code: 403,
1733
- message: "Permission denied",
1734
- solution: "Check access permissions for this operation",
1735
- },
1736
- {
1737
- code: 404,
1738
- message: "Resource not found",
1739
- solution: "Verify resource name, namespace, and path",
1740
- },
1741
- {
1742
- code: 409,
1743
- message: "Resource already exists",
1744
- solution: "Use different name or update existing resource",
1745
- },
1746
- {
1747
- code: 429,
1748
- message: "Rate limit exceeded",
1749
- solution: "Wait before retrying the operation",
1750
- },
1751
- {
1752
- code: 500,
1753
- message: "Server error",
1754
- solution: "Retry operation or contact support",
1755
- },
1756
- ],
1757
- conditions: {
1758
- postconditions: [],
1759
- prerequisites: ["Active namespace"],
1760
- },
1761
- confirmation_required: false,
1762
- danger_level: "low",
1763
- field_docs: {},
1764
- optional_fields: [],
1765
- performance_impact: {
1766
- latency: "moderate",
1767
- resource_usage: "moderate",
1768
- },
1769
- purpose: "Retrieve specific pre-upgrade-check",
1770
- required_fields: ["path.name", "path.namespace"],
1771
- side_effects: {},
1772
- },
1773
- curlExample: null,
1774
- dependencies: [],
1775
- oneOfGroups: [],
1776
- subscriptionRequirements: [],
1777
- },
1778
- {
1779
- toolName: "f5xc-api-cemanagement-registerbootstrap-create",
1780
- method: "POST",
1781
- path: "/api/register/registerBootstrap",
1782
- operation: "create",
1783
- domain: "ce_management",
1784
- resource: "registerBootstrap",
1785
- summary: "Registration Create.",
1786
- description: "Registration request to create registration is sent by the node on first boot. User never creates registration on her own.",
1787
- pathParameters: [],
1788
- queryParameters: [],
1789
- requestBodySchema: {
1790
- $ref: "#/components/schemas/registrationRegistrationCreateRequest",
1791
- },
1792
- responseSchema: {
1793
- $ref: "#/components/schemas/registrationObject",
1794
- },
1795
- requiredParams: ["body"],
1796
- operationId: "ves.io.schema.registration.CustomAPI.RegistrationCreate",
1797
- tags: ["Other"],
1798
- sourceFile: "domains/ce_management.json",
1799
- displayName: null,
1800
- dangerLevel: "medium",
1801
- sideEffects: {
1802
- creates: ["registerBootstrap"],
1803
- },
1804
- requiredFields: ["metadata.name", "metadata.namespace"],
1805
- confirmationRequired: false,
1806
- parameterExamples: {},
1807
- validationRules: {},
1808
- operationMetadata: {
1809
- common_errors: [
1810
- {
1811
- code: 401,
1812
- message: "Authentication required",
1813
- solution: "Provide valid API credentials",
1814
- },
1815
- {
1816
- code: 403,
1817
- message: "Permission denied",
1818
- solution: "Check access permissions for this operation",
1819
- },
1820
- {
1821
- code: 404,
1822
- message: "Resource not found",
1823
- solution: "Verify resource name, namespace, and path",
1824
- },
1825
- {
1826
- code: 409,
1827
- message: "Resource already exists",
1828
- solution: "Use different name or update existing resource",
1829
- },
1830
- {
1831
- code: 429,
1832
- message: "Rate limit exceeded",
1833
- solution: "Wait before retrying the operation",
1834
- },
1835
- {
1836
- code: 500,
1837
- message: "Server error",
1838
- solution: "Retry operation or contact support",
1839
- },
1840
- ],
1841
- conditions: {
1842
- postconditions: [
1843
- "Registerbootstrap resource created",
1844
- "Resource assigned unique identifier",
1845
- ],
1846
- prerequisites: [],
1847
- },
1848
- confirmation_required: false,
1849
- danger_level: "medium",
1850
- field_docs: {},
1851
- optional_fields: [],
1852
- performance_impact: {
1853
- latency: "low",
1854
- resource_usage: "low",
1855
- },
1856
- purpose: "Create new registerBootstrap",
1857
- required_fields: ["metadata.name", "metadata.namespace"],
1858
- side_effects: {
1859
- creates: ["registerBootstrap"],
1860
- },
1861
- },
1862
- curlExample: null,
1863
- dependencies: [
1864
- {
1865
- domain: "",
1866
- fieldPath: "",
1867
- inline: false,
1868
- required: false,
1869
- resourceType: "registration-registration",
1870
- },
1871
- {
1872
- domain: "",
1873
- fieldPath: "metadata",
1874
- inline: false,
1875
- required: false,
1876
- resourceType: "schema-object-create-meta",
1877
- },
1878
- {
1879
- domain: "",
1880
- fieldPath: "spec",
1881
- inline: false,
1882
- required: false,
1883
- resourceType: "schemaregistration-create",
1884
- },
1885
- ],
1886
- oneOfGroups: [],
1887
- subscriptionRequirements: [],
1888
- },
1889
- {
1890
- toolName: "f5xc-api-cemanagement-registration-create",
1891
- method: "POST",
1892
- path: "/api/register/namespaces/{metadata.namespace}/registrations",
1893
- operation: "create",
1894
- domain: "ce_management",
1895
- resource: "registration",
1896
- summary: "Create Registration.",
1897
- description: "VPM creates registration using this message, never used by users.",
1898
- pathParameters: [
1899
- {
1900
- description: 'Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be ""',
1901
- in: "path",
1902
- name: "metadata.namespace",
1903
- required: true,
1904
- schema: {
1905
- type: "string",
1906
- },
1907
- "x-displayname": "Namespace",
1908
- },
1909
- ],
1910
- queryParameters: [],
1911
- requestBodySchema: {
1912
- $ref: "#/components/schemas/registrationCreateRequest",
1913
- },
1914
- responseSchema: {
1915
- $ref: "#/components/schemas/registrationCreateResponse",
1916
- },
1917
- requiredParams: ["body", "metadata.namespace"],
1918
- operationId: "ves.io.schema.registration.API.Create",
1919
- tags: ["Other"],
1920
- sourceFile: "domains/ce_management.json",
1921
- displayName: null,
1922
- dangerLevel: "medium",
1923
- sideEffects: {
1924
- creates: ["registration"],
1925
- },
1926
- requiredFields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
1927
- confirmationRequired: false,
1928
- parameterExamples: {},
1929
- validationRules: {},
1930
- operationMetadata: {
1931
- common_errors: [
1932
- {
1933
- code: 401,
1934
- message: "Authentication required",
1935
- solution: "Provide valid API credentials",
1936
- },
1937
- {
1938
- code: 403,
1939
- message: "Permission denied",
1940
- solution: "Check access permissions for this operation",
1941
- },
1942
- {
1943
- code: 404,
1944
- message: "Resource not found",
1945
- solution: "Verify resource name, namespace, and path",
1946
- },
1947
- {
1948
- code: 409,
1949
- message: "Resource already exists",
1950
- solution: "Use different name or update existing resource",
1951
- },
1952
- {
1953
- code: 429,
1954
- message: "Rate limit exceeded",
1955
- solution: "Wait before retrying the operation",
1956
- },
1957
- {
1958
- code: 500,
1959
- message: "Server error",
1960
- solution: "Retry operation or contact support",
1961
- },
1962
- ],
1963
- conditions: {
1964
- postconditions: ["Registration resource created", "Resource assigned unique identifier"],
1965
- prerequisites: ["Active namespace"],
1966
- },
1967
- confirmation_required: false,
1968
- danger_level: "medium",
1969
- field_docs: {},
1970
- optional_fields: [],
1971
- performance_impact: {
1972
- latency: "low",
1973
- resource_usage: "low",
1974
- },
1975
- purpose: "Create new registration",
1976
- required_fields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
1977
- side_effects: {
1978
- creates: ["registration"],
1979
- },
1980
- },
1981
- curlExample: null,
1982
- dependencies: [
1983
- {
1984
- domain: "",
1985
- fieldPath: "",
1986
- inline: false,
1987
- required: false,
1988
- resourceType: "registration",
1989
- },
1990
- {
1991
- domain: "",
1992
- fieldPath: "metadata",
1993
- inline: false,
1994
- required: false,
1995
- resourceType: "schema-object-create-meta",
1996
- },
1997
- {
1998
- domain: "",
1999
- fieldPath: "spec",
2000
- inline: false,
2001
- required: false,
2002
- resourceType: "schemaregistration-create",
2003
- },
2004
- ],
2005
- oneOfGroups: [],
2006
- subscriptionRequirements: [],
2007
- },
2008
- {
2009
- toolName: "f5xc-api-cemanagement-registration-delete",
2010
- method: "DELETE",
2011
- path: "/api/register/namespaces/{namespace}/registrations/{name}",
2012
- operation: "delete",
2013
- domain: "ce_management",
2014
- resource: "registration",
2015
- summary: "DELETE Registration.",
2016
- description: "DELETE the specified registration.",
2017
- pathParameters: [
2018
- {
2019
- description: "Name\nName of the configuration object.",
2020
- in: "path",
2021
- name: "name",
2022
- required: true,
2023
- schema: {
2024
- type: "string",
2025
- },
2026
- "x-displayname": "Name",
2027
- },
2028
- {
2029
- description: "Namespace\nNamespace in which the configuration object is present.",
2030
- in: "path",
2031
- name: "namespace",
2032
- required: true,
2033
- schema: {
2034
- type: "string",
2035
- },
2036
- "x-displayname": "Namespace",
2037
- },
2038
- ],
2039
- queryParameters: [
2040
- {
2041
- description: "Fail the DELETE operation if this object is being referred by other objects.",
2042
- in: "query",
2043
- name: "fail_if_referred",
2044
- required: false,
2045
- schema: {
2046
- format: "boolean",
2047
- type: "boolean",
2048
- },
2049
- "x-displayname": "Fail-If-Referred.",
2050
- },
2051
- ],
2052
- requestBodySchema: null,
2053
- responseSchema: {},
2054
- requiredParams: ["name", "namespace"],
2055
- operationId: "ves.io.schema.registration.CustomAPI.Delete",
2056
- tags: ["Other"],
2057
- sourceFile: "domains/ce_management.json",
2058
- displayName: null,
2059
- dangerLevel: "high",
2060
- sideEffects: {
2061
- deletes: ["registration", "contained_resources"],
2062
- },
2063
- requiredFields: ["path.name", "path.namespace"],
2064
- confirmationRequired: true,
2065
- parameterExamples: {},
2066
- validationRules: {},
2067
- operationMetadata: {
2068
- common_errors: [
2069
- {
2070
- code: 401,
2071
- message: "Authentication required",
2072
- solution: "Provide valid API credentials",
2073
- },
2074
- {
2075
- code: 403,
2076
- message: "Permission denied",
2077
- solution: "Check access permissions for this operation",
2078
- },
2079
- {
2080
- code: 404,
2081
- message: "Resource not found",
2082
- solution: "Verify resource name, namespace, and path",
2083
- },
2084
- {
2085
- code: 409,
2086
- message: "Resource already exists",
2087
- solution: "Use different name or update existing resource",
2088
- },
2089
- {
2090
- code: 429,
2091
- message: "Rate limit exceeded",
2092
- solution: "Wait before retrying the operation",
2093
- },
2094
- {
2095
- code: 500,
2096
- message: "Server error",
2097
- solution: "Retry operation or contact support",
2098
- },
2099
- ],
2100
- conditions: {
2101
- postconditions: ["Resource removed from system", "Associated resources may be affected"],
2102
- prerequisites: ["Active namespace"],
2103
- },
2104
- confirmation_required: true,
2105
- danger_level: "high",
2106
- field_docs: {},
2107
- optional_fields: [],
2108
- performance_impact: {
2109
- latency: "high",
2110
- resource_usage: "moderate",
2111
- },
2112
- purpose: "Delete registration",
2113
- required_fields: ["path.name", "path.namespace"],
2114
- side_effects: {
2115
- deletes: ["registration", "contained_resources"],
2116
- },
2117
- },
2118
- curlExample: null,
2119
- dependencies: [],
2120
- oneOfGroups: [],
2121
- subscriptionRequirements: [],
2122
- },
2123
- {
2124
- toolName: "f5xc-api-cemanagement-registration-get",
2125
- method: "GET",
2126
- path: "/api/register/namespaces/{namespace}/registrations/{name}",
2127
- operation: "get",
2128
- domain: "ce_management",
2129
- resource: "registration",
2130
- summary: "GET Registration.",
2131
- description: "GET registration specification.",
2132
- pathParameters: [
2133
- {
2134
- description: "Name\nThe name of the configuration object to be fetched.",
2135
- in: "path",
2136
- name: "name",
2137
- required: true,
2138
- schema: {
2139
- type: "string",
2140
- },
2141
- "x-displayname": "Name",
2142
- },
2143
- {
2144
- description: "Namespace\nThe namespace in which the configuration object is present.",
898
+ description: "Name\nThe name of the configuration object to be fetched.",
899
+ in: "path",
900
+ name: "name",
901
+ required: true,
902
+ schema: {
903
+ type: "string",
904
+ },
905
+ "x-displayname": "Name",
906
+ },
907
+ {
908
+ description: "Namespace\nThe namespace in which the configuration object is present.",
2145
909
  in: "path",
2146
910
  name: "namespace",
2147
911
  required: true,
@@ -2153,7 +917,7 @@ export const ce_managementTools = [
2153
917
  ],
2154
918
  queryParameters: [
2155
919
  {
2156
- description: "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referrred by this object.",
920
+ description: "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referrred by this object.",
2157
921
  in: "query",
2158
922
  name: "response_format",
2159
923
  required: false,
@@ -2163,6 +927,7 @@ export const ce_managementTools = [
2163
927
  "GET_RSP_FORMAT_DEFAULT",
2164
928
  "GET_RSP_FORMAT_FOR_CREATE",
2165
929
  "GET_RSP_FORMAT_FOR_REPLACE",
930
+ "GET_RSP_FORMAT_STATUS",
2166
931
  "GET_RSP_FORMAT_READ",
2167
932
  "GET_RSP_FORMAT_REFERRING_OBJECTS",
2168
933
  "GET_RSP_FORMAT_BROKEN_REFERENCES",
@@ -2174,10 +939,10 @@ export const ce_managementTools = [
2174
939
  ],
2175
940
  requestBodySchema: null,
2176
941
  responseSchema: {
2177
- $ref: "#/components/schemas/registrationGetResponse",
942
+ $ref: "#/components/schemas/network_interfaceGetResponse",
2178
943
  },
2179
944
  requiredParams: ["name", "namespace"],
2180
- operationId: "ves.io.schema.registration.CustomAPI.Get",
945
+ operationId: "ves.io.schema.network_interface.API.Get",
2181
946
  tags: ["Other"],
2182
947
  sourceFile: "domains/ce_management.json",
2183
948
  displayName: null,
@@ -2232,7 +997,7 @@ export const ce_managementTools = [
2232
997
  latency: "low",
2233
998
  resource_usage: "low",
2234
999
  },
2235
- purpose: "Retrieve specific registration",
1000
+ purpose: "Retrieve specific network-interface",
2236
1001
  required_fields: ["path.name", "path.namespace"],
2237
1002
  side_effects: {},
2238
1003
  },
@@ -2242,17 +1007,17 @@ export const ce_managementTools = [
2242
1007
  subscriptionRequirements: [],
2243
1008
  },
2244
1009
  {
2245
- toolName: "f5xc-api-cemanagement-registration-list",
1010
+ toolName: "f5xc-api-cemanagement-network-interface-list",
2246
1011
  method: "GET",
2247
- path: "/api/register/namespaces/{namespace}/registrations",
1012
+ path: "/api/config/namespaces/{namespace}/network_interfaces",
2248
1013
  operation: "list",
2249
1014
  domain: "ce_management",
2250
- resource: "registration",
2251
- summary: "List Registration.",
2252
- description: "List the set of registration in a namespace.",
1015
+ resource: "network-interface",
1016
+ summary: "List Network Interface.",
1017
+ description: "List the set of network_interface in a namespace.",
2253
1018
  pathParameters: [
2254
1019
  {
2255
- description: "Namespace\nNamespace to scope the listing of registration.",
1020
+ description: "Namespace\nNamespace to scope the listing of network_interface.",
2256
1021
  in: "path",
2257
1022
  name: "namespace",
2258
1023
  required: true,
@@ -2302,10 +1067,10 @@ export const ce_managementTools = [
2302
1067
  ],
2303
1068
  requestBodySchema: null,
2304
1069
  responseSchema: {
2305
- $ref: "#/components/schemas/registrationListResponse",
1070
+ $ref: "#/components/schemas/network_interfaceListResponse",
2306
1071
  },
2307
1072
  requiredParams: ["namespace"],
2308
- operationId: "ves.io.schema.registration.CustomAPI.List",
1073
+ operationId: "ves.io.schema.network_interface.API.List",
2309
1074
  tags: ["Other"],
2310
1075
  sourceFile: "domains/ce_management.json",
2311
1076
  displayName: null,
@@ -2360,7 +1125,7 @@ export const ce_managementTools = [
2360
1125
  latency: "moderate",
2361
1126
  resource_usage: "moderate",
2362
1127
  },
2363
- purpose: "List all registrations",
1128
+ purpose: "List all network-interfaces",
2364
1129
  required_fields: ["path.namespace"],
2365
1130
  side_effects: {},
2366
1131
  },
@@ -2370,14 +1135,14 @@ export const ce_managementTools = [
2370
1135
  subscriptionRequirements: [],
2371
1136
  },
2372
1137
  {
2373
- toolName: "f5xc-api-cemanagement-registration-update",
1138
+ toolName: "f5xc-api-cemanagement-network-interface-update",
2374
1139
  method: "PUT",
2375
- path: "/api/register/namespaces/{metadata.namespace}/registrations/{metadata.name}",
1140
+ path: "/api/config/namespaces/{metadata.namespace}/network_interfaces/{metadata.name}",
2376
1141
  operation: "update",
2377
1142
  domain: "ce_management",
2378
- resource: "registration",
2379
- summary: "Replace Registration.",
2380
- description: "NO fields are allowed to be replaced.",
1143
+ resource: "network-interface",
1144
+ summary: "Replace Network Interface.",
1145
+ description: "Network interface represents configuration of a network device.\nReplace network interface will replace the contents of given network interface object.",
2381
1146
  pathParameters: [
2382
1147
  {
2383
1148
  description: "Name\nThe configuration object to be replaced will be looked up by name.",
@@ -2402,19 +1167,19 @@ export const ce_managementTools = [
2402
1167
  ],
2403
1168
  queryParameters: [],
2404
1169
  requestBodySchema: {
2405
- $ref: "#/components/schemas/registrationReplaceRequest",
1170
+ $ref: "#/components/schemas/network_interfaceReplaceRequest",
2406
1171
  },
2407
1172
  responseSchema: {
2408
- $ref: "#/components/schemas/registrationReplaceResponse",
1173
+ $ref: "#/components/schemas/network_interfaceReplaceResponse",
2409
1174
  },
2410
1175
  requiredParams: ["body", "metadata.name", "metadata.namespace"],
2411
- operationId: "ves.io.schema.registration.API.Replace",
1176
+ operationId: "ves.io.schema.network_interface.API.Replace",
2412
1177
  tags: ["Other"],
2413
1178
  sourceFile: "domains/ce_management.json",
2414
1179
  displayName: null,
2415
1180
  dangerLevel: "medium",
2416
1181
  sideEffects: {
2417
- modifies: ["registration"],
1182
+ modifies: ["network-interface"],
2418
1183
  },
2419
1184
  requiredFields: ["path.metadata.name", "path.metadata.namespace"],
2420
1185
  confirmationRequired: false,
@@ -2465,10 +1230,10 @@ export const ce_managementTools = [
2465
1230
  latency: "low",
2466
1231
  resource_usage: "low",
2467
1232
  },
2468
- purpose: "Replace existing registration",
1233
+ purpose: "Replace existing network-interface",
2469
1234
  required_fields: ["path.metadata.name", "path.metadata.namespace"],
2470
1235
  side_effects: {
2471
- modifies: ["registration"],
1236
+ modifies: ["network-interface"],
2472
1237
  },
2473
1238
  },
2474
1239
  curlExample: null,
@@ -2478,7 +1243,7 @@ export const ce_managementTools = [
2478
1243
  fieldPath: "",
2479
1244
  inline: false,
2480
1245
  required: false,
2481
- resourceType: "registration",
1246
+ resourceType: "network-interface",
2482
1247
  },
2483
1248
  {
2484
1249
  domain: "",
@@ -2492,56 +1257,67 @@ export const ce_managementTools = [
2492
1257
  fieldPath: "spec",
2493
1258
  inline: false,
2494
1259
  required: false,
2495
- resourceType: "schemaregistration-replace",
1260
+ resourceType: "network-interface-replace",
2496
1261
  },
2497
1262
  ],
2498
1263
  oneOfGroups: [],
2499
1264
  subscriptionRequirements: [],
2500
1265
  },
2501
1266
  {
2502
- toolName: "f5xc-api-cemanagement-registrations-by-site-list",
1267
+ toolName: "f5xc-api-cemanagement-pre-upgrade-check-get",
2503
1268
  method: "GET",
2504
- path: "/api/register/namespaces/{namespace}/registrations_by_site/{site_name}",
2505
- operation: "list",
1269
+ path: "/api/maurice/namespaces/{namespace}/sites/{name}/pre_upgrade_check",
1270
+ operation: "get",
2506
1271
  domain: "ce_management",
2507
- resource: "registrations-by-site",
2508
- summary: "List registrations by site.",
2509
- description: "List all registration in site.",
1272
+ resource: "pre-upgrade-check",
1273
+ summary: "Pre upgrade check.",
1274
+ description: "API to check if site is ready for upgrade.",
2510
1275
  pathParameters: [
2511
1276
  {
2512
- description: 'Namespace\n\nx-required\nRegistration namespace, only "system" namespaces is accepted.',
1277
+ description: "Name\nFetch upgrade status for the name of site.",
2513
1278
  in: "path",
2514
- name: "namespace",
1279
+ name: "name",
2515
1280
  required: true,
2516
1281
  schema: {
2517
1282
  type: "string",
2518
1283
  },
2519
- "x-displayname": "Namespace",
1284
+ "x-displayname": "Site Name",
2520
1285
  },
2521
1286
  {
2522
- description: "SiteName\n\nx-required\nSite name to be used for registration filtering.",
1287
+ description: "Namespace\nFetch upgrade status for the given namespace.",
2523
1288
  in: "path",
2524
- name: "site_name",
1289
+ name: "namespace",
2525
1290
  required: true,
2526
1291
  schema: {
2527
1292
  type: "string",
2528
1293
  },
2529
- "x-displayname": "Site name",
1294
+ "x-displayname": "Namespace",
1295
+ },
1296
+ ],
1297
+ queryParameters: [
1298
+ {
1299
+ description: "Software version to upgrade to.",
1300
+ in: "query",
1301
+ name: "sw_version",
1302
+ required: false,
1303
+ schema: {
1304
+ type: "string",
1305
+ },
1306
+ "x-displayname": "SW Version to upgrade to.",
2530
1307
  },
2531
1308
  ],
2532
- queryParameters: [],
2533
1309
  requestBodySchema: null,
2534
1310
  responseSchema: {
2535
- $ref: "#/components/schemas/registrationListResponse",
1311
+ $ref: "#/components/schemas/upgrade_statusPreUpgradeCheckResponse",
2536
1312
  },
2537
- requiredParams: ["namespace", "site_name"],
2538
- operationId: "ves.io.schema.registration.CustomAPI.ListRegistrationsBySite",
1313
+ requiredParams: ["name", "namespace"],
1314
+ operationId: "ves.io.schema.upgrade_status.UpgradeStatusCustomApi.PreUpgradeCheck",
2539
1315
  tags: ["Other"],
2540
1316
  sourceFile: "domains/ce_management.json",
2541
1317
  displayName: null,
2542
1318
  dangerLevel: "low",
2543
1319
  sideEffects: null,
2544
- requiredFields: ["path.namespace", "path.site_name"],
1320
+ requiredFields: ["path.name", "path.namespace"],
2545
1321
  confirmationRequired: false,
2546
1322
  parameterExamples: {},
2547
1323
  validationRules: {},
@@ -2587,109 +1363,16 @@ export const ce_managementTools = [
2587
1363
  field_docs: {},
2588
1364
  optional_fields: [],
2589
1365
  performance_impact: {
2590
- latency: "low",
2591
- resource_usage: "low",
1366
+ latency: "moderate",
1367
+ resource_usage: "moderate",
2592
1368
  },
2593
- purpose: "List all registrations-by-sites",
2594
- required_fields: ["path.namespace", "path.site_name"],
1369
+ purpose: "Retrieve specific pre-upgrade-check",
1370
+ required_fields: ["path.name", "path.namespace"],
2595
1371
  side_effects: {},
2596
1372
  },
2597
1373
  curlExample: null,
2598
1374
  dependencies: [],
2599
1375
  oneOfGroups: [],
2600
- subscriptionRequirements: [
2601
- {
2602
- addonService: "f5xc_site_management_standard",
2603
- displayName: "F5XC Site Management Standard",
2604
- required: false,
2605
- tier: "standard",
2606
- },
2607
- ],
2608
- },
2609
- {
2610
- toolName: "f5xc-api-cemanagement-requestconfig-create",
2611
- method: "POST",
2612
- path: "/api/register/requestConfig",
2613
- operation: "create",
2614
- domain: "ce_management",
2615
- resource: "requestConfig",
2616
- summary: "Registration Config.",
2617
- description: "API endpoint for returning configuration for admitted registrations.\nIt will fail with known error for non-ADMITTED registration.",
2618
- pathParameters: [],
2619
- queryParameters: [],
2620
- requestBodySchema: {
2621
- $ref: "#/components/schemas/registrationConfigReq",
2622
- },
2623
- responseSchema: {
2624
- $ref: "#/components/schemas/registrationConfigResp",
2625
- },
2626
- requiredParams: ["body"],
2627
- operationId: "ves.io.schema.registration.CustomAPI.RegistrationConfig",
2628
- tags: ["Other"],
2629
- sourceFile: "domains/ce_management.json",
2630
- displayName: null,
2631
- dangerLevel: "medium",
2632
- sideEffects: {
2633
- creates: ["requestConfig"],
2634
- },
2635
- requiredFields: ["metadata.name", "metadata.namespace"],
2636
- confirmationRequired: false,
2637
- parameterExamples: {},
2638
- validationRules: {},
2639
- operationMetadata: {
2640
- common_errors: [
2641
- {
2642
- code: 401,
2643
- message: "Authentication required",
2644
- solution: "Provide valid API credentials",
2645
- },
2646
- {
2647
- code: 403,
2648
- message: "Permission denied",
2649
- solution: "Check access permissions for this operation",
2650
- },
2651
- {
2652
- code: 404,
2653
- message: "Resource not found",
2654
- solution: "Verify resource name, namespace, and path",
2655
- },
2656
- {
2657
- code: 409,
2658
- message: "Resource already exists",
2659
- solution: "Use different name or update existing resource",
2660
- },
2661
- {
2662
- code: 429,
2663
- message: "Rate limit exceeded",
2664
- solution: "Wait before retrying the operation",
2665
- },
2666
- {
2667
- code: 500,
2668
- message: "Server error",
2669
- solution: "Retry operation or contact support",
2670
- },
2671
- ],
2672
- conditions: {
2673
- postconditions: ["Requestconfig resource created", "Resource assigned unique identifier"],
2674
- prerequisites: [],
2675
- },
2676
- confirmation_required: false,
2677
- danger_level: "medium",
2678
- field_docs: {},
2679
- optional_fields: [],
2680
- performance_impact: {
2681
- latency: "low",
2682
- resource_usage: "low",
2683
- },
2684
- purpose: "Create new requestConfig",
2685
- required_fields: ["metadata.name", "metadata.namespace"],
2686
- side_effects: {
2687
- creates: ["requestConfig"],
2688
- },
2689
- },
2690
- curlExample: null,
2691
- dependencies: [],
2692
- oneOfGroups: [],
2693
1376
  subscriptionRequirements: [],
2694
1377
  },
2695
1378
  {
@@ -2783,92 +1466,6 @@ export const ce_managementTools = [
2783
1466
  oneOfGroups: [],
2784
1467
  subscriptionRequirements: [],
2785
1468
  },
2786
- {
2787
- toolName: "f5xc-api-cemanagement-suggest-value-create",
2788
- method: "POST",
2789
- path: "/api/register/namespaces/system/suggest-values",
2790
- operation: "create",
2791
- domain: "ce_management",
2792
- resource: "suggest-value",
2793
- summary: "Suggest Values.",
2794
- description: "Returns suggested values for the specified field in the given Create/Replace/Custom request.",
2795
- pathParameters: [],
2796
- queryParameters: [],
2797
- requestBodySchema: {
2798
- $ref: "#/components/schemas/registrationSuggestValuesReq",
2799
- },
2800
- responseSchema: {
2801
- $ref: "#/components/schemas/schemaregistrationSuggestValuesResp",
2802
- },
2803
- requiredParams: ["body"],
2804
- operationId: "ves.io.schema.registration.CustomAPI.SuggestValues",
2805
- tags: ["Other"],
2806
- sourceFile: "domains/ce_management.json",
2807
- displayName: null,
2808
- dangerLevel: "medium",
2809
- sideEffects: {
2810
- creates: ["suggest-value"],
2811
- },
2812
- requiredFields: ["metadata.name", "metadata.namespace"],
2813
- confirmationRequired: false,
2814
- parameterExamples: {},
2815
- validationRules: {},
2816
- operationMetadata: {
2817
- common_errors: [
2818
- {
2819
- code: 401,
2820
- message: "Authentication required",
2821
- solution: "Provide valid API credentials",
2822
- },
2823
- {
2824
- code: 403,
2825
- message: "Permission denied",
2826
- solution: "Check access permissions for this operation",
2827
- },
2828
- {
2829
- code: 404,
2830
- message: "Resource not found",
2831
- solution: "Verify resource name, namespace, and path",
2832
- },
2833
- {
2834
- code: 409,
2835
- message: "Resource already exists",
2836
- solution: "Use different name or update existing resource",
2837
- },
2838
- {
2839
- code: 429,
2840
- message: "Rate limit exceeded",
2841
- solution: "Wait before retrying the operation",
2842
- },
2843
- {
2844
- code: 500,
2845
- message: "Server error",
2846
- solution: "Retry operation or contact support",
2847
- },
2848
- ],
2849
- conditions: {
2850
- postconditions: ["Suggest-value resource created", "Resource assigned unique identifier"],
2851
- prerequisites: ["Active namespace"],
2852
- },
2853
- confirmation_required: false,
2854
- danger_level: "medium",
2855
- field_docs: {},
2856
- optional_fields: [],
2857
- performance_impact: {
2858
- latency: "low",
2859
- resource_usage: "low",
2860
- },
2861
- purpose: "Create new suggest-value",
2862
- required_fields: ["metadata.name", "metadata.namespace"],
2863
- side_effects: {
2864
- creates: ["suggest-value"],
2865
- },
2866
- },
2867
- curlExample: null,
2868
- dependencies: [],
2869
- oneOfGroups: [],
2870
- subscriptionRequirements: [],
2871
- },
2872
1469
  {
2873
1470
  toolName: "f5xc-api-cemanagement-upgradable-sw-version-list",
2874
1471
  method: "GET",