/
staticclient.yml
171 lines (163 loc) · 10.2 KB
/
staticclient.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
#
# Static definition of "discoverable-client" as "staticclient"
#
# This file provides static API service definition in YAML format.
# It is loaded by the Discovery Service during its startup.
#
services:
- serviceId: staticclient # unique lowercase ID of the service
catalogUiTileId: static # ID of the API Catalog UI tile (visual grouping of the services)
title: Statically Defined API Service # Title of the service in the API catalog
description: Sample to demonstrate how to add an API service with Swagger to API Catalog using a static YAML definition # Description of the service in the API catalog
instanceBaseUrls: # list of base URLs for each instance
- https://discoverable-client:10012/discoverableclient # scheme://hostname:port/contextPath
homePageRelativeUrl: / # Normally used for informational purposes for other services to use it as a landing page
statusPageRelativeUrl: /application/info # Appended to the instanceBaseUrl
healthCheckRelativeUrl: /application/health # Appended to the instanceBaseUrl
routes:
- gatewayUrl: api/v1 # [api/ui/ws]/v{majorVersion}
serviceRelativeUrl: /api/v1 # relativePath that is added to baseUrl of an instance
- gatewayUrl: ui/v1
serviceRelativeUrl: /
- gatewayUrl: ws/v1
serviceRelativeUrl: /ws
# List of APIs provided by the service (currently only one is supported):
apiInfo:
- apiId: zowe.apiml.discoverableclient
gatewayUrl: api/v1
swaggerUrl: https://discoverable-client:10012/discoverableclient/v2/api-docs
customMetadata:
apiml:
okToRetryOnAllOperations: true
- serviceId: zowejwt # unique lowercase ID of the service
catalogUiTileId: static # ID of the API Catalog UI tile (visual grouping of the services)
title: Staticaly Defined Service To Test Zowe JWT scheme # Title of the service in the API catalog
description: Sample to demonstrate how to add an API service without Swagger documentation to API Catalog using a static YAML definition # Description of the service in the API catalog
instanceBaseUrls: # list of base URLs for each instance
- https://discoverable-client:10012/discoverableclient # scheme://hostname:port/contextPath
homePageRelativeUrl: # Normally used for informational purposes for other services to use it as a landing page
statusPageRelativeUrl: /application/info # Appended to the instanceBaseUrl
healthCheckRelativeUrl: /application/health # Appended to the instanceBaseUrl
routes:
- gatewayUrl: api/v1 # [api/ui/ws]/v{majorVersion}
serviceRelativeUrl: /api/v1 # relativePath that is added to baseUrl of an instance
- gatewayUrl: ui/v1
serviceRelativeUrl: /
- gatewayUrl: ws/v1
serviceRelativeUrl: /ws
authentication:
scheme: zoweJwt # This service expects JWT or client cert in HTTP request
apiInfo:
- apiId: zowe.apiml.discoverableclient
gatewayUrl: api/v1
version: 1.0.0
- serviceId: staticclient2 # unique lowercase ID of the service
catalogUiTileId: static # ID of the API Catalog UI tile (visual grouping of the services)
title: Staticaly Defined Service 2 # Title of the service in the API catalog
description: Sample to demonstrate how to add an API service without Swagger documentation to API Catalog using a static YAML definition # Description of the service in the API catalog
instanceBaseUrls: # list of base URLs for each instance
- https://discoverable-client:10012/discoverableclient # scheme://hostname:port/contextPath
homePageRelativeUrl: # Normally used for informational purposes for other services to use it as a landing page
statusPageRelativeUrl: /application/info # Appended to the instanceBaseUrl
healthCheckRelativeUrl: /application/health # Appended to the instanceBaseUrl
routes:
- gatewayUrl: api/v1 # [api/ui/ws]/v{majorVersion}
serviceRelativeUrl: /api/v1 # relativePath that is added to baseUrl of an instance
- gatewayUrl: ui/v1
serviceRelativeUrl: /
- gatewayUrl: ws/v1
serviceRelativeUrl: /ws
authentication:
scheme: httpBasicPassTicket # This service expects credentials in HTTP basic scheme with a PassTicket
applid: TSTAPPL # APPLID to generate PassTickets for this service
# List of APIs provided by the service (currently only one is supported):
apiInfo:
- apiId: zowe.apiml.discoverableclient
gatewayUrl: api/v1
version: 1.0.0
- serviceId: dcbypass # unique lowercase ID of the service
catalogUiTileId: static # ID of the API Catalog UI tile (visual grouping of the services)
title: Discoverable client with by pass authentication scheme # Title of the service in the API catalog
description: Define service to test by pass authentication schema for integration tests.
instanceBaseUrls: # list of base URLs for each instance
- https://discoverable-client:10012/discoverableclient # scheme://hostname:port/contextPath
homePageRelativeUrl: # Normally used for informational purposes for other services to use it as a landing page
statusPageRelativeUrl: /application/info # Appended to the instanceBaseUrl
healthCheckRelativeUrl: /application/health # Appended to the instanceBaseUrl
routes:
- gatewayUrl: api/v1 # [api/ui/ws]/v{majorVersion}
serviceRelativeUrl: /api/v1 # relativePath that is added to baseUrl of an instance
authentication:
scheme: bypass
apiInfo:
- apiId: zowe.apiml.discoverableclient
gatewayUrl: api/v1
version: 1.0.0
- serviceId: dcpassticket # unique lowercase ID of the service
catalogUiTileId: static # ID of the API Catalog UI tile (visual grouping of the services)
title: Discoverable client with passTicket authentication scheme # Title of the service in the API catalog
description: Define service to test passTicket authentication schema for integration tests.
instanceBaseUrls: # list of base URLs for each instance
- https://discoverable-client:10012/discoverableclient # scheme://hostname:port/contextPath
homePageRelativeUrl: # Normally used for informational purposes for other services to use it as a landing page
statusPageRelativeUrl: /application/info # Appended to the instanceBaseUrl
healthCheckRelativeUrl: /application/health # Appended to the instanceBaseUrl
routes:
- gatewayUrl: api/v1 # [api/ui/ws]/v{majorVersion}
serviceRelativeUrl: /api/v1 # relativePath that is added to baseUrl of an instance
authentication:
scheme: httpBasicPassTicket # This service expects credentials in HTTP basic scheme with a PassTicket
applid: ZOWEAPPL # APPLID to generate PassTickets for this service
apiInfo:
- apiId: zowe.apiml.discoverableclient
gatewayUrl: api/v1
version: 1.0.0
- serviceId: dcsafidt # unique lowercase ID of the service
catalogUiTileId: static # ID of the API Catalog UI tile (visual grouping of the services)
title: Discoverable client with safIdt authentication scheme # Title of the service in the API catalog
description: Define service to test safIdt authentication schema for integration tests.
instanceBaseUrls: # list of base URLs for each instance
- https://discoverable-client:10012/discoverableclient # scheme://hostname:port/contextPath
homePageRelativeUrl: # Normally used for informational purposes for other services to use it as a landing page
statusPageRelativeUrl: /application/info # Appended to the instanceBaseUrl
healthCheckRelativeUrl: /application/health # Appended to the instanceBaseUrl
routes:
- gatewayUrl: api/v1 # [api/ui/ws]/v{majorVersion}
serviceRelativeUrl: /api/v1 # relativePath that is added to baseUrl of an instance
authentication:
scheme: safIdt # This service expects credentials in HTTP basic scheme with a PassTicket
applid: ZOWEAPPL
apiInfo:
- apiId: zowe.apiml.discoverableclient
gatewayUrl: api/v1
version: 1.0.0
- serviceId: dczosmf # unique lowercase ID of the service
catalogUiTileId: static # ID of the API Catalog UI tile (visual grouping of the services)
title: Discoverable client with zosmf authentication scheme # Title of the service in the API catalog
description: Define service to test zosmf authentication schema for integration tests.
instanceBaseUrls: # list of base URLs for each instance
- https://discoverable-client:10012/discoverableclient # scheme://hostname:port/contextPath
homePageRelativeUrl: # Normally used for informational purposes for other services to use it as a landing page
statusPageRelativeUrl: /application/info # Appended to the instanceBaseUrl
healthCheckRelativeUrl: /application/health # Appended to the instanceBaseUrl
routes:
- gatewayUrl: api/v1 # [api/ui/ws]/v{majorVersion}
serviceRelativeUrl: /api/v1 # relativePath that is added to baseUrl of an instance
authentication:
scheme: zosmf
apiInfo:
- apiId: zowe.apiml.discoverableclient
gatewayUrl: api/v1
version: 1.0.0
# Additional metadata that will be added to existing dynamically registered services:
additionalServiceMetadata:
- serviceId: staticclient # The staticclient service metadata will be extended
mode: UPDATE # How to update UPDATE=only missing, FORCE_UPDATE=update all set values
authentication:
scheme: bypass # This service expects credentials in HTTP basic scheme with a PassTicket
applid: TSTAPPL # APPLID to generate PassTickets for this service
# List of tiles that can be used by services defined in the YAML file:
catalogUiTiles:
static:
title: Static API Services
description: Services which demonstrate how to make an API service discoverable in the APIML ecosystem using YAML definitions