Mp1.yaml 63.3 KB
Newer Older
1
2
swagger: '2.0'
info:
3
  title: Mp1 API
4
  version: 1.1.1
5
  description: The ETSI MEC ISG MEC011 Application Enablement API described using OpenAPI
6
7
8
9
  license:
    name: ETSI Forge copyright notice
    url: 'https://forge.etsi.org/etsi-forge-copyright-notice.txt'
externalDocs:
10
  description: 'ETSI GS MEC011 Application Enablement API, V1.1.1'
11
12
  url: >-
    http://www.etsi.org/deliver/etsi_gs/MEC/001_099/011/01.01.01_60/gs_mec011v010101p.pdf
13
14
15
16
17
18
19
20
21
22
23
24
host: '127.0.0.1:8081'
basePath: /exampleAPI/mp1/v1/
schemes:
  - http
  - https
consumes:
  - application/json
produces:
  - application/json
parameters:
  Body.AppTerminationNotificationSubscription:
    name: AppTerminationNotificationSubscription
25
26
27
    description: >-
      Entity body in the request contains a subscription to the mobile edge
      application termination notifications that is to be created.
28
29
30
    in: body
    required: true
    schema:
31
      $ref: '#/definitions/AppTerminationNotificationSubscription'
32
33
  Body.DnsRule:
    name: DnsRule
34
    description: The updated state is included in the entity body of the request.
35
36
37
38
39
40
    in: body
    required: true
    schema:
      $ref: '#/definitions/DnsRule'
  Body.SerAvailabilityNotificationSubscription:
    name: SerAvailabilityNotificationSubscription
41
42
43
    description: >-
      Entity body in the request contains a subscription to the mobile edge
      service availability notifications that is to be created.
44
45
46
    in: body
    required: true
    schema:
47
      $ref: '#/definitions/SerAvailabilityNotificationSubscription'
48
49
  Body.ServiceInfo:
    name: ServiceInfo
50
51
52
    description: >-
      New ServiceInfo with updated "state" is included as entity body of the
      request
53
54
55
56
57
58
59
60
61
62
63
64
65
    in: body
    required: true
    schema:
      $ref: '#/definitions/ServiceInfo'
  Body.TrafficRule:
    name: TrafficRule
    description: One or more updated attributes that are allowed to be changed
    in: body
    required: true
    schema:
      $ref: '#/definitions/TrafficRule'
  Path.AppInstanceId:
    name: appInstanceId
66
67
68
    description: >-
      Represents a mobile edge application instance. Note that the appInstanceId
      is allocated by the mobile edge platform manager.
69
70
71
72
73
74
75
76
77
78
79
    in: path
    required: true
    type: string
  Path.DnsRuleId:
    name: dnsRuleId
    description: Represents a DNS rule.
    in: path
    required: true
    type: string
  Path.SubscriptionId:
    name: subscriptionId
80
81
82
    description: >-
      Represents a subscription to the notifications from the mobile edge
      platform.
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
    in: path
    required: true
    type: string
  Path.ServiceId:
    name: serviceId
    description: Represents a mobile edge service instance.
    in: path
    required: true
    type: string
  Path.TrafficRuleId:
    name: trafficRuleId
    description: Represents a traffic rule.
    in: path
    required: true
    type: string
  Query.Ser_category_id:
    name: ser_category_id
100
101
102
103
104
    description: >-
      A mobile edge application instance may use ser_category_id as an input
      parameter to query the availability of a list of mobile edge service
      instances in a serCategory. Either "ser_instance_id" or "ser_name" or
      "ser_category_id" or none of them shall be present.
105
106
107
108
109
    in: query
    required: false
    type: string
  Query.Ser_instance_id:
    name: ser_instance_id
110
111
112
113
114
    description: >-
      A mobile edge application instance may use multiple ser_instance_ids as an
      input parameter to query the availability of a list of mobile edge service
      instances. Either "ser_instance_id" or "ser_name" or "ser_category_id" or
      none of them shall be present.
115
116
117
118
119
120
121
    in: query
    required: false
    type: array
    items:
      type: string
  Query.Ser_name:
    name: ser_name
122
123
124
125
126
    description: >-
      A mobile edge application instance may use multiple ser_names as an input
      parameter to query the availability of a list of mobile edge service
      instances. Either "ser_instance_id" or "ser_name" or "ser_category_id" or
      none of them shall be present.
127
128
129
130
131
132
133
    in: query
    required: false
    type: array
    items:
      type: string
paths:
  '/applications/{appInstanceId}/dns_rules':
134
135
    parameters:
      - $ref: '#/parameters/Path.AppInstanceId'
136
    get:
137
138
139
140
      description: >-
        This method retrieves information about all the DNS rules associated
        with a mobile edge application instance.
      operationId: ApplicationsDnsRules_GET
141
142
143
144
      produces:
        - application/json
      responses:
        '200':
145
146
147
          description: >-
            It is used to indicate nonspecific success. The response body
            contains a representation of the resource.
148
149
150
151
152
153
154
          schema:
            type: array
            items:
              type: object
              properties:
                DnsRule:
                  $ref: '#/definitions/DnsRule'
155
156
          examples:
            application/json:
157
              - DnsRule:
158
159
160
161
                  dnsRuleId: 'DnsRule1'
                  domainName: 'www.example.com'
                  ipAddressType: 'IP_V4'
                  ipAddress: '146.241.7.3'
162
                  ttl: 300
163
                  state: 'ACTIVE'
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
        '400':
          description: Bad Request
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '403':
          description: Forbidden
          schema:
            type: object
            required:
              - ProblemDetails
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '404':
          description: Not Found
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
187
  '/applications/{appInstanceId}/dns_rules/{dnsRuleId}':
188
189
190
    parameters:
      - $ref: '#/parameters/Path.AppInstanceId'
      - $ref: '#/parameters/Path.DnsRuleId'
191
    get:
192
193
194
195
      description: >-
        This method retrieves information about a DNS rule associated with a
        mobile edge application instance.
      operationId: ApplicationsDnsRule_GET
196
197
198
199
      produces:
        - application/json
      responses:
        '200':
200
201
202
          description: >-
            It is used to indicate nonspecific success. The response body
            contains a representation of the resource.
203
204
205
206
207
          schema:
            type: object
            properties:
              DnsRule:
                $ref: '#/definitions/DnsRule'
208
209
210
          examples:
            application/json:
              DnsRule:
211
212
213
214
                dnsRuleId: 'DnsRule1'
                domainName: 'www.example.com'
                ipAddressType: 'IP_V4'
                ipAddress: '146.241.7.3'
215
                ttl: 300
216
                state: 'ACTIVE'
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
        '400':
          description: Bad Request
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '403':
          description: Forbidden
          schema:
            type: object
            required:
              - ProblemDetails
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '404':
          description: Not Found
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
240
241
    put:
      description: 'This method activates, de-activates or updates a traffic rule.'
242
      operationId: ApplicationsDnsRule_PUT
243
244
245
246
247
248
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/Body.DnsRule'
      responses:
        '200':
249
250
251
          description: >-
            It is used to indicate nonspecific success. The response body
            contains a representation of the resource.
252
253
254
255
256
          schema:
            type: object
            properties:
              DnsRule:
                $ref: '#/definitions/DnsRule'
257
258
259
          examples:
            application/json:
              DnsRule:
260
261
262
263
                dnsRuleId: 'DnsRule1'
                domainName: 'www.example.com'
                ipAddressType: 'IP_V4'
                ipAddress: '146.241.7.3'
264
                ttl: 300
265
                state: 'ACTIVE'
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
        '400':
          description: Bad Request
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '403':
          description: Forbidden
          schema:
            type: object
            required:
              - ProblemDetails
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '404':
          description: Not Found
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '412':
          description: Precondition Failed
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
296
  '/applications/{appInstanceId}/subscriptions':
297
298
    parameters:
      - $ref: '#/parameters/Path.AppInstanceId'
299
    get:
300
301
302
303
304
      description: >-
        The GET method may be used to request information about all
        subscriptions for this requestor. Upon success, the response contains
        entity body with all the subscriptions for the requestor.
      operationId: ApplicationsSubscriptions_GET
305
306
307
308
      produces:
        - application/json
      responses:
        '200':
309
310
311
          description: >-
            Upon success, a response body containing the list of links to the
            requested subscriptions is returned.
312
313
314
315
316
          schema:
            type: object
            properties:
              Mp1SubscriptionLinkList:
                $ref: '#/definitions/Mp1SubscriptionLinkList'
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
        '400':
          description: Bad Request
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '403':
          description: Forbidden
          schema:
            type: object
            required:
              - ProblemDetails
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '404':
          description: Not Found
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
340
    post:
341
342
343
344
345
346
      description: >-
        The POST method may be used to create a new subscription. One example
        use case is to create a new subscription to the mobile edge service
        availability notifications. Upon success, the response contains entity
        body describing the created subscription.
      operationId: ApplicationsSubscriptions_POST
347
348
349
350
351
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/Body.AppTerminationNotificationSubscription'
      responses:
352
        '201':
353
354
355
          description: >-
            Entity body in the request contains a subscription to the mobile
            edge service availability notifications that is to be created.
356
          headers:
357
            location:
358
359
360
              description: The resource URI of the created resource
              type: string
              format: uri
361
362
363
364
          schema:
            type: object
            properties:
              AppTerminationNotificationSubscription:
365
                $ref: '#/definitions/AppTerminationNotificationSubscription'
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
        '400':
          description: Bad Request
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '403':
          description: Forbidden
          schema:
            type: object
            required:
              - ProblemDetails
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '404':
          description: Not Found
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
  '/applications/{appInstanceId}/subscriptions/AppTerminationNotificationSubscription/{subscriptionId}':
    parameters:
      - $ref: '#/parameters/Path.AppInstanceId'
      - $ref: '#/parameters/Path.SubscriptionId'
    get:
      description: >-
        The GET method requests information about a subscription for this
        requestor. Upon success, the response contains entity body with the
        subscription for the requestor.
      operationId: AppTerminationSubscription_GET
      produces:
        - application/json
      responses:
        '200':
          description: >-
            Upon success, a response body containing the requested subscription
            is returned.
          schema:
            type: object
            properties:
              AppTerminationNotificationSubscription:
                $ref: '#/definitions/AppTerminationNotificationSubscription'
        '400':
          description: Bad Request
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '403':
          description: Forbidden
          schema:
            type: object
            required:
              - ProblemDetails
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '404':
          description: Not Found
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
    delete:
      description: >-
        This method deletes a meMp1Subscription. This method is typically used
        in "Unsubscribing from service availability event notifications"
        procedure.
      operationId: AppTerminationSubscription_DELETE
      produces:
        - application/json
      responses:
        '204':
          description: No Content
        '403':
          description: Forbidden
          schema:
            type: object
            required:
              - ProblemDetails
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '404':
          description: Not Found
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
  '/applications/{appInstanceId}/subscriptions/SerAvailabilityNotificationSubscription/{subscriptionId}':
462
463
464
    parameters:
      - $ref: '#/parameters/Path.AppInstanceId'
      - $ref: '#/parameters/Path.SubscriptionId'
465
    get:
466
467
468
469
      description: >-
        The GET method requests information about a subscription for this
        requestor. Upon success, the response contains entity body with the
        subscription for the requestor.
470
      operationId: SerAvailabilitySubscription_GET
471
472
473
474
      produces:
        - application/json
      responses:
        '200':
475
476
477
          description: >-
            Upon success, a response body containing the requested subscription
            is returned.
478
479
480
481
          schema:
            type: object
            properties:
              SerAvailabilityNotificationSubscription:
482
                $ref: '#/definitions/SerAvailabilityNotificationSubscription'
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
        '400':
          description: Bad Request
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '403':
          description: Forbidden
          schema:
            type: object
            required:
              - ProblemDetails
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '404':
          description: Not Found
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
506
    delete:
507
508
509
510
      description: >-
        This method deletes a meMp1Subscription. This method is typically used
        in "Unsubscribing from service availability event notifications"
        procedure.
511
      operationId: SerAvailabilitySubscription_DELETE
512
513
514
515
516
      produces:
        - application/json
      responses:
        '204':
          description: No Content
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
        '403':
          description: Forbidden
          schema:
            type: object
            required:
              - ProblemDetails
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '404':
          description: Not Found
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
533
  '/applications/{appInstanceId}/traffic_rules':
534
535
    parameters:
      - $ref: '#/parameters/Path.AppInstanceId'
536
    get:
537
538
539
540
      description: >-
        This method retrieves information about all the traffic rules associated
        with a mobile edge application instance.
      operationId: ApplicationsTrafficRules_GET
541
542
543
544
      produces:
        - application/json
      responses:
        '200':
545
546
547
          description: >-
            It is used to indicate nonspecific success. The response body
            contains a representation of the resource.
548
549
550
551
552
553
554
          schema:
            type: array
            items:
              type: object
              properties:
                TrafficRule:
                  $ref: '#/definitions/TrafficRule'
555
556
          examples:
            application/json:
557
              - TrafficRule:
558
559
560
                  trafficRuleId: 'TrafficRule123'
                  serName: 'ExampleService'
                  filterType: 'FLOW'
561
562
                  priority: 1
                  trafficFilter:
563
564
565
566
567
568
569
570
                    - srcAddress:
                        - '192.168.2.0/24'
                        - '192.168.3.0/24'
                      dstAddress:
                        - '192.127.4.100/32'
                      dstPort:
                        - '80'
                  action: 'FORWARD_DECAPSULATED'
571
                  dstInterface:
572
573
574
                    interfaceType: 'IP'
                    dstIpAddress: '20.1.1.1'
                  state: 'ACTIVE'
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
        '400':
          description: Bad Request
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '403':
          description: Forbidden
          schema:
            type: object
            required:
              - ProblemDetails
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '404':
          description: Not Found
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
598
  '/applications/{appInstanceId}/traffic_rules/{trafficRuleId}':
599
600
601
    parameters:
      - $ref: '#/parameters/Path.AppInstanceId'
      - $ref: '#/parameters/Path.TrafficRuleId'
602
    get:
603
604
605
606
      description: >-
        This method retrieves information about all the traffic rules associated
        with a mobile edge application instance.
      operationId: ApplicationsTrafficRule_GET
607
608
609
610
      produces:
        - application/json
      responses:
        '200':
611
612
613
          description: >-
            It is used to indicate nonspecific success. The response body
            contains a representation of the resource.
614
615
616
617
618
          schema:
            type: object
            properties:
              TrafficRule:
                $ref: '#/definitions/TrafficRule'
619
620
621
          examples:
            application/json:
              TrafficRule:
622
623
624
                trafficRuleId: 'TrafficRule123'
                serName: 'ExampleService'
                filterType: 'FLOW'
625
626
                priority: 1
                trafficFilter:
627
628
629
630
631
632
633
634
                  - srcAddress:
                      - '192.168.2.0/24'
                      - '192.168.3.0/24'
                    dstAddress:
                      - '192.127.4.100/32'
                    dstPort:
                      - '80'
                action: 'FORWARD_DECAPSULATED'
635
                dstInterface:
636
637
638
                  interfaceType: 'IP'
                  dstIpAddress: '20.1.1.1'
                state: 'ACTIVE'
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
        '400':
          description: Bad Request
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '403':
          description: Forbidden
          schema:
            type: object
            required:
              - ProblemDetails
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '404':
          description: Not Found
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
662
    put:
663
664
665
666
      description: >-
        This method retrieves information about all the traffic rules associated
        with a mobile edge application instance.
      operationId: ApplicationsTrafficRules_PUT
667
668
669
670
671
672
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/Body.TrafficRule'
      responses:
        '200':
673
674
675
          description: >-
            Upon success, a response body containing data type describing the
            updated TrafficRule is returned.
676
677
678
679
680
          schema:
            type: object
            properties:
              TrafficRule:
                $ref: '#/definitions/TrafficRule'
681
682
683
          examples:
            application/json:
              TrafficRule:
684
685
686
                trafficRuleId: 'TrafficRule123'
                serName: 'ExampleService'
                filterType: 'FLOW'
687
688
                priority: 1
                trafficFilter:
689
690
691
692
693
694
695
696
                  - srcAddress:
                      - '192.168.2.0/24'
                      - '192.168.3.0/24'
                    dstAddress:
                      - '192.127.4.100/32'
                    dstPort:
                      - '80'
                action: 'FORWARD_DECAPSULATED'
697
                dstInterface:
698
699
700
                  interfaceType: 'IP'
                  dstIpAddress: '20.1.1.1'
                state: 'ACTIVE'
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
        '400':
          description: Bad Request
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '403':
          description: Forbidden
          schema:
            type: object
            required:
              - ProblemDetails
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '404':
          description: Not Found
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '412':
          description: Precondition Failed
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
731
732
  /services:
    get:
733
734
735
736
      description: >-
        This method retrieves information about a list of meService resources.
        This method is typically used in "service availability query" procedure
      operationId: Services_GET
737
738
739
740
741
742
743
744
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/Query.Ser_instance_id'
        - $ref: '#/parameters/Query.Ser_name'
        - $ref: '#/parameters/Query.Ser_category_id'
      responses:
        '200':
745
746
747
          description: >-
            It is used to indicate nonspecific success. The response body
            contains a representation of the resource.
748
749
750
751
752
753
754
          schema:
            type: array
            items:
              type: object
              properties:
                ServiceInfo:
                  $ref: '#/definitions/ServiceInfo'
755
756
          examples:
            application/json:
757
              - ServiceInfo:
758
759
                  serInstanceId: 'ServiceInstance123'
                  serName: 'ExampleService'
760
                  serCategory:
761
762
763
764
765
766
                    href: 'catItem1'
                    id: 'id12345'
                    name: 'RNI'
                    version: 'version1'
                  version: 'ServiceVersion1'
                  state: 'ACTIVE'
767
                  transportInfo:
768
769
770
771
772
                    id: 'TransId12345'
                    name: 'REST'
                    description: 'REST API'
                    type: 'JSON'
                    protocol: 'HTTP'
773
774
775
                    version: '2.0'
                    endpoint:
                      uris:
776
                        - '/meMp1/service/EntryPoint'
777
778
                    security:
                      oAuth2Info:
779
780
781
                        grantTypes: 'OAUTH2_CLIENT_CREDENTIALS'
                        tokenEndpoint: '/meMp1/security/TokenEndPoint'
                  serializer: 'JSON'
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
        '400':
          description: Bad Request
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '403':
          description: Forbidden
          schema:
            type: object
            required:
              - ProblemDetails
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '404':
          description: Not Found
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
805
    post:
806
807
808
809
810
      description: >-
        This method is used to create a meService resource. This method is
        typically used in "service availability update and new service
        registration" procedure
      operationId: Services_POST
811
812
813
814
815
816
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/Body.ServiceInfo'
      responses:
        '201':
817
818
819
          description: >-
            Upon success, the HTTP response shall include a Location HTTP header
            that contains the resource URI of the created resource.
820
          headers:
821
            location:
822
823
824
              description: The resource URI of the created resource
              type: string
              format: uri
825
826
827
828
829
          schema:
            type: object
            properties:
              ServiceInfo:
                $ref: '#/definitions/ServiceInfo'
830
831
832
          examples:
            application/json:
              ServiceInfo:
833
834
                serInstanceId: 'ServiceInstance123'
                serName: 'ExampleService'
835
                serCategory:
836
837
838
839
840
841
                  href: 'catItem1'
                  id: 'id12345'
                  name: 'RNI'
                  version: 'version1'
                version: 'ServiceVersion1'
                state: 'ACTIVE'
842
                transportInfo:
843
844
845
846
847
                  id: 'TransId12345'
                  name: 'REST'
                  description: 'REST API'
                  type: 'REST_HTTP'
                  protocol: 'HTTP'
848
849
850
                  version: '2.0'
                  endpoint:
                    addresses:
851
852
                      - host: '192.0.2.0'
                        port: 8080
853
                  security:
854
                    oAuth2Info:
855
856
857
                      grantTypes: 'OAUTH2_CLIENT_CREDENTIALS'
                      tokenEndpoint: '/meMp1/security/TokenEndPoint'
                serializer: 'JSON'
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
        '400':
          description: Bad Request
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '403':
          description: Forbidden
          schema:
            type: object
            required:
              - ProblemDetails
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '404':
          description: Not Found
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
881
  '/services/{serviceId}':
882
883
    parameters:
      - $ref: '#/parameters/Path.ServiceId'
884
    get:
885
886
887
888
      description: >-
        This method retrieves information about a meService resource. This
        method is typically used in "service availability query" procedure
      operationId: ServicesServiceId_GET
889
890
891
892
      produces:
        - application/json
      responses:
        '200':
893
894
895
          description: >-
            It is used to indicate nonspecific success. The response body
            contains a representation of the resource.
896
897
898
899
900
901
902
903
          schema:
            type: object
            properties:
              ServiceInfo:
                $ref: '#/definitions/ServiceInfo'
          examples:
            application/json:
              ServiceInfo:
904
905
                serInstanceId: 'ServiceInstance123'
                serName: 'ExampleService'
906
                serCategory:
907
908
909
910
911
912
                  href: 'catItem1'
                  id: 'id12345'
                  name: 'RNI'
                  version: 'version1'
                version: 'ServiceVersion1'
                state: 'ACTIVE'
913
                transportInfo:
914
915
916
917
918
                  id: 'TransId12345'
                  name: 'REST'
                  description: 'REST API'
                  type: 'REST_HTTP'
                  protocol: 'HTTP'
919
920
921
                  version: '2.0'
                  endpoint:
                    addresses:
922
923
                      - host: '192.0.2.0'
                        port: 8080
924
                  security:
925
                    oAuth2Info:
926
927
928
                      grantTypes: 'OAUTH2_CLIENT_CREDENTIALS'
                      tokenEndpoint: '/meMp1/security/TokenEndPoint'
                serializer: 'JSON'
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
        '400':
          description: Bad Request
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '403':
          description: Forbidden
          schema:
            type: object
            required:
              - ProblemDetails
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
        '404':
          description: Not Found
          schema:
            type: object
            properties:
              ProblemDetails:
                $ref: '#/definitions/ProblemDetails'
952
953
    put:
      description: This method updates the information about a meService resource
954
      operationId: ServicesServiceId_PUT
955
956
957
958
959
960
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/Body.ServiceInfo'
      responses:
        '200':
961
962
963
          description: >-
            Upon success, a response body containing data type describing the
            updated ServiceInfo is returned
964
965
966
967
968
969
970
971
          schema:
            type: object
            properties:
              ServiceInfo:
                $ref: '#/definitions/ServiceInfo'
          examples:
            application/json:
              ServiceInfo:
972
973
                serInstanceId: 'ServiceInstance123'
                serName: 'ExampleService'
974
                serCategory:
975
976
977
978
979
980
                  href: 'catItem1'
                  id: 'id12345'
                  name: 'RNI'
                  version: 'version1'
                version: 'ServiceVersion1'
                state: 'ACTIVE'
981
                transportInfo:
982
983
984
985
986
                  id: 'TransId12345'
                  name: 'REST'
                  description: 'REST API'
                  type: 'REST_HTTP'
                  protocol: 'HTTP'
987
988
989
                  version: '2.0'
                  endpoint:
                    uris:
990
                      - '/meMp1/service/EntryPoint'
991
                  security:
992
                    oAuth2Info:
993
994
995
                      grantTypes: 'OAUTH2_CLIENT_CREDENTIALS'
                      tokenEndpoint: '/meMp1/security/TokenEndPoint'
                serializer: 'JSON'
996
997
998
999
1000
        '400':
          description: Bad Request
          schema:
            type: object
            properties:
For faster browsing, not all history is shown. View entire blame