CHANGELOG.md

Change Log

All notable changes to this project will be documented in this file. See standard-version for commit guidelines.

16.0.0-beta6 (2022-02-11)

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 sevice:
  • v2:
    • Added new apis of createDataset,deleteDatasetById, getDatasetById, listDatasets, getAllFederatedConnections
  • v3alpha1:
    • Added new api of getAllFederatedConnections

16.0.0-beta5 (2021-11-01)

Breaking Changes

• Identity IdentityProviderConfigBody model removed field: kind
• Kvstore reverted regression in Record model to use _key and _user properties (with underscores intact)

Non-Breaking Changes

• Identity new APIs: createSamlClient, deleteSamlClient, getSamlClient, listSamlClients, updateSamlClient
• Search new APIs: createFederatedConnection, deleteFederatedConnection, getFederatedConnectionByName, putFederatedConnectionByName, refreshFederatedConnection, testFederatedConnection

16.0.0-beta4 (2021-08-05)

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

16.0.0-beta3 (2021-06-22)

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

16.0.0-beta2 (2021-04-26)

Features

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

16.0.0-beta1 (2021-03-31)

Services

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') });

15.0.0 (2020-12-16)

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

14.0.0 (2020-11-11)

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

13.0.0 (2020-09-15)

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

12.0.0 (2020-08-25)

Bug Fixes

• fix requestStatusCallback to be not be async (e87ba5d)

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

11.0.1 (2020-06-25)

BugFix

Adding CHANGELOG.md

11.0.0 (2020-06-25)

Breaking Changes

• Streams
  • In v3beta
    • Modified connectorId parameter to be Array in ListConnections endpoint
    • Removed UploadFile endpoint as it is not supported

Non-Breaking Changes

• Catalog
  • In v2beta1
    • AppClientIDProperties model has been added
• Identity
  • In v2beta
    • Added scopeFilter parameter to listMemberPermission endpoint
• Streams
  • In v3beta
    • New getFileMetadata endpoint

10.0.0 (2020-05-01)

Bug Fixes

• add missed version update for 9.0.0 (25ec81b)

Features

• update with code-generated api bindings and models performed 2020-04-29 (64ea130)
• update with code-generated api bindings and models performed 2020-05-01 (0b44831)

8.0.0 (2020-03-11)

Features

• make 500 errors more visible (ee4fb63)
• update codecov to 3.6.5+ (8e26560)
• update with code-generated api bindings and models performed 2020-03-04 (a40726d)

7.0.0 (2020-02-20)

BREAKING CHANGES

• Appregistry models AppResponseCreateUpdate, UpdateAppRequest, CreateAppRequest, AppResponseCreateUpdat,AppResponseGetList have been refactored from single model encompassing all app related properties to discriminator based app kind specific models - NativeApp/NativeAppPost/NativeAppPut, Webapp/WebAppPost/WebAppPut,ServiceApp/ServiceAppPost/ServiceAppPut models

FEATURES

• Collect service has support for new endpoints - CreateExecution, GetExecution, PatchExecution for scheduled jobs
• Identity service has New Enum value for TenantStatus - tombstones

6.1.0 (2020-01-31)

Features

• Added filter parameter to search listJobs endpoint (60fd2ef)

6.0.0 (2020-01-16)

BREAKING CHANGES

• catalog: AnnotationPOST generated model and related createAnnotation* APIs now accurately capturing properties and additionalProperties. Request bodies have been changed from simple maps to AnnotationPOST model (4790776)

5.0.0 (2019-12-20)

Features

• ml: added initializing values to WorkflowDeploymentStatusEnum model (91e68ba4)

BREAKING CHANGES

• revert repathing of transpiled JS under src directory introduced in v4.0.0 - users upgrading from v3.x.x or earlier to v5.0.0 should be unaffected (afafe4a)

4.0.0 (2019-12-06)

Features

• search: Expose optional requiredFreshness field on SearchJob interface (d92c7af)
• streams: Expose NotActivated on PipelineReactivateResponsePipelineReactivationStatusEnum (d92c7af)

BREAKING CHANGES

• streams: Remove AlreadyActivatedWithCurrentVersion from PipelineReactivateResponsePipelineReactivationStatusEnum (d92c7af)
• streams: Remove optional createUserId field on GeneratedPipelineRequest (d92c7af)

3.0.0 (2019-11-19)

BREAKING CHANGES

• auth: remove checkAuthentication from AuthManager interface (f406862)
• auth: serviceClientArgs.tokenSource no long accepts synchronous functions to return the token (ab78288)

2.0.0 (2019-10-16)

Features

• collect: BREAKING CHANGE: scalePolicy is now defined as a ScalePolicy model rather than a simple object. (2d58bac)
• streams: 'Expression' value exposed as part of the SplCompileRequestSyntax enumeration. (2d58bac)
• identity: ValidateInfoKindEnum exposed as a field in ValidateInfo interface. (2d58bac)
• all: arbitrary query parameters exposed as an optional parameter in all public APIs. (2d58bac)
• examples: updating samples with common formatting around logging, await vs promise chaining, adding teardowns for cleanup. (75370a7)

1.1.0 (2019-10-01)

Features

• search: regenerate search for resultsPreviewAvailable (1a8dd6a)

1.0.1 (2019-09-25)

1.0.0 (2019-09-25)

Bug Fixes

• core: always return the httpStatusCode for error responses even if missing fields (6372c23)

Features

• add support for multiple service versions (d9c726d)
• temporary import stubs to keep from breaking clients (70230b0)
• update service bindings (e7505e7)
• examples: add new example for tenant setup (8e6eedd)

1.0.0-beta.4 (2019-09-12)

Bug Fixes

• ingest: limit ingest batches to 500 events (41a410e)

Features

• client can on 429 and 503 (needs configuration in this release) (e7b9532)
• service bindings update, includes search preview results (f8e2cd2)

1.0.0-beta.3 (2019-09-05)

Bug Fixes

• core: clone request before using in naiveExponentialBackoff (74bf170)
• search: fix unhandled promise in waitForJob (2485c1b)

Features

• update bindings to latest service versions (58e1460)

1.0.0-beta.2 (2019-07-22)

Features

• re-generate all services with the latest spec files (c8fed3b)

1.0.0-beta.1 (2019-07-19)

Bug Fixes

• properly encode strings in URLs, not just escape them (5823b4c)
• splunkError objs will now have more readable messages (03f6733)

Change Log

All notable changes to this project will be documented in this file. See standard-version for commit guidelines.