Releases: splunk/splunk-cloud-sdk-js
Release v16.0.0-beta6
Breaking Changes
-
Catalog service
:- v2beta1:
- Apis whose name ends with
ById
have changed by removingById
in the name , and apis whose name ends withByResourceName
have changed by removingByResourceName
in the name - Apis of
createWorkflow
,createWorkflowBuild
,createWorkflowRun
,deleteWorkflowBuildById
,deleteWorkflowById
,GetWorkflowBuildById
,getWorkflowRunById
,listWorkflows
,updateWorkflowBuildById
were removed
- Apis whose name ends with
- v2beta1:
-
Search service
:- v2:
- Apis of
refreshFederatedConnection()
andtestFederatedConnection()
removed the input parameter ofbody
- Apis of
- v3alpha1:
- Apis of
refreshFederatedConnection()
andtestFederatedConnection()
removed the input parameter ofbody
- Apis of
- v2:
Non-Breaking Changes
identity service
:- v3:
- Added new apis of
getEntitlements
,updateEntitlements
- Added new apis of
- v3:
search service
:- v2:
- Added new apis of
createDataset
,deleteDatasetById
,getDatasetById
,listDatasets
,getAllFederatedConnections
- Added new apis of
- v3alpha1:
- Added new api of
getAllFederatedConnections
- Added new api of
- v2:
Release v14.0.0
Services
Breaking Changes
Features
-
Catalog v2beta1:
createDatasetImport
returns datatype ofDataset
(replaced 'ImportDataset')createDatasetImportById
returnsDatasetImportedby
(replaced 'ImportDataset')DatasetImportedBy
has a new propertyowner
and propertyname
is now optional
-
Provisioner v1beta1:
- Model
ECStackName
renamed toEcStackName
- Model
-
Search v2beta1:
- Model
ListSearchResultsResponseFields
renamed toListPreiviewResultsResponseFields
- Model
-
Search v3alpha1:
- Model
ListSearchResultsResponseFields
renamed toListPreiviewResultsResponseFields
- Model
-
Stream v3beta1:
- Model
RulesSourcetypesResponse
renamed toRulesPackageSourcetypes
- Model
RulesActionsResponse
renamed toRulesPackageActions
- Model
Non-Breaking Changes
Features
-
Auth
ServicePrincipalAuthManager
added to Auth service
-
Identity v2beta1:
- New model
AddInvisibleMemberBody
added - New endpoints
addInvisibleMember
,getMemberAdmin
andremoveMemberAdmin
added - New properties
expiresAt
andvisible
added toMember
model - New models
DeviceAuthInfo
andUpdateRoleBody
added
- New model
-
Identity v3alpha1:
- New version introduced
-
Ingest v1beta2:
- New models
UploadSuccessResponse
andFileUploadDetails
added
- New models
-
KVStore v1beta1:
- New endpoint
truncateRecords
added
- New endpoint
-
Search v3alpha1:
- New models
SearchModule
,StatementDispatchStatus
, andSingleSatatementQueryParamters
added - New endpoints
createMultiSearchMethod
andcreateSearchStatements
added
- New models
-
Streams v2beta1:
- New property
messages
added to modelConnectionSaveResponse
- New property
complexity
added to modelPipelineResponse
- New property
activateLatestVersion
added to modelReactivatePipelineRequest
- New property
-
Streams v3beta1:
- New models
CollectJobPatchRequest
,DataStream
,DataStreamRequest
,DataStreamResponse
,EntitlementRequest
,
EntitlementResponse
,PaginatedResponseOfRuleKind
,RulesKind
andPluginResponse
- New endpoints
createDataStream
,deleteCollectJob
,deletedatastream
,deleteEntitlements
,deleteRulesPackage
,
describeDataStream
,getEntitlements
,getRulesPackageById
,listDataStreams
,listRuleKinds
,releaseInfo
,
setEntitlements
,updateCollectJob
,updateDataStream
andupdateRulesPackageById
added
- New models
Release v13.0.0
Bug Fixes
- whitelist to allowlist (dde9eb0)
Breaking Changes
- App Registry
WebAppPOST
has been removed
Non-Breaking Changes
- Catalog
extract_fields
has been added
- Search
extract_fields
has been added
- Streams
PaginatedResponseOfCollectJobResponse
has been addedRulesResponse
has been addedRulesSourcetypesResponse
has been addedRulesActionsResponse
has been addedPaginatedResponseOfRulesResponse
has been addedRulesRequest
has been added
Release v12.0.0
Features
- update with code-generated api bindings and models performed 2020-08-19 (7fc330b)
Breaking Changes
Catalog service v2beta1
: getDataset, getDatasetById and listDatasets endpoints now return data type of DatasetGet instead of Dataset
Identify service v2beta1
: remove endpoint of setPrincipalPublicKeys
Kvstore service v1beta1
: insertRecords endpoint has a new parameter of allowUpdates
Stream service v3beta1
: remove endpoint of uploadPlugin
Non-Breaking Changes
Identify service v2beta1
:
- new endpoints added addPrincipalPublicKey, getPrincipalPublicKey, getPrincipalPublicKeys, deletePrincipalPublicKey, and updatePrincipalPublicKey
Stream service v3beta1
:
- new endpoints added: startCollectJob and stopCollectJob
Bug Fixes
- fix requestStatusCallback to be not be async (e87ba5d)
Release 16.0.0-beta4
Breaking Changes
- KVstore service (v1beta1):
_key
in modelGeneratedRecord
is renamed askey
Non-Breaking Changes
-
KVstore service (v1beta1):
deleteRecords()
has added a new optional input parameter ofenableMvl
;queryRecords()
has added new optional input parameters ofenableMvl
andshared
-
Search service (v3alpha1): new api of
listDatasets()
is added -
Streams service (v3beta1):
listPipelines()
has added a new optional input parameter ofincludeStatus
; new api ofdeleteSource()
is added
Release v16.0.0-beta3
Features
Breaking Changes
-
Ingest Service (v1beta2):
- Model
HECResponse
andInlineObject
have been removed
- Model
-
KVStore Service (v1beta1):
- Model
Key
renamed toRecord
and has an additional required fielduser
- Endpoints
insertRecord
andputRecord
have returnType Promise (earlier it was Promise)
- Model
-
Search Service (v3alpha1):
- Models
RecurringSearch
andUpdateRecurringSearch
have been removed - Endpoint
createDataset
takes in argumentDatasetPOST
instead ofDataset
- Endpoint
updateDatasetById
takes in argumentDatasetPATCH
instead ofDataset
- Endpoint
deleteDatasetById
has a returnTypePromise<object>
instead ofPromise<Dataset>
- Endpoint
listSpl2Modules
has a returnTypePromise<ListModules>
instead ofPromise<Array<Module>>
- Endpoints
createRecurringSearch
,deleteRecurringSearch
,getAllJobsForRecurringSearch
,getJobForRecurringSearch
,getRecurringSearch
,listRecurringSearches
andupdateRecurringSearch
have been removed
- Models
Non-Breaking Changes
-
Identity Service (v3):
- Models
ResetPasswordBody
,UpdateGroupBody
,UpdatePasswordBody
,UpdateRoleBody
have been added - Endpoints
resetPassword
,updatePassword
,updateGroup
,updateRole
have been added - Parameters
description
anddisplayName
have been added to modelsCreateGroupBody
,CreateRoleBody
,Role
, andGroup
.
- Models
-
Search Service (v3alpha1):
- Models
DatasetPATCH
,DatasetPOST
,FederatedConnection
,FederatedConnectionInput
andListModules
have been added - Endpoints
createFederatedConnection
,deleteFederatedConnection
,getFederatedConnectionByName
andputFederatedConnectionByName
have been added
- Models
-
Streams Service (v3beta1):
- Models
PipelineReactivateResponseAsync
,PipelineReactivationStatus
,UpgradePipelineRequest
andValidateConnectionRequest
have been added. - Parameter
skipValidation
has been added tocreateConnection
endpoint - Parameter
createUserId
has been added tolistTemplates
endpoint - Endpoints
reactivationStatus
,validateConnection
, andupgradePipeline
have been added - Parameter
metadata
has been added toConnectorResponse
- Parameter
labels
has been added toPipelinePatchRequest
,PipelineRequest
andPipelineResponse
models - Parameter
uberJarSha256
has been added toPipelineResponse
model ACTIVATING
andDEACTIVATING
have been added to modelPipelineResponse
status enum- Model
Source
has changed with propertiesnode
andpipelineVersion
deleted and 18 new properties added - Parameter
learnMoreLocation
has been added to modelTemplateResponse
- Models
-
Added support for file upload endpoints with a content-type multipart/form-data
Release v16.0.0-beta2
Breaking Changes
-
Identity service:
useDefaultIdp
optional property was removed fromTenant
model in v2beta1 and v3 -
Ingest service:
postCollectorRaw
andpostCollectorRawV1
APIs were removed from v1beta2- In v1beta2/GeneratedHECResponse:
invalid_event_number
was renamed asinvalidEventNumber
- In v1beta2/GeneratedHECTokenAccessResponse:
ack_enabled
was renamed asackEnabled
,allow_query_string_auth
was renamed asallowQueryStringAuth
,created_at
was renamed ascreatedAt
,
created_by
was renamed ascreatedBy
,last_modified_at
was renamed aslastModifiedAt
,last_modified_by
was renamed aslastModifiedBy
- In v1beta2/GeneratedHECTokenUpdateRequest,
ack_enabled
was renamed asackEnabled
,allow_query_string_auth
was renamed asallowQueryStringAuth
-
Streams service:
createDataStream
,deleteDataStream
,describeDataStream
,listDataStreams
, andupdateDataStream
APIs were removed in v3beta1
Non-Breaking Changes
-
Search service: updated to target v2 endpoints (previously v2beta1) including new endpoint of
exportResults
-
Identity service:
-
added new APIs of
createIdentityProvider
,deleteIdentityProvider
,getIdentityProvider
,listIdentityProvider
, andupdateIdentityProvider
in v2beta1 and v3 -
New optional property
acceptTos
forCreatePrincipalBody
was added in v2beta1 and v3
-
-
Streams service: Added new APIs of
uploadFile
anduploadLookupFile
Release v16.0.0-beta1
Features
- Add support to tenant-scoped hostname: initiate the client with
hostname
set to enable the client visit endpoints using tenant-scoped url. Example:
new ServiceClient( { tokenSource:'your-token-source', defaultTenant: 'your-tenant', hostname: new Hostname('domain','region') });
Release v15.0.0
Services
Breaking Changes
Features
-
Identity v2beta1:
- Model
AddInvisibleMemberBody
removed - Enpoints
addInvisibleMember
,getMemberAdmin
andremoveMemberAdmin
removed
- Model
-
Provisioner v1beta1
- Models
CreateProvisionJobBody
,ProvisionJobInfo
,ProvisionJobInfoErrors
,ProvisionJobInfoErrors
and
ProvisionJobs
removed - Endpoints
createProvisionJob
,getProvisionJob
andlistProvisionJobs
removed
- Models
-
Streams v3beta1:
-
Models
CollectJobPatchRequest
,CollectJobRequest
,CollectJobResponse
,CollectJobStartStopResponse
,
EntitlementRequest
,EntitlementResponse
,PaginatedResponseOfCollectJobResponse
,PaginatedResponseOfPlugin
,
PaginatedResponseOfRulesResponse
,PaginatedResponseOfRuleKind
,Plugin
,PluginPatchRequest
,PluginRequest
,
PluginResponse
,RulesRequest
andRulesResponse
removed -
Model
UploadFile
renamed toUploadFileResponse
-
Endpoints
createCollectJob
,createRulesPackage
,deleteCollectJobs
,deleteCollectJob
,deleteEntitlements
,
deletePlugin
,deleteRulesPackage
,getCollectJob
,getEntitlements
,getPlugins
,getRulesPackageById
,
listCollectJobs
,listRulesKinds
,listRulesPackages
,patchPlugin
,registerPlugin
,releaseInfo
,
setEntitlements
,startCollectJob
,stopCollectJob
,updateCollectJob
,updatePlugin
andupdateRulesPackageById
removed
-
Non-Breaking Changes
Features
-
Identity v2beta1:
- New model
CreatePrincipalBody
added - New endpoint
createPrincipal
added
- New model
-
Identity v3:
- New version introduced
-
Identity v3alpha1
- New models
GroupMemberList
andGroupRoleList
added
- New models
-
Ingest v1beta2:
- New endpoints
postCollectorRaw
andpostCollectorRawV1
added
- New endpoints
-
Streams v2beta1:
- New property
attributes
added toConnectorResponse
- New property
statusDescription
added toPipelineReactivateResponse
- New parameter
functionOp
added tolistConnections
- New property
-
Streams v3beta1
- New model
UploadFileResponse
added - New endpoint
deleteLookupFile
,getLookupFileMetadata
andgetLookupFilesMetadata
added
- New model
Release v11.0.1
BugFix
Adding CHANGELOG.md