@itentialopensource/adapter-netbox 0.8.0 → 0.11.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.
Files changed (46) hide show
  1. package/AUTH.md +9 -15
  2. package/CALLS.md +2447 -22
  3. package/CHANGELOG.md +24 -0
  4. package/CONTRIBUTING.md +1 -160
  5. package/ENHANCE.md +2 -2
  6. package/README.md +32 -23
  7. package/SYSTEMINFO.md +12 -3
  8. package/adapter.js +2483 -1839
  9. package/adapterBase.js +549 -879
  10. package/changelogs/changelog.md +181 -0
  11. package/entities/Dcim/action.json +182 -0
  12. package/entities/Dcim/mockdatafiles/getDcimLocations-default.json +688 -0
  13. package/entities/Dcim/schema.json +82 -19
  14. package/metadata.json +69 -0
  15. package/package.json +24 -24
  16. package/pronghorn.json +15221 -12889
  17. package/propertiesSchema.json +422 -31
  18. package/refs?service=git-upload-pack +0 -0
  19. package/report/adapter-openapi.json +52536 -0
  20. package/report/adapter-openapi.yaml +37346 -0
  21. package/report/adapterInfo.json +8 -8
  22. package/report/updateReport1691508495299.json +120 -0
  23. package/report/updateReport1692202980865.json +120 -0
  24. package/report/updateReport1694466470665.json +120 -0
  25. package/sampleProperties.json +65 -4
  26. package/test/integration/adapterTestBasicGet.js +2 -4
  27. package/test/integration/adapterTestConnectivity.js +91 -42
  28. package/test/integration/adapterTestIntegration.js +383 -2
  29. package/test/unit/adapterBaseTestUnit.js +388 -313
  30. package/test/unit/adapterTestUnit.js +599 -112
  31. package/utils/adapterInfo.js +1 -1
  32. package/utils/addAuth.js +1 -1
  33. package/utils/artifactize.js +1 -1
  34. package/utils/checkMigrate.js +1 -1
  35. package/utils/entitiesToDB.js +2 -2
  36. package/utils/findPath.js +1 -1
  37. package/utils/methodDocumentor.js +260 -0
  38. package/utils/modify.js +13 -15
  39. package/utils/packModificationScript.js +1 -1
  40. package/utils/pre-commit.sh +2 -0
  41. package/utils/taskMover.js +309 -0
  42. package/utils/tbScript.js +89 -34
  43. package/utils/tbUtils.js +41 -21
  44. package/utils/testRunner.js +1 -1
  45. package/utils/troubleshootingAdapter.js +9 -6
  46. package/workflows/README.md +0 -3
@@ -0,0 +1,181 @@
1
+
2
+ ## 0.9.0 [08-05-2022]
3
+
4
+ * Add dcim location calls
5
+
6
+ See merge request itentialopensource/adapters/inventory/adapter-netbox!16
7
+
8
+ ---
9
+
10
+ ## 0.8.0 [05-23-2022]
11
+
12
+ * Migration to the latest Adapter Foundation
13
+
14
+ See merge request itentialopensource/adapters/inventory/adapter-netbox!15
15
+
16
+ ---
17
+
18
+ ## 0.7.1 [03-07-2022]
19
+
20
+ - Fix graphql with sendGetBody
21
+ - Migration
22
+ - Add some items to .gitignore (e.g. DS_Store) to keep them out of the repos.
23
+ - Changes to the README (some typo fixes - Add how to extend the adapter). Split the README into various markdown files (AUTH, BROKER, CALLS, ENHANCE, PROPERTIES, SUMMARY, SYSTEMINFO, TROUBLESHOOT)
24
+ - Fix the issues with Confluence in the markdowns (Tables, Lists, Links)
25
+ - Add scripts for easier authentication, removing hooks, etc
26
+ - Script changes (install script as well as database changes in other scripts)
27
+ - Double # of path vars on generic call
28
+ - Update versions of foundation (e.g. adapter-utils)
29
+ - Update npm publish so it supports https
30
+ - Update dependencies
31
+ - Add preinstall for minimist
32
+ - Fix new lint issues that came from eslint dependency change
33
+ - Add more thorough Unit tests for standard files (Package, Pronghorn, Properties (Schema and Sample)
34
+ - Add the adapter type in the package.json
35
+ - Add AdapterInfo.js script
36
+ - Add json-query dependency
37
+ - Add the propertiesDecorators.json for product encryption
38
+ - Change the name of internal IAP/Adapter methods to avoid collisions and make more obvious in Workflow - iapRunAdapterBasicGet, iapRunAdapterConnectivity, iapRunAdapterHealthcheck, iapTroubleshootAdapter, iapGetAdapterQueue, iapUnsuspendAdapter, iapSuspendAdapter, iapFindAdapterPath, iapUpdateAdapterConfiguration, iapGetAdapterWorkflowFunctions
39
+ - Add the adapter config in the database support - iapMoveAdapterEntitiesToDB
40
+ - Add standard broker calls - hasEntities, getDevice, getDevicesFiltered, isAlive, getConfig and iapGetDeviceCount
41
+ - Add genericAdapterRequest that does not use the base_path and version so that the path can be unique - genericAdapterRequestNoBasePath
42
+ - Add AdapterInfo.json
43
+ - Add systemName for documentation
44
+
45
+ See merge request itentialopensource/adapters/inventory/adapter-netbox!14
46
+
47
+ ---
48
+
49
+ ## 0.7.0 [02-14-2022]
50
+
51
+ - Migration and added a call for graphql
52
+
53
+ See merge request itentialopensource/adapters/inventory/adapter-netbox!13
54
+
55
+ ---
56
+
57
+ ## 0.6.4 [07-13-2021]
58
+
59
+ - The current healthcheck /api/docs/ returns HTML payload that the adapter does not appear able to parse as is. The /api/status returns a minimal JSON response and appears suitable for a healthcheck request to use in the adapter-netbox code.
60
+
61
+ See merge request itentialopensource/adapters/inventory/adapter-netbox!12
62
+
63
+ ---
64
+
65
+ ## 0.6.3 [03-17-2021]
66
+
67
+ - Fix descriptions and summaries
68
+
69
+ See merge request itentialopensource/adapters/inventory/adapter-netbox!11
70
+
71
+ ---
72
+
73
+ ## 0.6.2 [03-10-2021]
74
+
75
+ - Migration to bring up to the latest foundation
76
+ - Change to .eslintignore (adapter_modification directory)
77
+ - Change to README.md (new properties, new scripts, new processes)
78
+ - Changes to adapterBase.js (new methods)
79
+ - Changes to package.json (new scripts, dependencies)
80
+ - Changes to propertiesSchema.json (new properties and changes to existing)
81
+ - Changes to the Unit test
82
+ - Adding several test files, utils files and .generic entity
83
+ - Fix order of scripts and dependencies in package.json
84
+ - Fix order of properties in propertiesSchema.json
85
+ - Update sampleProperties, unit and integration tests to have all new properties.
86
+ - Add all new calls to adapter.js and pronghorn.json
87
+ - Add suspend piece to older methods
88
+
89
+ See merge request itentialopensource/adapters/inventory/adapter-netbox!10
90
+
91
+ ---
92
+
93
+ ## 0.6.1 [01-28-2021]
94
+
95
+ - Changed version of netbox integrating with to 2.8.5 also provide schemas and allow for custom fields in get calls to be available as filters
96
+
97
+ See merge request itentialopensource/adapters/inventory/adapter-netbox!9
98
+
99
+ ---
100
+
101
+ ## 0.6.0 [07-27-2020]
102
+
103
+ - Changed version of netbox integrating with to 2.8.5 also provide schemas and allow for custom fields in get calls to be available as filters
104
+
105
+ See merge request itentialopensource/adapters/inventory/adapter-netbox!8
106
+
107
+ ---
108
+
109
+ ## 0.5.3 [07-08-2020]
110
+
111
+ - Update the adapter to the latest foundation
112
+
113
+ See merge request itentialopensource/adapters/inventory/adapter-netbox!7
114
+
115
+ ---
116
+
117
+ ## 0.5.2 [01-13-2020]
118
+
119
+ - bring up to the latest adapter foundation
120
+
121
+ See merge request itentialopensource/adapters/inventory/adapter-netbox!6
122
+
123
+ ---
124
+
125
+ ## 0.5.1 [11-18-2019]
126
+
127
+ - Changes to the healthcheck so it is a tested path
128
+
129
+ See merge request itentialopensource/adapters/inventory/adapter-netbox!5
130
+
131
+ ---
132
+
133
+ ## 0.5.0 [11-08-2019]
134
+
135
+ - Update the adapter to the latest adapter foundation.
136
+ - Updating to adapter-utils 4.24.3 (automatic)
137
+ - Add sample token schemas (manual)
138
+ - Adding placement property to getToken response schema (manual - before encrypt)
139
+ - Adding sso default into action.json for getToken (manual - before response object)
140
+ - Add new adapter properties for metrics & mock (save_metric, mongo and return_raw) (automatic - check place manual before stub)
141
+ - Update sample properties to include new properties (manual)
142
+ - Update integration test for raw mockdata (automatic)
143
+ - Update test properties (manual)
144
+ - Changes to artifactize (automatic)
145
+ - Update type in sampleProperties so it is correct for the adapter (manual)
146
+ - Update the readme (automatic)
147
+
148
+ See merge request itentialopensource/adapters/inventory/adapter-netbox!4
149
+
150
+ ---
151
+
152
+ ## 0.4.0 [09-16-2019]
153
+
154
+ - Update the adapter to the latest adapter foundation
155
+
156
+ See merge request itentialopensource/adapters/inventory/adapter-netbox!3
157
+
158
+ ---
159
+ ## 0.3.0 [07-30-2019] & 0.2.0 [07-17-2019]
160
+
161
+ - Migrate to the latest adapter foundation, categorize and prepare for app artifact
162
+
163
+ See merge request itentialopensource/adapters/inventory/adapter-netbox!2
164
+
165
+ ---
166
+
167
+ ## 0.1.2 [04-23-2019]
168
+
169
+ - Added keys, update and set versions that this adapter was built with
170
+
171
+ See merge request itentialopensource/adapters/adapter-netbox!1
172
+
173
+ ---
174
+
175
+ ## 0.1.1 [04-16-2019]
176
+
177
+ - Initial Commit
178
+
179
+ See commit ca1af4e
180
+
181
+ ---
@@ -4197,6 +4197,188 @@
4197
4197
  "mockFile": ""
4198
4198
  }
4199
4199
  ]
4200
+ },
4201
+ {
4202
+ "name": "getDcimLocations",
4203
+ "protocol": "REST",
4204
+ "method": "GET",
4205
+ "entitypath": "{base_path}/{version}/dcim/locations/?{query}",
4206
+ "requestSchema": "schema.json",
4207
+ "responseSchema": "schema.json",
4208
+ "timeout": 0,
4209
+ "sendEmpty": false,
4210
+ "sendGetBody": false,
4211
+ "requestDatatype": "JSON",
4212
+ "responseDatatype": "JSON",
4213
+ "headers": {},
4214
+ "responseObjects": [
4215
+ {
4216
+ "type": "default",
4217
+ "key": "",
4218
+ "mockFile": "mockdatafiles/getDcimLocations-default.json"
4219
+ }
4220
+ ]
4221
+ },
4222
+ {
4223
+ "name": "postDcimLocations",
4224
+ "protocol": "REST",
4225
+ "method": "POST",
4226
+ "entitypath": "{base_path}/{version}/dcim/locations/?{query}",
4227
+ "requestSchema": "schema.json",
4228
+ "responseSchema": "schema.json",
4229
+ "timeout": 0,
4230
+ "sendEmpty": false,
4231
+ "requestDatatype": "JSON",
4232
+ "responseDatatype": "JSON",
4233
+ "headers": {},
4234
+ "responseObjects": [
4235
+ {
4236
+ "type": "default",
4237
+ "key": "",
4238
+ "mockFile": ""
4239
+ }
4240
+ ]
4241
+ },
4242
+ {
4243
+ "name": "putDcimLocations",
4244
+ "protocol": "REST",
4245
+ "method": "PUT",
4246
+ "entitypath": "{base_path}/{version}/dcim/locations/?{query}",
4247
+ "requestSchema": "schema.json",
4248
+ "responseSchema": "schema.json",
4249
+ "timeout": 0,
4250
+ "sendEmpty": false,
4251
+ "requestDatatype": "JSON",
4252
+ "responseDatatype": "JSON",
4253
+ "headers": {},
4254
+ "responseObjects": [
4255
+ {
4256
+ "type": "default",
4257
+ "key": "",
4258
+ "mockFile": ""
4259
+ }
4260
+ ]
4261
+ },
4262
+ {
4263
+ "name": "patchDcimLocations",
4264
+ "protocol": "REST",
4265
+ "method": "PATCH",
4266
+ "entitypath": "{base_path}/{version}/dcim/locations/?{query}",
4267
+ "requestSchema": "schema.json",
4268
+ "responseSchema": "schema.json",
4269
+ "timeout": 0,
4270
+ "sendEmpty": false,
4271
+ "requestDatatype": "JSON",
4272
+ "responseDatatype": "JSON",
4273
+ "headers": {},
4274
+ "responseObjects": [
4275
+ {
4276
+ "type": "default",
4277
+ "key": "",
4278
+ "mockFile": ""
4279
+ }
4280
+ ]
4281
+ },
4282
+ {
4283
+ "name": "deleteDcimLocations",
4284
+ "protocol": "REST",
4285
+ "method": "DELETE",
4286
+ "entitypath": "{base_path}/{version}/dcim/locations/?{query}",
4287
+ "requestSchema": "schema.json",
4288
+ "responseSchema": "schema.json",
4289
+ "timeout": 0,
4290
+ "sendEmpty": false,
4291
+ "requestDatatype": "JSON",
4292
+ "responseDatatype": "JSON",
4293
+ "headers": {},
4294
+ "responseObjects": [
4295
+ {
4296
+ "type": "default",
4297
+ "key": "",
4298
+ "mockFile": ""
4299
+ }
4300
+ ]
4301
+ },
4302
+ {
4303
+ "name": "getDcimLocationsId",
4304
+ "protocol": "REST",
4305
+ "method": "GET",
4306
+ "entitypath": "{base_path}/{version}/dcim/locations/{pathv1}/?{query}",
4307
+ "requestSchema": "schema.json",
4308
+ "responseSchema": "schema.json",
4309
+ "timeout": 0,
4310
+ "sendEmpty": false,
4311
+ "sendGetBody": false,
4312
+ "requestDatatype": "JSON",
4313
+ "responseDatatype": "JSON",
4314
+ "headers": {},
4315
+ "responseObjects": [
4316
+ {
4317
+ "type": "default",
4318
+ "key": "",
4319
+ "mockFile": ""
4320
+ }
4321
+ ]
4322
+ },
4323
+ {
4324
+ "name": "putDcimLocationsId",
4325
+ "protocol": "REST",
4326
+ "method": "PUT",
4327
+ "entitypath": "{base_path}/{version}/dcim/locations/{pathv1}/?{query}",
4328
+ "requestSchema": "schema.json",
4329
+ "responseSchema": "schema.json",
4330
+ "timeout": 0,
4331
+ "sendEmpty": false,
4332
+ "requestDatatype": "JSON",
4333
+ "responseDatatype": "JSON",
4334
+ "headers": {},
4335
+ "responseObjects": [
4336
+ {
4337
+ "type": "default",
4338
+ "key": "",
4339
+ "mockFile": ""
4340
+ }
4341
+ ]
4342
+ },
4343
+ {
4344
+ "name": "patchDcimLocationsId",
4345
+ "protocol": "REST",
4346
+ "method": "PATCH",
4347
+ "entitypath": "{base_path}/{version}/dcim/locations/{pathv1}/?{query}",
4348
+ "requestSchema": "schema.json",
4349
+ "responseSchema": "schema.json",
4350
+ "timeout": 0,
4351
+ "sendEmpty": false,
4352
+ "requestDatatype": "JSON",
4353
+ "responseDatatype": "JSON",
4354
+ "headers": {},
4355
+ "responseObjects": [
4356
+ {
4357
+ "type": "default",
4358
+ "key": "",
4359
+ "mockFile": ""
4360
+ }
4361
+ ]
4362
+ },
4363
+ {
4364
+ "name": "deleteDcimLocationsId",
4365
+ "protocol": "REST",
4366
+ "method": "DELETE",
4367
+ "entitypath": "{base_path}/{version}/dcim/locations/{pathv1}/?{query}",
4368
+ "requestSchema": "schema.json",
4369
+ "responseSchema": "schema.json",
4370
+ "timeout": 0,
4371
+ "sendEmpty": false,
4372
+ "requestDatatype": "JSON",
4373
+ "responseDatatype": "JSON",
4374
+ "headers": {},
4375
+ "responseObjects": [
4376
+ {
4377
+ "type": "default",
4378
+ "key": "",
4379
+ "mockFile": ""
4380
+ }
4381
+ ]
4200
4382
  }
4201
4383
  ]
4202
4384
  }