Skip to content
GitLab
Switch branch/tag
Find file Normal viewHistoryPermalink
Services.GET.yaml 2 KB
Newer Older
Walter Featherstone's avatar
Editorials in the description and added split files  
Walter Featherstone committed
1 
description: This method retrieves information about a list of meService resources. This method is typically used in "service availability query" procedure
Michele Carignani's avatar
replacing dots with underscores in operationIds    
Michele Carignani committed
2 
operationId: Services_GET
Walter Featherstone's avatar
Editorials in the description and added split files  
Walter Featherstone committed
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18 
produces:
- application/json
parameters:
- $ref: '#/parameters/Query.Ser_instance_id'
- $ref: '#/parameters/Query.Ser_name'
- $ref: '#/parameters/Query.Ser_category_id'

responses:
  200:
    description: It is used to indicate nonspecific success. The response body contains a representation of the resource.
    schema:
      type: array
      items:
        type: object
        properties:
          ServiceInfo:
Walter Featherstone's avatar
Fixes to response codes and explicit inclusion of examples    
Walter Featherstone committed
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45 
            $ref: '#/definitions/ServiceInfo'
    examples:
      application/json:
        ServiceInfo:
          serInstanceId: ServiceInstance123
          serName: ExampleService
          serCategory:
            href: catItem1
            id: id12345
            name: RNI
            version: version1
          version: ServiceVersion1
          state: ACTIVE
          transportId: Rest1
          transportInfo:
            id: TransId12345
            name: REST
            description: REST API
            type: JSON
            protocol: HTTP
            version: '2.0'
            endpoint:
              uris:
              - /meMp1/service/EntryPoint
              addresses:
              - host: '192.0.2.0'
                port: '8080'
Walter Featherstone's avatar
Removed mp1 from security parameter    
Walter Featherstone committed
46 
            security:
Walter Featherstone's avatar
Fixes to response codes and explicit inclusion of examples    
Walter Featherstone committed
47
48 
              oAuth2Info:
                grantTypes: OAUTH2_CLIENT_CREDENTIALS
Walter Featherstone's avatar
Removed mp1 from security parameter    
Walter Featherstone committed
49 
                tokenEndpoint: /meMp1/security/TokenEndPoint
Walter Featherstone's avatar
Fixes to response codes and explicit inclusion of examples    
Walter Featherstone committed
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73 
          serializer: JSON
  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'