diff --git a/README.md b/README.md index 98493826..e49614d4 100755 --- a/README.md +++ b/README.md @@ -8,6 +8,8 @@ This website is built using Docusaurus 2, a modern static website generator. ### Installation +You might need to disable Global Protect inorder to install docusaurus. + ```shell-session yarn ``` diff --git a/static/oas/iot/api/public/bulkUpdateSplunk.yaml b/static/oas/iot/api/public/bulkUpdateSplunk.yaml new file mode 100644 index 00000000..0e0b5829 --- /dev/null +++ b/static/oas/iot/api/public/bulkUpdateSplunk.yaml @@ -0,0 +1,54 @@ +parameters: + - description: The customer ID specifies the API call + in: query + name: customerid + required: true + schema: + type: string + - description: Source of integration + in: query + name: updateSource + required: true + schema: + type: string +requestBody: + required: true + content: + application/json: + schema: + $ref: '../../components/schemas.yaml#/schemas/SplunkBulkUpdateDevicePayloadSchema' + examples: + payloadExample: + $ref: '../../components/examples.yaml#/examples/SplunkDeviceBulkUpdatePayloadExample' +responses: + '200': + description: Successful Response + content: + application/json: + schema: + $ref: '../../components/schemas.yaml#/schemas/BulkUpdateDeviceResponseSchema' + examples: + resolveSecurityAlertResponseExample: + $ref: '../../components/examples.yaml#/examples/SplunkBulkUpdateDevicesResponseExample' + '4XX': + description: Client Error Response + content: + application/json: + schema: + $ref: '../../components/schemas.yaml#/schemas/ErrorResponse' + examples: + Bad Request: + $ref: '../../components/examples.yaml#/examples/BadRequestResponseExample' + Forbidden access: + $ref: '../../components/examples.yaml#/examples/UnauthorizedResponseExample' + Too many requests: + $ref: '../../components/examples.yaml#/examples/RateLimitResponseExample' + '5XX': + description: Server Error Response + content: + application/json: + schema: + $ref: '../../components/schemas.yaml#/schemas/ErrorResponse' + examples: + resolveSecurityAlertResponseExample: + $ref: '../../components/examples.yaml#/examples/ServerErrorResponseExample' \ No newline at end of file diff --git a/static/oas/iot/components/examples.yaml b/static/oas/iot/components/examples.yaml index 3c6c9280..c579689d 100644 --- a/static/oas/iot/components/examples.yaml +++ b/static/oas/iot/components/examples.yaml @@ -425,6 +425,15 @@ examples: updatedDeviceNum: 5 } + SplunkBulkUpdateDevicesResponseExample: + value: { + api: "device/bulkUpdate", + ver: "v4.0", + code: 1, + message: "OK", + updatedDeviceNum: 5 + } + IPAMSubnetBulkUpdateResponseExample: value: { api: "network/subnetBulkUpdate", @@ -597,6 +606,23 @@ examples: ] } + SplunkDeviceBulkUpdatePayloadExample: + value: { + devicelist: [ + { + "deviceid": "00:0c:29:8f:20:9a", + "model": "example_model", + "vendor": "example_vendor", + "os_combined": "example_os_combined", + "os_group": "example_os_group", + "serial_number": "serial_number", + "netbios_domain": "example_domain", + "netbios_hn": "example_hostname", + "dns_hn": "example_hostname", + } + ] + } + IPAMSubnetBulkUpdatePayloadExample: value: { "overwrite": true, diff --git a/static/oas/iot/components/schemas.yaml b/static/oas/iot/components/schemas.yaml index b98663a6..185ddcb6 100644 --- a/static/oas/iot/components/schemas.yaml +++ b/static/oas/iot/components/schemas.yaml @@ -802,6 +802,37 @@ schemas: vendor: type: string + SplunkBulkUpdateDevicePayloadSchema: + type: object + required: + - devicelist + properties: + devicelist: + type: array + description: devices + items: + type: object + properties: + deviceid: + type: string + description: Required field + model: + type: string + vendor: + type: string + os_combined: + type: string + os_group: + type: string + serial_number: + type: string + netbios_domain: + type: string + netbios_hn: + type: string + dns_hn: + type: string + BulkUpdateDeviceResponseSchema: type: object properties: diff --git a/static/oas/iot/iot.yaml b/static/oas/iot/iot.yaml index e123a0cd..e8984ce8 100644 --- a/static/oas/iot/iot.yaml +++ b/static/oas/iot/iot.yaml @@ -268,7 +268,24 @@ paths: $ref: 'api/public/bulkUpdateCrowdstrike.yaml#/requestBody' responses: $ref: 'api/public/bulkUpdateCrowdstrike.yaml#/responses' - + + /pub/v4.0/device/bulkUpdate?updateSource=splunk: + put: + description: 'Bulk device updates for Splunk devices' + operationId: splunk-bulk-update + security: + - X-Key-Id: [] + X-Access-Key: [] + summary: Bulk Device Updates - Splunk Devices + tags: + - IoT Public API + parameters: + $ref: 'api/public/bulkUpdateSplunk.yaml#/parameters' + requestBody: + $ref: 'api/public/bulkUpdateSplunk.yaml#/requestBody' + responses: + $ref: 'api/public/bulkUpdateSplunk.yaml#/responses' + /pub/v4.0/network/subnetBulkUpdate?updateSource=ipam_infoblox: put: description: 'Bulk subnet updates from customer IPAM (infoblox)'