Release v6.0.0

Version 6.0.0

Services

Breaking Changes

Features

• Streams
  • A new version of spec: v3beta1 has been added. Changes in the new version:
    • CompileDSL is not longer supported, substituted by Compile which leverages SPL instead of DSL to produce streams JSON object
    • CRUD on Group endpoints have been removed and all models corresponding to Groups have been removed
    • ExpandGroup which creates and returns the expanded version of a group has been removed
    • UplPipeline model replaced by Pipeline model
    • UplNode model replaced by PipelineNode model
    • UplEdge model replaced by PipelineEdge model
    • UplRegistry model replaced by RegistryModel model
    • UplFunction model replaced by FunctionalModel model
    • UplArgument model replaced by ArgumentModel model
    • UplCategory model has been removed
    • MergePipelines support has been removed
    • PipelinesMergeRequest model has been removed
    • PipelineDeleteResponse model has been removed
    • DslCompilationRequest model has been removed
    • ObjectNodemodel has been removed
  • The default version changed from v2beta1.2 to v3beta1.1

Non-Breaking Changes

Features

• Search
  • In v2beta1 spec version:
    • Support for new endpoint: DeleteSearchJob has been added
    • New DeleteSearchJob creates a search job that deletes events from an index.
• Streams
  • In v2beta1 spec version:
    • Models GroupFunctionArguments, GroupFunctionMappings, PipelineMigrationInfo, PipelineUpgradeResponse have been added.
  • In v3beta1 spec version:
    • Models FilesMetaDataResponse, LookupTableResponse, ErrorResponse, RuleMetrics have been added.
    • New GetLookupTable endpoint returns lookup table results
    • New Decompile endpoint decompiles UPL and returns SPL
    • New DeleteFile endpoint deletes a file give a file-id
    • New GetFilesMetaData endpoint returns files metadata

Release v5.0.0

Version 5.0.0

Library

Breaking Changes

• Class collisions are now properly disambiguated.
  • AppRegistry
    • WebApp -> [WebAppFromAppResponseCreateUpdate, WebAppFromAppResponseGetList]
      • ServiceApp -> [ServiceAppFromAppResponseCreateUpdate, ServiceAppFromAppResponseGetList]
      • NativeApp -> [NativeAppFromAppResponseCreateUpdate, NativeAppFromAppResponseGetList]
  • Catalog
    • AliasAction -> [AliasActionFromAction, AliasActionFromActionPOST]
    • AutoKVAction -> [AutoKVActionFromAction, AutoKVActionFromActionPOST]
    • EvalAction -> [EvalActionFromAction, EvalActionFromActionPOST]
    • LookupAction -> [LookupActionFromAction, LookupActionFromActionPOST]
    • RegexAction -> [RegexActionFromAction, RegexActionFromActionPOST]
  • Previously, code generation failed to correctly generate discriminator-based subclasses. This caused returned objects to have missing properties associated with those subclasses.
    • Bugs associated with this issue related to Dict conversion have been fixed.

Services

Breaking Changes

• Provisioner
  • Removed endpoints: CreateEntitlementsJob and GetEntitlementsJob

Features

• Ingest
  • Support for new operations: deleteAllCollectorTokens, listCollectorTokens, postCollectorTokens, deleteCollectorToken, getCollectorToken, putCollectorToken
• Search
  • Support for new operation: deleteJob

Release v4.0.0

BREAKING CHANGES

• AppRegistry
  • Models AppResponseCreateUpdate, AppResponseGetList, CreateAppRequest, UpdateAppRequest have been refactored from single models encompassing all app-related properties to discriminator-based app-kind-specific models: NativeApp/NativeAppPOST, ServiceApp/ServiceAppPOST, and WebApp/WebAppPOST.
• Catalog
  • JobDatasetPATCH and JobDatasetPOST have been removed.
• Forwarders
  • Certificates model now requires pem property.

FEATURES

• Collect
  • Support for new endpoints: CreateExecution, GetExecution, PatchExecution for scheduled jobs
• Identity
  • New Enum value for TenantStatus: tombstones
  • ListGroups now allows passing a query to filter by access permission
  • ListMemberPermissions returns new max-age header describing how long member permission can be cached
  • New RevokePrincipalAuthTokens revokes all tokens for a principal
• Provisioner
  • Support for new endpoints: CreateEntitlementsJob and GetEntitlementsJob

Release v3.3.0

Version 3.3.0

Features

• search: Added filter parameter to search list_jobs endpoint

Release v3.2.0

Features

• ml: added INITIALIZING value to StatusEnum model (a3ef356)

Release v3.1.0

Non-breaking Changes

• Update PKCE auth flow to read the CSRF token from the response cookie returned from the /csrfToken endpoint to mitigate security bug SCP-16944

Release v3.0.0

Breaking Changes

• streams: Remove ALREADYACTIVATEDWITHCURRENTVERSION from Pipeline_reactivation_statusEnum (c36f5c9)
• streams: Remove optional create_user_id field on PipelineRequest (c36f5c9)

Non-breaking Changes

• search: Expose optional required_freshness field on SearchJob class (c36f5c9)
• streams: Expose NOTACTIVATED on Pipeline_reactivation_statusEnum (c36f5c9)