@itentialopensource/adapter-nokia_altiplano 0.2.0 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,4 +1,28 @@
1
1
 
2
+ ## 0.5.0 [05-02-2022]
3
+
4
+ * Add calls for ema entity
5
+
6
+ See merge request itentialopensource/adapters/controller-orchestrator/adapter-nokia_altiplano!6
7
+
8
+ ---
9
+
10
+ ## 0.4.0 [03-30-2022]
11
+
12
+ * added ibn intent calls
13
+
14
+ See merge request itentialopensource/adapters/controller-orchestrator/adapter-nokia_altiplano!5
15
+
16
+ ---
17
+
18
+ ## 0.3.0 [03-25-2022]
19
+
20
+ * add new call createOntWithQuery
21
+
22
+ See merge request itentialopensource/adapters/controller-orchestrator/adapter-nokia_altiplano!4
23
+
24
+ ---
25
+
2
26
  ## 0.2.0 [03-18-2022]
3
27
 
4
28
  * Migration and creation of md files
package/ENHANCE.md CHANGED
@@ -1,10 +1,10 @@
1
- ## Extending/Enhancing the Adapter
1
+ ### Enhancements
2
2
 
3
- ### Adding a Second Instance of an Adapter
3
+ #### Adding a Second Instance of an Adapter
4
4
 
5
5
  You can add a second instance of this adapter without adding new code on the file system. To do this go into the IAP Admin Essentials and add a new service config for this adapter. The two instances of the adapter should have unique ids. In addition, they should point to different instances of the other system. For example, they should be configured to talk to different hosts.
6
6
 
7
- ### Adding Adapter Calls
7
+ #### Adding Adapter Calls
8
8
 
9
9
  There are multiple ways to add calls to an existing adapter.
10
10
 
@@ -30,7 +30,7 @@ Files to update
30
30
  * test/integration/adapterTestIntegration.js (optional but best practice): add integration test
31
31
  ```
32
32
 
33
- ### Adding Adapter Properties
33
+ #### Adding Adapter Properties
34
34
 
35
35
  While changing adapter properties is done in the service instance configuration section of IAP, adding properties has to be done in the adapter. To add a property you should edit the propertiesSchema.json with the proper information for the property. In addition, you should modify the sampleProperties to have the new property in it.
36
36
 
@@ -42,7 +42,7 @@ Files to update
42
42
  * test/integration/adapterTestIntegration.js (optional but best practice): add the property to the global properties
43
43
  ```
44
44
 
45
- ### Changing Adapter Authentication
45
+ #### Changing Adapter Authentication
46
46
 
47
47
  Often an adapter is built before knowing the authentication and authentication process can also change over time. The adapter supports many different kinds of authentication but it does require configuration. Some forms of authentication can be defined entirely with the adapter properties but others require configuration.
48
48
 
@@ -57,7 +57,7 @@ Files to update
57
57
  * test/integration/adapterTestIntegration.js (optional but best practice): add the property to the global properties
58
58
  ```
59
59
 
60
- ### Enhancing Adapter Integration Tests
60
+ #### Enhancing Adapter Integration Tests
61
61
 
62
62
  The adapter integration tests are written to be able to test in either stub (standalone) mode or integrated to the other system. However, if integrating to the other system, you may need to provide better data than what the adapter provides by default as that data is likely to fail for create and update. To provide better data, edit the adapter integration test file. Make sure you do not remove the marker and keep custom code below the marker so you do not impact future migrations. Once the edits are complete, run the integration test as it instructs you to above. When you run integrated to the other system, you can also save mockdata for future use by changing the isSaveMockData flag to true.
63
63
 
package/PROPERTIES.md CHANGED
@@ -1,6 +1,6 @@
1
- ## Adapter Properties and Descriptions
1
+ ## Configuration
2
2
 
3
- This section defines **all** the properties that are available for the adapter, including detailed information on what each property is for. If you are not using certain capabilities with this adapter, you do not need to define all of the properties. An example of how the properties for this adapter can be used with tests or IAP are provided in the **Installation** section.
3
+ This section defines **all** the properties that are available for the adapter, including detailed information on what each property is for. If you are not using certain capabilities with this adapter, you do not need to define all of the properties. An example of how the properties for this adapter can be used with tests or IAP are provided in the sampleProperties.
4
4
 
5
5
  ```json
6
6
  {
@@ -25,7 +25,10 @@ This section defines **all** the properties that are available for the adapter,
25
25
  "token_cache": "local",
26
26
  "auth_field": "header.headers.X-AUTH-TOKEN",
27
27
  "auth_field_format": "{token}",
28
- "auth_logging": false
28
+ "auth_logging": false,
29
+ "client_id": "",
30
+ "client_secret": "",
31
+ "grant_type": ""
29
32
  },
30
33
  "healthcheck": {
31
34
  "type": "startup",
@@ -133,6 +136,9 @@ The following properties are used to define the authentication process to Nokia_
133
136
  | auth\_field | Defines the request field the authentication (e.g., token are basic auth credentials) needs to be placed in order for the calls to work.|
134
137
  | auth\_field\_format | Defines the format of the auth\_field. See examples below. Items enclosed in {} inform the adapter to perofrm an action prior to sending the data. It may be to replace the item with a value or it may be to encode the item. |
135
138
  | auth\_logging | Setting this true will add some additional logs but this should only be done when trying to debug an issue as certain credential information may be logged out when this is true. |
139
+ | client\_id | Provide a client id when needed, this is common on some types of OAuth. |
140
+ | client\_secret | Provide a client secret when needed, this is common on some types of OAuth. |
141
+ | grant\_type | Provide a grant type when needed, this is common on some types of OAuth. |
136
142
 
137
143
  #### Examples of authentication field format
138
144