|
24 | 24 | - [Delete an API](#delete-an-api) |
25 | 25 | - [Services](#services) |
26 | 26 | - [Retrieve a list of services](#retrieve-a-list-of-services) |
| 27 | + - [Create a Service](#create-a-service) |
27 | 28 | - [Get a service](#get-a-service) |
28 | 29 | - [Invoke a service](#invoke-a-service) |
29 | 30 | - [Get the request schema](#get-the-request-schema) |
30 | 31 | - [Get the response schema](#get-the-response-schema) |
| 32 | +<<<<<<< HEAD |
31 | 33 | - [Get the status of the service](#get-the-status-of-the-service) |
32 | 34 | - [Module Long Term Support Policy](#module-long-term-support-policy) |
| 35 | +======= |
| 36 | + - [Update a Service](#update-a-service) |
| 37 | + - [Delete a Service](#delete-a-service) |
| 38 | +>>>>>>> Complete README updates |
33 | 39 | - [License](#license) |
34 | 40 |
|
35 | 41 | <!-- END doctoc generated TOC please keep comment here to allow auto update --> |
36 | 42 |
|
37 | 43 | ## Node zosconnect |
38 | 44 |
|
39 | | -A wrapper service for z/OS® Connect, enabling node applications to discover and access zSystems resources |
40 | | -that are service enabled by z/OS® Connect. |
| 45 | +A wrapper service for z/OS® Connect EE, enabling node applications to discover and access zSystems resources |
| 46 | +that are service enabled by z/OS® Connect. Version 2 of this module pre-reqs z/OS Connect EE V3.0.8 or later. |
41 | 47 |
|
42 | | -Services are identified by name that is unique within the scope of the target z/OS® Connect instance |
43 | | -(or cluster). The node application uses pre-existing knowledge of the service name, or discovers it |
44 | | -dynamically by retrieving a list of available services. The z/OS® Connect node wrapper provides access |
45 | | -to JSON request and response schemas for the specific z/OS® Connect service, enabling the node |
46 | | -application to invoke that service and process the response. |
| 48 | +Services and APIs are identified by name that is unique within the scope of the target z/OS® Connect instance |
| 49 | +(or cluster). The node application uses pre-existing knowledge of the service or API name, or discovers it |
| 50 | +dynamically by retrieving a list of available services or APIs. The z/OS® Connect node wrapper provides access |
| 51 | +to JSON request and response schemas for the specific z/OS® Connect service and the Swagger document for APIs, |
| 52 | +enabling the node application to invoke that service and process the response. |
47 | 53 |
|
48 | 54 | ### Installing |
49 | 55 |
|
@@ -169,6 +175,12 @@ zosconnect.getApi('healthApi').then((api) => { |
169 | 175 | zosconnect.getServices().then(console.log); |
170 | 176 | ``` |
171 | 177 |
|
| 178 | +##### Create a Service |
| 179 | + |
| 180 | +```js |
| 181 | +zosconnect.createService(fs.readFileSync('dateTimeService.sar')).then(console.log); |
| 182 | +``` |
| 183 | + |
172 | 184 | ##### Get a service |
173 | 185 |
|
174 | 186 | ```js |
@@ -206,22 +218,29 @@ zosconnect.getService('dateTimeService').then((service) => { |
206 | 218 | }); |
207 | 219 | ``` |
208 | 220 |
|
209 | | -##### Get the status of the service |
| 221 | +##### Update a Service |
210 | 222 |
|
211 | 223 | ```js |
212 | 224 | zosconnect.getService('dateTimeService').then((service) => { |
213 | | - service.getStatus().then(console.log).catch(console.log); |
| 225 | + service.update(fs.readFileSync('dateTimeService.sar')).catch(console.log); |
214 | 226 | }); |
215 | 227 | ``` |
216 | 228 |
|
| 229 | +##### Delete a Service |
| 230 | + |
| 231 | +```js |
| 232 | +zosconnect.getService('dateTimeService').then((service) => { |
| 233 | + service.delete().catch(console.log); |
| 234 | +}) |
| 235 | +``` |
| 236 | + |
217 | 237 | ### Module Long Term Support Policy |
218 | 238 | This module adopts the [Module Long Term Support (LTS)](http://github.com/CloudNativeJS/ModuleLTS) policy, with the following End Of Life (EOL) dates: |
219 | 239 |
|
220 | 240 | | Module Version | Release Date | Minimum EOL | EOL With | Status | |
221 | 241 | |------------------|--------------|-------------|--------------|---------| |
222 | 242 | | V1.0.0 | Jul 2017 | Dec 2019 | Node 8 | Current | |
223 | 243 |
|
224 | | - |
225 | 244 | ### License |
226 | 245 | ``` |
227 | 246 | Licensed under the Apache License, Version 2.0 (the "License"); |
|
0 commit comments