Skip to content

Releases: splunk/splunk-cloud-sdk-js

Release v16.0.0-beta6

14 Feb 18:32
Compare
Choose a tag to compare

Breaking Changes

  • Catalog service:

    • v2beta1:
      • Apis whose name ends with ById have changed by removing ById in the name , and apis whose name ends with ByResourceName have changed by removing ByResourceName in the name
      • Apis of createWorkflow, createWorkflowBuild, createWorkflowRun, deleteWorkflowBuildById, deleteWorkflowById, GetWorkflowBuildById, getWorkflowRunById, listWorkflows, updateWorkflowBuildById were removed
  • Search service:

    • v2:
      • Apis of refreshFederatedConnection() and testFederatedConnection() removed the input parameter of body
    • v3alpha1:
      • Apis of refreshFederatedConnection() and testFederatedConnection() removed the input parameter of body

Non-Breaking Changes

  • identity service:
    • v3:
      • Added new apis of getEntitlements, updateEntitlements
  • search service:
    • v2:
      • Added new apis of createDataset,deleteDatasetById, getDatasetById, listDatasets, getAllFederatedConnections
    • v3alpha1:
      • Added new api of getAllFederatedConnections

Release v14.0.0

14 Feb 18:32
Compare
Choose a tag to compare

Services

Breaking Changes

Features
  • Catalog v2beta1:

    • createDatasetImport returns datatype of Dataset (replaced 'ImportDataset')
    • createDatasetImportById returns DatasetImportedby (replaced 'ImportDataset')
    • DatasetImportedBy has a new property owner and property name is now optional
  • Provisioner v1beta1:

    • Model ECStackName renamed to EcStackName
  • Search v2beta1:

    • Model ListSearchResultsResponseFields renamed to ListPreiviewResultsResponseFields
  • Search v3alpha1:

    • Model ListSearchResultsResponseFields renamed to ListPreiviewResultsResponseFields
  • Stream v3beta1:

    • Model RulesSourcetypesResponse renamed to RulesPackageSourcetypes
    • Model RulesActionsResponse renamed to RulesPackageActions

Non-Breaking Changes

Features
  • Auth

    • ServicePrincipalAuthManager added to Auth service
  • Identity v2beta1:

    • New model AddInvisibleMemberBody added
    • New endpoints addInvisibleMember, getMemberAdmin and removeMemberAdmin added
    • New properties expiresAt and visible added to Member model
    • New models DeviceAuthInfo and UpdateRoleBody added
  • Identity v3alpha1:

    • New version introduced
  • Ingest v1beta2:

    • New models UploadSuccessResponse and FileUploadDetails added
  • KVStore v1beta1:

    • New endpoint truncateRecords added
  • Search v3alpha1:

    • New models SearchModule, StatementDispatchStatus, and SingleSatatementQueryParamters added
    • New endpoints createMultiSearchMethod and createSearchStatements added
  • Streams v2beta1:

    • New property messages added to model ConnectionSaveResponse
    • New property complexity added to model PipelineResponse
    • New property activateLatestVersion added to model ReactivatePipelineRequest
  • Streams v3beta1:

    • New models CollectJobPatchRequest, DataStream, DataStreamRequest, DataStreamResponse, EntitlementRequest,
      EntitlementResponse, PaginatedResponseOfRuleKind, RulesKind and PluginResponse
    • New endpoints createDataStream, deleteCollectJob, deletedatastream, deleteEntitlements, deleteRulesPackage,
      describeDataStream, getEntitlements, getRulesPackageById, listDataStreams, listRuleKinds, releaseInfo,
      setEntitlements, updateCollectJob, updateDataStream and updateRulesPackageById added

Release v13.0.0

14 Feb 18:33
Compare
Choose a tag to compare

Bug Fixes

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 added
    • RulesResponse has been added
    • RulesSourcetypesResponse has been added
    • RulesActionsResponse has been added
    • PaginatedResponseOfRulesResponse has been added
    • RulesRequest has been added

Release v12.0.0

14 Feb 18:33
Compare
Choose a tag to compare

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

09 Aug 19:33
Compare
Choose a tag to compare

Breaking Changes

  • KVstore service (v1beta1): _key in model GeneratedRecord is renamed as key

Non-Breaking Changes

  • KVstore service (v1beta1): deleteRecords() has added a new optional input parameter of enableMvl; queryRecords() has added new optional input parameters of enableMvl and shared

  • Search service (v3alpha1): new api of listDatasets() is added

  • Streams service (v3beta1): listPipelines() has added a new optional input parameter of includeStatus; new api of deleteSource() is added

Release v16.0.0-beta3

29 Jun 17:17
Compare
Choose a tag to compare

Features

Breaking Changes

  • Ingest Service (v1beta2):

    • Model HECResponse and InlineObject have been removed
  • KVStore Service (v1beta1):

    • Model Key renamed to Record and has an additional required field user
    • Endpoints insertRecord and putRecord have returnType Promise (earlier it was Promise)
  • Search Service (v3alpha1):

    • Models RecurringSearch and UpdateRecurringSearch have been removed
    • Endpoint createDataset takes in argument DatasetPOST instead of Dataset
    • Endpoint updateDatasetById takes in argument DatasetPATCH instead of Dataset
    • Endpoint deleteDatasetById has a returnType Promise<object> instead of Promise<Dataset>
    • Endpoint listSpl2Modules has a returnType Promise<ListModules> instead of Promise<Array<Module>>
    • Endpoints createRecurringSearch, deleteRecurringSearch, getAllJobsForRecurringSearch, getJobForRecurringSearch, getRecurringSearch, listRecurringSearches and updateRecurringSearch have been removed

Non-Breaking Changes

  • Identity Service (v3):

    • Models ResetPasswordBody, UpdateGroupBody, UpdatePasswordBody, UpdateRoleBody have been added
    • Endpoints resetPassword, updatePassword, updateGroup, updateRole have been added
    • Parameters description and displayName have been added to models CreateGroupBody, CreateRoleBody, Role, and Group.
  • Search Service (v3alpha1):

    • Models DatasetPATCH, DatasetPOST, FederatedConnection, FederatedConnectionInput and ListModules have been added
    • Endpoints createFederatedConnection, deleteFederatedConnection, getFederatedConnectionByName and putFederatedConnectionByName have been added
  • Streams Service (v3beta1):

    • Models PipelineReactivateResponseAsync, PipelineReactivationStatus, UpgradePipelineRequest and ValidateConnectionRequest have been added.
    • Parameter skipValidation has been added to createConnection endpoint
    • Parameter createUserId has been added to listTemplates endpoint
    • Endpoints reactivationStatus, validateConnection, and upgradePipeline have been added
    • Parameter metadata has been added to ConnectorResponse
    • Parameter labels has been added to PipelinePatchRequest, PipelineRequest and PipelineResponse models
    • Parameter uberJarSha256 has been added to PipelineResponse model
    • ACTIVATING and DEACTIVATING have been added to model PipelineResponse status enum
    • Model Source has changed with properties node and pipelineVersion deleted and 18 new properties added
    • Parameter learnMoreLocation has been added to model TemplateResponse
  • Added support for file upload endpoints with a content-type multipart/form-data

Release v16.0.0-beta2

27 Apr 17:24
Compare
Choose a tag to compare

Breaking Changes

  • Identity service: useDefaultIdp optional property was removed from Tenant model in v2beta1 and v3

  • Ingest service:

    • postCollectorRaw and postCollectorRawV1 APIs were removed from v1beta2
    • In v1beta2/GeneratedHECResponse: invalid_event_number was renamed as invalidEventNumber
    • In v1beta2/GeneratedHECTokenAccessResponse: ack_enabled was renamed as ackEnabled
      , allow_query_string_auth was renamed as allowQueryStringAuth, created_at was renamed as createdAt,
      created_by was renamed as createdBy, last_modified_at was renamed as lastModifiedAt, last_modified_by was renamed as lastModifiedBy
    • In v1beta2/GeneratedHECTokenUpdateRequest, ack_enabled was renamed as ackEnabled, allow_query_string_auth was renamed as allowQueryStringAuth
  • Streams service: createDataStream, deleteDataStream, describeDataStream, listDataStreams, and updateDataStream 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, and updateIdentityProvider in v2beta1 and v3

    • New optional property acceptTos for CreatePrincipalBody was added in v2beta1 and v3

  • Streams service: Added new APIs of uploadFile and uploadLookupFile

Release v16.0.0-beta1

31 Mar 19:56
Compare
Choose a tag to compare
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

16 Dec 23:41
Compare
Choose a tag to compare

Services

Breaking Changes

Features
  • Identity v2beta1:

    • Model AddInvisibleMemberBody removed
    • Enpoints addInvisibleMember, getMemberAdmin and removeMemberAdmin removed
  • Provisioner v1beta1

    • Models CreateProvisionJobBody, ProvisionJobInfo, ProvisionJobInfoErrors, ProvisionJobInfoErrors and
      ProvisionJobs removed
    • Endpoints createProvisionJob, getProvisionJob and listProvisionJobs removed
  • Streams v3beta1:

    • Models CollectJobPatchRequest, CollectJobRequest, CollectJobResponse, CollectJobStartStopResponse,
      EntitlementRequest, EntitlementResponse, PaginatedResponseOfCollectJobResponse, PaginatedResponseOfPlugin,
      PaginatedResponseOfRulesResponse, PaginatedResponseOfRuleKind, Plugin, PluginPatchRequest, PluginRequest,
      PluginResponse, RulesRequest and RulesResponse removed

    • Model UploadFile renamed to UploadFileResponse

    • Endpoints createCollectJob, createRulesPackage, deleteCollectJobs, deleteCollectJob, deleteEntitlements,
      deletePlugin, deleteRulesPackage, getCollectJob, getEntitlements, getPlugins, getRulesPackageById,
      listCollectJobs, listRulesKinds, listRulesPackages, patchPlugin, registerPlugin, releaseInfo,
      setEntitlements, startCollectJob, stopCollectJob, updateCollectJob, updatePlugin and updateRulesPackageById
      removed

Non-Breaking Changes

Features
  • Identity v2beta1:

    • New model CreatePrincipalBody added
    • New endpoint createPrincipal added
  • Identity v3:

    • New version introduced
  • Identity v3alpha1

    • New models GroupMemberList and GroupRoleListadded
  • Ingest v1beta2:

    • New endpoints postCollectorRaw and postCollectorRawV1 added
  • Streams v2beta1:

    • New property attributes added to ConnectorResponse
    • New property statusDescription added to PipelineReactivateResponse
    • New parameter functionOpadded to listConnections
  • Streams v3beta1

    • New model UploadFileResponse added
    • New endpoint deleteLookupFile, getLookupFileMetadata and getLookupFilesMetadata added

Release v11.0.1

25 Jun 01:24
Compare
Choose a tag to compare

BugFix

Adding CHANGELOG.md