Gitiles
Code Review Sign In
gerrit.nordix.org / onap / dcaegen2 / 0404b1b84e0735a605c41a8600cb379bccb3eb88 / . / docs / sections / apis / pmsh_swagger.yml
blob: 3d7c6c63b8fe5ca4bc93b3d4ee46f5e91eeb84eb [file] [log] [blame]
efiacor1a06c542020-05-21 16:04:56 +0100[diff] [blame]1# ============LICENSE_START=======================================================
ejamcud0404b1b2021-06-14 14:06:16 +0100[diff] [blame^]2# Copyright (C) 2020-2021 Nordix Foundation.
efiacor1a06c542020-05-21 16:04:56 +0100[diff] [blame]3# ================================================================================
4# Licensed under the Apache License, Version 2.0 (the "License");
5# you may not use this file except in compliance with the License.
6# You may obtain a copy of the License at
7#
8# http://www.apache.org/licenses/LICENSE-2.0
9#
10# Unless required by applicable law or agreed to in writing, software
11# distributed under the License is distributed on an "AS IS" BASIS,
12# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13# See the License for the specific language governing permissions and
14# limitations under the License.
15#
16# SPDX-License-Identifier: Apache-2.0
17# ============LICENSE_END=========================================================
18
19swagger: "2.0"
20info:
21 title: PM Subscription Handler Service
ejamcud0404b1b2021-06-14 14:06:16 +0100[diff] [blame^]22 version: "2.0.0"
efiacor1a06c542020-05-21 16:04:56 +0100[diff] [blame]23 description: PM subscription handler enables control of performance management jobs on network functions in ONAP
24produces:
25 - "application/json"
ejamcud0404b1b2021-06-14 14:06:16 +0100[diff] [blame^]26basePath: "/pmsh"
27tags:
28- name: "Existing API"
29 description: "Existing API before Public API work"
efiacor1a06c542020-05-21 16:04:56 +0100[diff] [blame]30schemes:
31 - https
32# Paths supported by the server application
33paths:
ejamcud0404b1b2021-06-14 14:06:16 +0100[diff] [blame^]34 /v1/subscriptions:
efiacor1a06c542020-05-21 16:04:56 +0100[diff] [blame]35 get:
ejamcud0404b1b2021-06-14 14:06:16 +0100[diff] [blame^]36 tags:
37 - Existing API
efiacor1a06c542020-05-21 16:04:56 +0100[diff] [blame]38 description: >-
ejamcud0404b1b2021-06-14 14:06:16 +0100[diff] [blame^]39 Get all defined subscription and their related Network Functions from ONAP.
efiacor1a06c542020-05-21 16:04:56 +0100[diff] [blame]40 operationId: mod.api.controller.get_all_sub_to_nf_relations
41 responses:
42 200:
ejamcud0404b1b2021-06-14 14:06:16 +0100[diff] [blame^]43 description: OK; Array of subscription are returned as an object
efiacor1a06c542020-05-21 16:04:56 +0100[diff] [blame]44 schema:
45 type: array
46 items:
47 type: object
48 properties:
49 subscription_name:
50 type: string
51 description: Name of the Subscription
52 subscription_status:
53 type: string
54 description: Status of the Subscription
55 network_functions:
56 type: array
57 items:
58 type: object
59 properties:
60 nf_name:
61 type: string
62 description: Name of the Network Function
63 nf_sub_status:
64 type: string
65 description: Status of the Subscription on the Network Function
ejamcud0404b1b2021-06-14 14:06:16 +0100[diff] [blame^]66 orchestration_status:
efiacor1a06c542020-05-21 16:04:56 +0100[diff] [blame]67 type: string
ejamcud0404b1b2021-06-14 14:06:16 +0100[diff] [blame^]68 description: Orchestration status of the Network Function
efiacor1a06c542020-05-21 16:04:56 +0100[diff] [blame]69 401:
70 description: Unauthorized
71 403:
72 description: Forbidden
73 404:
ejamcud0404b1b2021-06-14 14:06:16 +0100[diff] [blame^]74 description: there are no subscription defined
efiacor1a06c542020-05-21 16:04:56 +0100[diff] [blame]75
76 /healthcheck:
77 get:
78 operationId: mod.api.controller.status
79 tags:
ejamcud0404b1b2021-06-14 14:06:16 +0100[diff] [blame^]80 - "Existing API"
efiacor1a06c542020-05-21 16:04:56 +0100[diff] [blame]81 description: >-
82 This is the health check endpoint. If this returns a 200, the server is alive.
83 responses:
84 200:
85 description: Successful response
86 schema:
87 type: object
88 properties:
89 status:
90 type: string
91 description: Overall health of PMSH
92 enum: [healthy, unhealthy]
93 503:
94 description: the pmsh service is unavailable
ejamcud0404b1b2021-06-14 14:06:16 +0100[diff] [blame^]95
96 /subscription:
97 post:
98 tags:
99 - "Subscriptions"
100 description: >-
101 Create a PM Subscription
102 operationId: mod.api.controller.create_subscription
103 consumes:
104 - "application/json"
105 produces:
106 - "application/json"
107 parameters:
108 - in: "body"
109 name: "body"
110 description: "Subscription object to be created"
111 required: true
112 schema:
113 type: object
114 properties:
115 subscription:
116 type: object
117 properties:
118 subscriptionName:
119 type: string
120 administrativeState:
121 allOf:
122 - type: string
123 - enum:
124 - UNLOCKED
125 - LOCKED
126 - FILTERING
127 fileBasedGP:
128 type: integer
129 fileLocation:
130 type: string
131 nfFilter:
132 type: object
133 properties:
134 nfNames:
135 type: array
136 items:
137 type: string
138 modelInvariantIDs:
139 type: array
140 items:
141 type: string
142 modelVersionIDs:
143 type: array
144 items:
145 type: string
146 modelNames:
147 type: array
148 items:
149 type: string
150 additionalProperties: false
151 measurementGroups:
152 type: array
153 minItems: 1
154 items:
155 type: object
156 properties:
157 measurementGroup:
158 type: object
159 properties:
160 measurementTypes:
161 type: array
162 minItems: 1
163 items:
164 type: object
165 properties:
166 measurementType:
167 type: string
168 required:
169 - measurementType
170 managedObjectDNsBasic:
171 type: array
172 minItems: 1
173 items:
174 type: object
175 properties:
176 DN:
177 type: string
178 required:
179 - DN
180 required:
181 - measurementTypes
182 - managedObjectDNsBasic
183 required:
184 - measurementGroup
185 required:
186 - subscriptionName
187 - administrativeState
188 - fileBasedGP
189 - fileLocation
190 - nfFilter
191 - measurementGroups
192 responses:
193 201:
194 description: successfully created PM Subscription
195 405:
196 description: Invalid input
197
198
199 #subcriptions
200 /subscription/{subscriptionName}:
201 get:
202 tags:
203 - "Subscriptions"
204 description: >-
205 Show the subscription
206 operationId: mod.api.controller.get_subscription
207 parameters:
208 - in: path
209 name: subscriptionName
210 type: string
211 required: true
212 responses:
213 200:
214 description: Requested Subscription returned
215 schema:
216 type: object
217 properties:
218 subscription:
219 type: object
220 properties:
221 subscriptionName:
222 type: string
223 administrativeState:
224 allOf:
225 - type: string
226 - enum:
227 - UNLOCKED
228 - LOCKED
229 - FILTERING
230 fileBasedGP:
231 type: integer
232 fileLocation:
233 type: string
234 nfFilter:
235 type: object
236 properties:
237 nfNames:
238 type: array
239 items:
240 type: string
241 modelInvariantIDs:
242 type: array
243 items:
244 type: string
245 modelVersionIDs:
246 type: array
247 items:
248 type: string
249 modelNames:
250 type: array
251 items:
252 type: string
253 additionalProperties: false
254 measurementGroups:
255 type: array
256 minItems: 1
257 items:
258 type: object
259 properties:
260 measurementGroup:
261 type: object
262 properties:
263 measurementTypes:
264 type: array
265 minItems: 1
266 items:
267 type: object
268 properties:
269 measurementType:
270 type: string
271 managedObjectDNsBasic:
272 type: array
273 minItems: 1
274 items:
275 type: object
276 properties:
277 DN:
278 type: string
279 401:
280 description: Unauthorized
281 403:
282 description: Forbidden
283 404:
284 description: there are no subscription defined
285 put: #full modify sub object
286 tags:
287 - "Subscriptions"
288 description: >-
289 This is an update for Subscription object
290 consumes:
291 - application/json
292 parameters:
293 - in: path
294 name: subscriptionName
295 type: string
296 required: true
297 - in: body
298 name: Subscription
299 description: The subscription object to update
300 schema:
301 type: object
302 properties:
303 subscription:
304 type: object
305 properties:
306 subscriptionName:
307 type: string
308 administrativeState:
309 type: string
310 enum:
311 - UNLOCKED
312 - LOCKED
313 - FILTERING
314 fileBasedGP:
315 type: integer
316 fileLocation:
317 type: string
318 nfFilter:
319 type: object
320 properties:
321 nfNames:
322 type: array
323 items:
324 type: string
325 modelInvariantIDs:
326 type: array
327 items:
328 type: string
329 modelVersionIDs:
330 type: array
331 items:
332 type: string
333 modelNames:
334 type: array
335 items:
336 type: string
337 measurementGroups:
338 type: array
339 items:
340 type: object
341 properties:
342 measurementGroup:
343 type: object
344 properties:
345 measurementTypes:
346 type: array
347 items:
348 type: object
349 properties:
350 measurementType:
351 type: string
352 managedObjectDNsBasic:
353 type: array
354 items:
355 type: object
356 properties:
357 DN:
358 type: string
359 required:
360 - subscriptionName
361 required:
362 - subscription
363 #add subscription schema here
364 responses:
365 201:
366 description: Subscription object updated
367 401:
368 description: Unauthorized
369 403:
370 description: Forbidden
371 404:
372 description: Subscription object not found
373 delete:
374 tags:
375 - "Subscriptions"
376 description: >-
377 This is a delete for Subscription object
378 parameters:
379 - in: path
380 name: subscriptionName
381 type: string
382 required: true
383 responses:
384 204:
385 description: Subscription object deleted
386 401:
387 description: Unauthorized
388 403:
389 description: Forbidden
390 404:
391 description: Subscription object not found
392
393#quick way to update a field here
394 #adminState
395 /subscription/{subscriptionName}/adminState:
396 get:
397 tags:
398 - "adminState"
399 description: >-
400 Show admin state of a subscription
401 parameters:
402 - in: path
403 name: subscriptionName
404 type: string
405 required: true
406 responses:
407 200:
408 description: Requested admin state returned
409 schema:
410 type: object
411 properties:
412 adminState:
413 type: string
414 enum:
415 - UNLOCKED
416 - LOCKED
417 - FILTERING
418 401:
419 description: Unauthorized
420 403:
421 description: Forbidden
422 404:
423 description: there are no subscription defined
424 put:
425 tags:
426 - "adminState"
427 description: >-
428 This is an update for a specific subscription's admin state
429 consumes:
430 - application/json
431 parameters:
432 - in: path
433 name: subscriptionName
434 type: string
435 required: true
436 - in: body
437 name: adminState
438 description: The adminState of the subscription object to update
439 schema:
440 type: object
441 required:
442 - adminState
443 properties:
444 adminState:
445 type: string
446 enum:
447 - UNLOCKED
448 - LOCKED
449 - FILTERING
450 responses:
451 201:
452 description: adminState is updated
453 401:
454 description: Unauthorized
455 403:
456 description: Forbidden
457 404:
458 description: Subscription object not found
459
460 #fileBasedGP
461 /subscription/{subscriptionName}/fileBasedGP:
462 get:
463 tags:
464 - "fileBasedGP"
465 description: >-
466 Show the fileBasedGP of a subscription
467 parameters:
468 - in: path
469 name: subscriptionName
470 type: string
471 required: true
472 responses:
473 200:
474 description: Requested fileBasedGP returned
475 schema:
476 type: object
477 properties:
478 fileBasedGP:
479 type: integer
480 401:
481 description: Unauthorized
482 403:
483 description: Forbidden
484 404:
485 description: there are no subscription defined
486 put:
487 tags:
488 - "fileBasedGP"
489 description: >-
490 This is an update for a specific subscription's fileBasedGP
491 consumes:
492 - application/json
493 parameters:
494 - in: path
495 name: subscriptionName
496 type: string
497 required: true
498 - in: body
499 name: fileBasedGP
500 description: The fileBasedGP field of the subscription object to update
501 schema:
502 type: object
503 required:
504 - fileBasedGP
505 properties:
506 fileBasedGP:
507 type: integer
508 responses:
509 201:
510 description: fileBasedGP is updated
511 401:
512 description: Unauthorized
513 403:
514 description: Forbidden
515 404:
516 description: Subscription object not found
517 delete:
518 tags:
519 - "fileBasedGP"
520 description: >-
521 This is a delete for fileBasedGP field on a subscription object
522 parameters:
523 - in: path
524 name: subscriptionName
525 type: string
526 required: true
527 responses:
528 204:
529 description: fileBasedGP field is deleted
530 401:
531 description: Unauthorized
532 403:
533 description: Forbidden
534 404:
535 description: Subscription object not found
536
537 #fileLocation
538 /subscription/{subscriptionName}/fileLocation:
539 get:
540 tags:
541 - "fileLocation"
542 description: >-
543 Show the fileLocation of a subscription
544 parameters:
545 - in: path
546 name: subscriptionName
547 type: string
548 required: true
549 responses:
550 200:
551 description: Requested fileLocation returned
552 schema:
553 type: object
554 properties:
555 fileLocation:
556 type: string
557 401:
558 description: Unauthorized
559 403:
560 description: Forbidden
561 404:
562 description: there are no subscription defined
563 put:
564 tags:
565 - "fileLocation"
566 description: >-
567 This is an update for a specific subscription's fileLocation
568 consumes:
569 - application/json
570 parameters:
571 - in: path
572 name: subscriptionName
573 type: string
574 required: true
575 - in: body
576 name: fileLocation
577 description: The fileLocation field of the subscription object to update
578 schema:
579 type: object
580 required:
581 - fileLocation
582 properties:
583 fileBasedGP:
584 type: string
585 responses:
586 201:
587 description: fileLocation is updated
588 401:
589 description: Unauthorized
590 403:
591 description: Forbidden
592 404:
593 description: Subscription object not found
594 delete:
595 tags:
596 - "fileLocation"
597 description: >-
598 This is a delete for fileLocation field on a subscription object
599 parameters:
600 - in: path
601 name: subscriptionName
602 type: string
603 required: true
604 responses:
605 204:
606 description: fileLocation field is deleted
607 401:
608 description: Unauthorized
609 403:
610 description: Forbidden
611 404:
612 description: Subscription object not found
613
614 #nfFilter
615 /subscription/{subscriptionName}/nfFilter:
616 get:
617 tags:
618 - "nfFilter"
619 description: >-
620 Show the nfFilter of a subscription
621 parameters:
622 - in: path
623 name: subscriptionName
624 type: string
625 required: true
626 responses:
627 200:
628 description: Requested nfFilter returned
629 schema:
630 type: object
631 properties:
632 nfFilter:
633 type: object
634 properties:
635 nfNames:
636 type: array
637 items:
638 type: string
639 modelInvariantIDs:
640 type: array
641 items:
642 type: string
643 modelVersionIDs:
644 type: array
645 items:
646 type: string
647 modelNames:
648 type: array
649 items:
650 type: string
651 401:
652 description: Unauthorized
653 403:
654 description: Forbidden
655 404:
656 description: there are no subscription defined
657 put:
658 tags:
659 - "nfFilter"
660 description: >-
661 This is an update for a specific subscription's nfFilter
662 consumes:
663 - application/json
664 parameters:
665 - in: path
666 name: subscriptionName
667 type: string
668 required: true
669 - in: body
670 name: nfFilter
671 description: The nfFilter field of the subscription object to update
672 schema:
673 type: object
674 properties:
675 nfFilter:
676 type: object
677 properties:
678 nfNames:
679 type: array
680 items:
681 type: string
682 modelInvariantIDs:
683 type: array
684 items:
685 type: string
686 modelVersionIDs:
687 type: array
688 items:
689 type: string
690 modelNames:
691 type: array
692 items:
693 type: string
694 responses:
695 201:
696 description: fileLocation is updated
697 401:
698 description: Unauthorized
699 403:
700 description: Forbidden
701 404:
702 description: Subscription object not found
703 delete:
704 tags:
705 - "nfFilter"
706 description: >-
707 This is a delete for nfFilter field on a subscription object
708 parameters:
709 - in: path
710 name: subscriptionName
711 type: string
712 required: true
713 responses:
714 204:
715 description: nfFilter field is deleted
716 401:
717 description: Unauthorized
718 403:
719 description: Forbidden
720 404:
721 description: Subscription object not found
722
723 #nfNames
724 /subscription/{subscriptionName}/nfFilter/nfNames:
725 get:
726 tags:
727 - "nfFilter"
728 description: >-
729 Show the nfNames of a subscription
730 parameters:
731 - in: path
732 name: subscriptionName
733 type: string
734 required: true
735 responses:
736 200:
737 description: Requested nfNames returned
738 schema:
739 type: object
740 properties:
741 nfNames:
742 items:
743 type: string
744 401:
745 description: Unauthorized
746 403:
747 description: Forbidden
748 404:
749 description: there are no subscription defined
750 put:
751 tags:
752 - "nfFilter"
753 description: >-
754 This is an update for a specific subscription's nfNames
755 consumes:
756 - application/json
757 parameters:
758 - in: path
759 name: subscriptionName
760 type: string
761 required: true
762 - in: body
763 name: nfNames
764 description: The nfNames field of nfFilter of the subscription object to update
765 schema:
766 type: object
767 required:
768 - nfNames
769 properties:
770 nfNames:
771 type: array
772 items:
773 type: string
774 responses:
775 201:
776 description: nfNames is updated
777 401:
778 description: Unauthorized
779 403:
780 description: Forbidden
781 404:
782 description: Subscription object not found
783 delete:
784 tags:
785 - "nfFilter"
786 description: >-
787 This is a delete for nfNames field on a subscription object
788 parameters:
789 - in: path
790 name: subscriptionName
791 type: string
792 required: true
793 responses:
794 204:
795 description: nfNames field is deleted
796 401:
797 description: Unauthorized
798 403:
799 description: Forbidden
800 404:
801 description: Subscription object not found
802
803 #nfinvariantModelIds
804 /subscription/{subscriptionName}/nfFilter/nfinvariantModelIds:
805 get:
806 tags:
807 - "nfFilter"
808 description: >-
809 Show the nfinvariantModelIds of a subscription
810 parameters:
811 - in: path
812 name: subscriptionName
813 type: string
814 required: true
815 responses:
816 200:
817 description: Requested nfinvariantModelIds returned
818 schema:
819 type: object
820 properties:
821 nfinvariantModelIds:
822 items:
823 type: string
824 401:
825 description: Unauthorized
826 403:
827 description: Forbidden
828 404:
829 description: there are no subscription defined
830 put:
831 tags:
832 - "nfFilter"
833 description: >-
834 This is an update for a specific subscription's nfinvariantModelIds
835 consumes:
836 - application/json
837 parameters:
838 - in: path
839 name: subscriptionName
840 type: string
841 required: true
842 - in: body
843 name: nfinvariantModelIds
844 description: The nfinvariantModelIds field of nfFilter of the subscription object to update
845 schema:
846 type: object
847 required:
848 - nfNames
849 properties:
850 nfinvariantModelIds:
851 type: array
852 items:
853 type: string
854 responses:
855 201:
856 description: nfNames is updated
857 401:
858 description: Unauthorized
859 403:
860 description: Forbidden
861 404:
862 description: Subscription object not found
863 delete:
864 tags:
865 - "nfFilter"
866 description: >-
867 This is a delete for nfinvariantModelIds field on a subscription object
868 parameters:
869 - in: path
870 name: subscriptionName
871 type: string
872 required: true
873 responses:
874 204:
875 description: nfinvariantModelIds field is deleted
876 401:
877 description: Unauthorized
878 403:
879 description: Forbidden
880 404:
881 description: Subscription object not found
882
883 #modelVersionIds
884 /subscription/{subscriptionName}/nfFilter/modelVersionIds:
885 get:
886 tags:
887 - "nfFilter"
888 description: >-
889 Show the modelVersionIds of a subscription
890 parameters:
891 - in: path
892 name: subscriptionName
893 type: string
894 required: true
895 responses:
896 200:
897 description: Requested modelVersionIds returned
898 schema:
899 type: object
900 properties:
901 modelVersionIds:
902 items:
903 type: string
904 401:
905 description: Unauthorized
906 403:
907 description: Forbidden
908 404:
909 description: there are no subscription defined
910 put:
911 tags:
912 - "nfFilter"
913 description: >-
914 This is an update for a specific subscription's modelVersionIds
915 consumes:
916 - application/json
917 parameters:
918 - in: path
919 name: subscriptionName
920 type: string
921 required: true
922 - in: body
923 name: modelVersionIds
924 description: The modelVersionIds field of nfFilter of the subscription object to update
925 schema:
926 type: object
927 required:
928 - modelVersionIds
929 properties:
930 modelVersionIds:
931 type: array
932 items:
933 type: string
934 responses:
935 201:
936 description: modelVersionIds is updated
937 401:
938 description: Unauthorized
939 403:
940 description: Forbidden
941 404:
942 description: Subscription object not found
943 delete:
944 tags:
945 - "nfFilter"
946 description: >-
947 This is a delete for modelVersionIds field on a subscription object
948 parameters:
949 - in: path
950 name: subscriptionName
951 type: string
952 required: true
953 responses:
954 204:
955 description: modelVersionIds field is deleted
956 401:
957 description: Unauthorized
958 403:
959 description: Forbidden
960 404:
961 description: Subscription object not found
962
963 #modelNames
964 /subscription/{subscriptionName}/nfFilter/modelNames:
965 get:
966 tags:
967 - "nfFilter"
968 description: >-
969 Show the modelNames of a subscription
970 parameters:
971 - in: path
972 name: subscriptionName
973 type: string
974 required: true
975 responses:
976 200:
977 description: Requested modelNames returned
978 schema:
979 type: object
980 properties:
981 modelNames:
982 items:
983 type: string
984 401:
985 description: Unauthorized
986 403:
987 description: Forbidden
988 404:
989 description: there are no subscription defined
990 put:
991 tags:
992 - "nfFilter"
993 description: >-
994 This is an update for a specific subscription's modelNames
995 consumes:
996 - application/json
997 parameters:
998 - in: path
999 name: subscriptionName
1000 type: string
1001 required: true
1002 - in: body
1003 name: modelNames
1004 description: The modelNames field of nfFilter of the subscription object to update
1005 schema:
1006 type: object
1007 required:
1008 - modelNames
1009 properties:
1010 modelNames:
1011 type: array
1012 items:
1013 type: string
1014 responses:
1015 201:
1016 description: modelNames is updated
1017 401:
1018 description: Unauthorized
1019 403:
1020 description: Forbidden
1021 404:
1022 description: Subscription object not found
1023 delete:
1024 tags:
1025 - "nfFilter"
1026 description: >-
1027 This is a delete for modelNames field on a subscription object
1028 parameters:
1029 - in: path
1030 name: subscriptionName
1031 type: string
1032 required: true
1033 responses:
1034 204:
1035 description: modelNames field is deleted
1036 401:
1037 description: Unauthorized
1038 403:
1039 description: Forbidden
1040 404:
1041 description: Subscription object not found
1042
1043 #measurementGroups
1044 /subscription/{subscriptionName}/measurementGroups:
1045 get:
1046 tags:
1047 - "measurementGroups"
1048 description: >-
1049 Show the fileBasedGP of a subscription
1050 parameters:
1051 - in: path
1052 name: subscriptionName
1053 type: string
1054 required: true
1055 responses:
1056 200:
1057 description: Requested measurementGroups returned
1058 schema:
1059 type: object
1060 properties:
1061 measurementGroups:
1062 type: array
1063 items:
1064 type: object
1065 properties:
1066 measurementGroup:
1067 type: object
1068 properties:
1069 measurementTypes:
1070 type: array
1071 items:
1072 type: object
1073 properties:
1074 measurementType:
1075 type: string
1076 managedObjectDNsBasic:
1077 type: array
1078 items:
1079 type: object
1080 properties:
1081 DN:
1082 type: string
1083 401:
1084 description: Unauthorized
1085 403:
1086 description: Forbidden
1087 404:
1088 description: there are no subscription defined
1089 put:
1090 tags:
1091 - "measurementGroups"
1092 description: >-
1093 This is an update for a specific subscription's measurementGroups
1094 consumes:
1095 - application/json
1096 parameters:
1097 - in: path
1098 name: subscriptionName
1099 type: string
1100 required: true
1101 - in: body
1102 name: measurementGroups
1103 description: The measurementGroups field of the subscription object to update
1104 schema:
1105 type: object
1106 properties:
1107 measurementGroups:
1108 type: array
1109 items:
1110 type: object
1111 properties:
1112 measurementGroup:
1113 type: object
1114 properties:
1115 measurementTypes:
1116 type: array
1117 items:
1118 type: object
1119 properties:
1120 measurementType:
1121 type: string
1122 managedObjectDNsBasic:
1123 type: array
1124 items:
1125 type: object
1126 properties:
1127 DN:
1128 type: string
1129 responses:
1130 201:
1131 description: measurementGroups is updated
1132 401:
1133 description: Unauthorized
1134 403:
1135 description: Forbidden
1136 404:
1137 description: Subscription object not found
1138 delete:
1139 tags:
1140 - "measurementGroups"
1141 description: >-
1142 This is a delete for measurementGroups field on a subscription object
1143 parameters:
1144 - in: path
1145 name: subscriptionName
1146 type: string
1147 required: true
1148 responses:
1149 204:
1150 description: measurementGroups field is deleted
1151 401:
1152 description: Unauthorized
1153 403:
1154 description: Forbidden
1155 404:
1156 description: Subscription object not found
1157
1158 #measurementGroupName
1159 /subscription/{subscriptionName}/measurementGroups/{measurementGroupName}:
1160 get:
1161 tags:
1162 - "measurementGroups"
1163 description: >-
1164 Show a measurementGroup of a subscription
1165 parameters:
1166 - in: path
1167 name: subscriptionName
1168 type: string
1169 required: true
1170 - in: path
1171 name: measurementGroupName
1172 type: string
1173 required: true
1174 responses:
1175 200:
1176 description: Requested measurementGroup returned
1177 schema:
1178 type: object
1179 properties:
1180 measurementGroup:
1181 type: object
1182 properties:
1183 measurementTypes:
1184 type: array
1185 items:
1186 type: object
1187 properties:
1188 measurementType:
1189 type: string
1190 managedObjectDNsBasic:
1191 type: array
1192 items:
1193 type: object
1194 properties:
1195 DN:
1196 type: string
1197 401:
1198 description: Unauthorized
1199 403:
1200 description: Forbidden
1201 404:
1202 description: there are no subscription defined
1203 put:
1204 tags:
1205 - "measurementGroups"
1206 description: >-
1207 This is an update for a specific a measurementGroup
1208 consumes:
1209 - application/json
1210 parameters:
1211 - in: path
1212 name: subscriptionName
1213 type: string
1214 required: true
1215 - in: path
1216 name: measurementGroupName
1217 type: string
1218 required: true
1219 - in: body
1220 name: measurementGroup
1221 description: The measurementGroup field of the subscription object to update
1222 schema:
1223 type: object
1224 properties:
1225 measurementGroup:
1226 type: object
1227 properties:
1228 measurementTypes:
1229 type: array
1230 items:
1231 type: object
1232 properties:
1233 measurementType:
1234 type: string
1235 managedObjectDNsBasic:
1236 type: array
1237 items:
1238 type: object
1239 properties:
1240 DN:
1241 type: string
1242 responses:
1243 201:
1244 description: measurementGroup is updated
1245 401:
1246 description: Unauthorized
1247 403:
1248 description: Forbidden
1249 404:
1250 description: measurementGroup object not found
1251 delete:
1252 tags:
1253 - "measurementGroups"
1254 description: >-
1255 This is a delete for measurementGroup field on a subscription object
1256 parameters:
1257 - in: path
1258 name: subscriptionName
1259 type: string
1260 required: true
1261 - in: path
1262 name: measurementGroupName
1263 type: string
1264 required: true
1265 responses:
1266 204:
1267 description: measurementGroup field is deleted
1268 401:
1269 description: Unauthorized
1270 403:
1271 description: Forbidden
1272 404:
1273 description: measurementGroup object not found
1274
1275 #measurementType
1276 /subscription/{subscriptionName}/measurementGroups/{measurementGroupName}/measurementTypes:
1277 get:
1278 tags:
1279 - "measurementGroups"
1280 description: >-
1281 Show the measurementTypes of a subscription
1282 parameters:
1283 - in: path
1284 name: subscriptionName
1285 type: string
1286 required: true
1287 - in: path
1288 name: measurementGroupName
1289 type: string
1290 required: true
1291 responses:
1292 200:
1293 description: Requested measurementTypes returned
1294 schema:
1295 type: object
1296 properties:
1297 measurementTypes:
1298 type: string
1299 401:
1300 description: Unauthorized
1301 403:
1302 description: Forbidden
1303 404:
1304 description: there are no subscription defined
1305 put:
1306 tags:
1307 - "measurementGroups"
1308 description: >-
1309 This is an update for measurementType field in a specific measurementGroup
1310 consumes:
1311 - application/json
1312 parameters:
1313 - in: path
1314 name: subscriptionName
1315 type: string
1316 required: true
1317 - in: path
1318 name: measurementGroupName
1319 type: string
1320 required: true
1321 - in: body
1322 name: measurementTypes
1323 description: The measurementTypes field of the measurementGroup to update
1324 schema:
1325 type: object
1326 properties:
1327 measurementTypes:
1328 type: string
1329 responses:
1330 201:
1331 description: measurementType is updated
1332 401:
1333 description: Unauthorized
1334 403:
1335 description: Forbidden
1336 404:
1337 description: measurementGroup object not found
1338 delete:
1339 tags:
1340 - "measurementGroups"
1341 description: >-
1342 This is a delete for measurementType field on a measurementGroup
1343 parameters:
1344 - in: path
1345 name: subscriptionName
1346 type: string
1347 required: true
1348 - in: path
1349 name: measurementGroupName
1350 type: string
1351 required: true
1352 responses:
1353 204:
1354 description: measurementGroup field is deleted
1355 401:
1356 description: Unauthorized
1357 403:
1358 description: Forbidden
1359 404:
1360 description: measurementGroup object not found
1361
1362 #managedObjectDNsBasic
1363 /subscription/{subscriptionName}/measurementGroups/{measurementGroupName}/managedObjectDNsBasic:
1364 get:
1365 tags:
1366 - "measurementGroups"
1367 description: >-
1368 Show the managedObjectDNsBasic of a subscription
1369 parameters:
1370 - in: path
1371 name: subscriptionName
1372 type: string
1373 required: true
1374 - in: path
1375 name: measurementGroupName
1376 type: string
1377 required: true
1378 responses:
1379 200:
1380 description: Requested managedObjectDNsBasic returned
1381 schema:
1382 type: object
1383 properties:
1384 managedObjectDNsBasic:
1385 type: string
1386 401:
1387 description: Unauthorized
1388 403:
1389 description: Forbidden
1390 404:
1391 description: there are no subscription defined
1392 put:
1393 tags:
1394 - "measurementGroups"
1395 description: >-
1396 This is an update for managedObjectDNsBasic field in a specific measurementGroup
1397 consumes:
1398 - application/json
1399 parameters:
1400 - in: path
1401 name: subscriptionName
1402 type: string
1403 required: true
1404 - in: path
1405 name: measurementGroupName
1406 type: string
1407 required: true
1408 - in: body
1409 name: managedObjectDNsBasic
1410 description: The managedObjectDNsBasic field of the measurementGroup to update
1411 schema:
1412 type: object
1413 properties:
1414 managedObjectDNsBasic:
1415 type: string
1416 responses:
1417 201:
1418 description: managedObjectDNsBasic is updated
1419 401:
1420 description: Unauthorized
1421 403:
1422 description: Forbidden
1423 404:
1424 description: measurementGroup object not found
1425 delete:
1426 tags:
1427 - "measurementGroups"
1428 description: >-
1429 This is a delete for managedObjectDNsBasic field on a measurementGroup
1430 parameters:
1431 - in: path
1432 name: subscriptionName
1433 type: string
1434 required: true
1435 - in: path
1436 name: measurementGroupName
1437 type: string
1438 required: true
1439 responses:
1440 204:
1441 description: managedObjectDNsBasic field is deleted
1442 401:
1443 description: Unauthorized
1444 403:
1445 description: Forbidden
1446 404:
1447 description: measurementGroup object not found