Releases: splunk/splunk-cloud-sdk-js
Release v16.0.0-beta6
Breaking Changes
-
Catalog service:- v2beta1:
- Apis whose name ends with
ByIdhave changed by removingByIdin the name , and apis whose name ends withByResourceNamehave changed by removingByResourceNamein the name - Apis of
createWorkflow,createWorkflowBuild,createWorkflowRun,deleteWorkflowBuildById,deleteWorkflowById,GetWorkflowBuildById,getWorkflowRunById,listWorkflows,updateWorkflowBuildByIdwere 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:
createDatasetImportreturns datatype ofDataset(replaced 'ImportDataset')createDatasetImportByIdreturnsDatasetImportedby(replaced 'ImportDataset')DatasetImportedByhas a new propertyownerand propertynameis now optional
-
Provisioner v1beta1:
- Model
ECStackNamerenamed toEcStackName
- Model
-
Search v2beta1:
- Model
ListSearchResultsResponseFieldsrenamed toListPreiviewResultsResponseFields
- Model
-
Search v3alpha1:
- Model
ListSearchResultsResponseFieldsrenamed toListPreiviewResultsResponseFields
- Model
-
Stream v3beta1:
- Model
RulesSourcetypesResponserenamed toRulesPackageSourcetypes - Model
RulesActionsResponserenamed toRulesPackageActions
- Model
Non-Breaking Changes
Features
-
Auth
ServicePrincipalAuthManageradded to Auth service
-
Identity v2beta1:
- New model
AddInvisibleMemberBodyadded - New endpoints
addInvisibleMember,getMemberAdminandremoveMemberAdminadded - New properties
expiresAtandvisibleadded toMembermodel - New models
DeviceAuthInfoandUpdateRoleBodyadded
- New model
-
Identity v3alpha1:
- New version introduced
-
Ingest v1beta2:
- New models
UploadSuccessResponseandFileUploadDetailsadded
- New models
-
KVStore v1beta1:
- New endpoint
truncateRecordsadded
- New endpoint
-
Search v3alpha1:
- New models
SearchModule,StatementDispatchStatus, andSingleSatatementQueryParamtersadded - New endpoints
createMultiSearchMethodandcreateSearchStatementsadded
- New models
-
Streams v2beta1:
- New property
messagesadded to modelConnectionSaveResponse - New property
complexityadded to modelPipelineResponse - New property
activateLatestVersionadded to modelReactivatePipelineRequest
- New property
-
Streams v3beta1:
- New models
CollectJobPatchRequest,DataStream,DataStreamRequest,DataStreamResponse,EntitlementRequest,
EntitlementResponse,PaginatedResponseOfRuleKind,RulesKindandPluginResponse - New endpoints
createDataStream,deleteCollectJob,deletedatastream,deleteEntitlements,deleteRulesPackage,
describeDataStream,getEntitlements,getRulesPackageById,listDataStreams,listRuleKinds,releaseInfo,
setEntitlements,updateCollectJob,updateDataStreamandupdateRulesPackageByIdadded
- New models
Release v13.0.0
Bug Fixes
- whitelist to allowlist (dde9eb0)
Breaking Changes
- App Registry
WebAppPOSThas been removed
Non-Breaking Changes
- Catalog
extract_fieldshas been added
- Search
extract_fieldshas been added
- Streams
PaginatedResponseOfCollectJobResponsehas been addedRulesResponsehas been addedRulesSourcetypesResponsehas been addedRulesActionsResponsehas been addedPaginatedResponseOfRulesResponsehas been addedRulesRequesthas 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):
_keyin modelGeneratedRecordis renamed askey
Non-Breaking Changes
-
KVstore service (v1beta1):
deleteRecords()has added a new optional input parameter ofenableMvl;queryRecords()has added new optional input parameters ofenableMvlandshared -
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
HECResponseandInlineObjecthave been removed
- Model
-
KVStore Service (v1beta1):
- Model
Keyrenamed toRecordand has an additional required fielduser - Endpoints
insertRecordandputRecordhave returnType Promise (earlier it was Promise)
- Model
-
Search Service (v3alpha1):
- Models
RecurringSearchandUpdateRecurringSearchhave been removed - Endpoint
createDatasettakes in argumentDatasetPOSTinstead ofDataset - Endpoint
updateDatasetByIdtakes in argumentDatasetPATCHinstead ofDataset - Endpoint
deleteDatasetByIdhas a returnTypePromise<object>instead ofPromise<Dataset> - Endpoint
listSpl2Moduleshas a returnTypePromise<ListModules>instead ofPromise<Array<Module>> - Endpoints
createRecurringSearch,deleteRecurringSearch,getAllJobsForRecurringSearch,getJobForRecurringSearch,getRecurringSearch,listRecurringSearchesandupdateRecurringSearchhave been removed
- Models
Non-Breaking Changes
-
Identity Service (v3):
- Models
ResetPasswordBody,UpdateGroupBody,UpdatePasswordBody,UpdateRoleBodyhave been added - Endpoints
resetPassword,updatePassword,updateGroup,updateRolehave been added - Parameters
descriptionanddisplayNamehave been added to modelsCreateGroupBody,CreateRoleBody,Role, andGroup.
- Models
-
Search Service (v3alpha1):
- Models
DatasetPATCH,DatasetPOST,FederatedConnection,FederatedConnectionInputandListModuleshave been added - Endpoints
createFederatedConnection,deleteFederatedConnection,getFederatedConnectionByNameandputFederatedConnectionByNamehave been added
- Models
-
Streams Service (v3beta1):
- Models
PipelineReactivateResponseAsync,PipelineReactivationStatus,UpgradePipelineRequestandValidateConnectionRequesthave been added. - Parameter
skipValidationhas been added tocreateConnectionendpoint - Parameter
createUserIdhas been added tolistTemplatesendpoint - Endpoints
reactivationStatus,validateConnection, andupgradePipelinehave been added - Parameter
metadatahas been added toConnectorResponse - Parameter
labelshas been added toPipelinePatchRequest,PipelineRequestandPipelineResponsemodels - Parameter
uberJarSha256has been added toPipelineResponsemodel ACTIVATINGandDEACTIVATINGhave been added to modelPipelineResponsestatus enum- Model
Sourcehas changed with propertiesnodeandpipelineVersiondeleted and 18 new properties added - Parameter
learnMoreLocationhas 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:
useDefaultIdpoptional property was removed fromTenantmodel in v2beta1 and v3 -
Ingest service:
postCollectorRawandpostCollectorRawV1APIs were removed from v1beta2- In v1beta2/GeneratedHECResponse:
invalid_event_numberwas renamed asinvalidEventNumber - In v1beta2/GeneratedHECTokenAccessResponse:
ack_enabledwas renamed asackEnabled
,allow_query_string_authwas renamed asallowQueryStringAuth,created_atwas renamed ascreatedAt,
created_bywas renamed ascreatedBy,last_modified_atwas renamed aslastModifiedAt,last_modified_bywas renamed aslastModifiedBy - In v1beta2/GeneratedHECTokenUpdateRequest,
ack_enabledwas renamed asackEnabled,allow_query_string_authwas renamed asallowQueryStringAuth
-
Streams service:
createDataStream,deleteDataStream,describeDataStream,listDataStreams, andupdateDataStreamAPIs 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, andupdateIdentityProviderin v2beta1 and v3 -
New optional property
acceptTosforCreatePrincipalBodywas added in v2beta1 and v3
-
-
Streams service: Added new APIs of
uploadFileanduploadLookupFile
Release v16.0.0-beta1
Features
- Add support to tenant-scoped hostname: initiate the client with
hostnameset 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
AddInvisibleMemberBodyremoved - Enpoints
addInvisibleMember,getMemberAdminandremoveMemberAdminremoved
- Model
-
Provisioner v1beta1
- Models
CreateProvisionJobBody,ProvisionJobInfo,ProvisionJobInfoErrors,ProvisionJobInfoErrorsand
ProvisionJobsremoved - Endpoints
createProvisionJob,getProvisionJobandlistProvisionJobsremoved
- Models
-
Streams v3beta1:
-
Models
CollectJobPatchRequest,CollectJobRequest,CollectJobResponse,CollectJobStartStopResponse,
EntitlementRequest,EntitlementResponse,PaginatedResponseOfCollectJobResponse,PaginatedResponseOfPlugin,
PaginatedResponseOfRulesResponse,PaginatedResponseOfRuleKind,Plugin,PluginPatchRequest,PluginRequest,
PluginResponse,RulesRequestandRulesResponseremoved -
Model
UploadFilerenamed toUploadFileResponse -
Endpoints
createCollectJob,createRulesPackage,deleteCollectJobs,deleteCollectJob,deleteEntitlements,
deletePlugin,deleteRulesPackage,getCollectJob,getEntitlements,getPlugins,getRulesPackageById,
listCollectJobs,listRulesKinds,listRulesPackages,patchPlugin,registerPlugin,releaseInfo,
setEntitlements,startCollectJob,stopCollectJob,updateCollectJob,updatePluginandupdateRulesPackageById
removed
-
Non-Breaking Changes
Features
-
Identity v2beta1:
- New model
CreatePrincipalBodyadded - New endpoint
createPrincipaladded
- New model
-
Identity v3:
- New version introduced
-
Identity v3alpha1
- New models
GroupMemberListandGroupRoleListadded
- New models
-
Ingest v1beta2:
- New endpoints
postCollectorRawandpostCollectorRawV1added
- New endpoints
-
Streams v2beta1:
- New property
attributesadded toConnectorResponse - New property
statusDescriptionadded toPipelineReactivateResponse - New parameter
functionOpadded tolistConnections
- New property
-
Streams v3beta1
- New model
UploadFileResponseadded - New endpoint
deleteLookupFile,getLookupFileMetadataandgetLookupFilesMetadataadded
- New model
Release v11.0.1
BugFix
Adding CHANGELOG.md