Skip to main content

Document changelog

  • Changelog

@dynatrace-sdk/client-document

1.35.1 Released Sep 10, 2026​

Patch changes​

  • Fix URL encoding of path parameters in generated API methods. Path segment values are now properly percent-encoded, preventing issues when IDs contain special characters. (APPDEV-19699, APPDEV-19700)

1.35.0 Released Aug 27, 2026​

Minor changes​

  • Add makePrivate and makePublic endpoints
  • Allow admin hide ready-made documents via makePrivate and makePublic endpoints
  • Deprecate isPrivate parameter of updateDocument endpoint
  • add Cache-Control (private, no-cache) and ETag header to getDocumentContent response, exlusively for public image-type documents only
  • content and metadata properties for the FullDocument response returned by getDocument  are now marked as required, as they are always present.

1.34.0 Released Jul 24, 2026​

Minor changes​

  • /labels-endpoint: Change documentType query-param to documentTypes to allow filtering labels by multiple document-types
  • /labels-endpoint: Introduce onlyAppSupportedDocTypes query-param, to add a filter for all app-supported document-types when listing labels

1.33.0 Released Jul 13, 2026​

Minor changes​

  • Add favorite documents feature endpoints
  • Extend list-documents endpoint with favorite feature

1.32.0 Released Jun 24, 2026​

Minor changes​

  • Extend createDocument operation so that it supports creating public documents
  • Extend listLabels operation so that it
    • supports pagination
    • offers an optional document type filter
    • introduces a maximum length for the contains parameter

1.31.1 Released Jun 16, 2026​

PATCH​

  • Improve list-documents endpoint label filtering documentation
  • Improve various descriptions

1.31.0 Released Apr 16, 2026​

Minor changes​

  • Add labels support

Patch changes​

  • Add unexpected error definition to all endpoints
  • Add sendNotificationQueryParam to createDirectShares endpoint
  • Add x-summary and x-service-category

1.30.0 Released Dec 16, 2025​

Minor changes​

  • listDocuments endpoint supports IN operator in filter
  • allow to opt-out from E-Mail notifications on share operations

1.29.0 Released Oct 30, 2025​

Minor changes​

  • Introduce editor sharing. Users with write access to a specific document may re-share the document with other users.

1.28.0 Released Sep 25, 2025​

Minor changes​

  • Add optional isShared and isSharedWithCurrentUser properties to listDocuments endpoint response.

Patch changes​

  • add lastModifyingAppId property to modificationInfo and support partial result for modificationInfo.lastModifyingAppId in getDocument and getDocumentMetadata
  • add missing pagination parameters to GetDirectShareRecipientsParams

1.27.0 Released Sep 8, 2025​

Minor changes​

  • bulkDeleteDocument (/documents:delete) is now limited to 100 documents per request

1.26.1 Released Sep 5, 2025​

Patch changes​

  • Update dependencies. (APPDEV-13611)

1.26.0 Released Sep 4, 2025​

Minor changes​

  • Add admin access to all document endpoints

1.25.1 Released Aug 6, 2025​

Patch changes​

  • Fix incorrect max length documentation for documents filter

1.25.0 Released Jul 25, 2025​

Minor changes​

  • Introduce optional client-provided id. Deprecate external id.
  • Introduce admin access to trash endpoints.

1.24.5 Released Jun 25, 2025​

Patch changes​

  • Add missing response codes and entities to createDocument, updateDocument, updateDocumentContent and transferOwner.

1.24.4 Released Jun 11, 2025​

Patch changes​

  • Update dependencies. (APPDEV-11813)

1.24.3 Released May 16, 2025​

Patch changes​

  • Improve performance of date transformations. (APPDEV-12840)

1.24.2 Released May 9, 2025​

Patch changes​

  • Improve performance of payload transformations. (APPDEV-12840)

1.24.1 Released Apr 10, 2025​

Patch changes​

  • Fix for form-data JSON fields deserialization. (APPDEV-12880)

1.24.0 Released Apr 3, 2025​

Minor changes​

  • Added support for optional transformations. (APPDEV-11914)

Patch changes​

  • Added fix for 'transformToFormDataField' function. (APPDEV-12478)
  • Remove generatedAt property from metadata file. (APPDEV-12696)

1.23.0 Released Mar 10, 2025​

Minor changes​

  • createDocument - enforce documents per tenant limit, if limit is exceeded HTTP 507 Insufficient Storage is returned.

1.22.0 Released Mar 4, 2025​

Minor changes​

  • Use optimised transformations. (APPDEV-11447)

1.21.3 Released Jan 7, 2025​

Patch changes​

  • Add origin extension id to list-documents endpoint documentation

1.21.2 Released Dec 12, 2024​

Patch changes​

  • Replace model transformations with single transformation function. (APPDEV-10818)

1.21.1 Released Nov 29, 2024​

Platform tokens notice updated

1.21.0 Released Nov 20, 2024​

Minor changes​

  • Add origin extension id to document responses

1.20.0 Released Oct 8, 2024​

Minor changes​

  • Enums are replaced with unions of literals. APPDEV-10338
  • Inline enums as union of literals. APPDEV-9924

Patch changes​

  • Add return types and improve usage examples inside JSDoc. APPDEV-7536

1.19.2 Released Sep 10, 2024​

Patch changes​

  • Mark createdSnapshot as optional in RestoreDocumentResult

1.19.1 Released Sep 9, 2024​

Patch changes​

  • Change new transfer-owner endpoint so that the owner id gets transported in the body instead of in query param

1.19.0 Released Sep 5, 2024​

###Minor changes

  • restoresSnapshot - change behavior so that new snapshot gets created before instead of after the restoration

1.18.1 Released Sep 5, 2024​

Patch changes​

  • Add missing add-fields param to getDocument and getDocumentMetadata

1.18.0 Released Sep 4, 2024​

Minor changes​

  • Enhance list-documents endpoint so that it supports add-fields and sort for the user's lastAccessedTime
  • Enhance get-document and get-document-metadata endpoints so that they support add-fields for the user's lastAccessedTime

1.17.0 Released Sep 4, 2024​

Minor changes​

  • Add transfer-owner endpoint
  • Add explanation for admin-access
  • Add add-fields to list-document endpoint
  • Remove description from list-documents response schema, can be added via add-fields now

1.16.0 Released Aug 28, 2024​

Features​

  • Export errors from the package.

1.15.0 Released Aug 21, 2024​

Minor changes​

  • Add admin access for endpoints: list-document, get-document, get-document-metadata, get-document-content, delete-document

1.14.0 Released Aug 8, 2024​

Minor changes​

  • Add bulk deletion endpoint for documents.
  • Remove no longer required id-type query param from get-metadata endpoint.
  • Update snapshot endpoints documentation (accessing snapshots now requires write-access on the document).

1.13.0 Released Jul 31, 2024​

Minor changes​

  • Introduced @dynatrace-sdk/shared-errors package and improved response errors handling.

1.12.0 Released Jul 16, 2024​

Minor changes​

  • Prevent that a uuid is used as external id

1.11.0 Released Jul 12, 2024​

Minor changes​

  • Extend list-documents operation with filtering and sorting capability for property originAppId

1.10.1 Released Jun 10, 2024​

Patch changes​

  • Updated boolean serialization handling. APPDEV-9047

1.10.0 Released Jun 5, 2024​

Minor changes​

  • Add public documents feature (allows to share a document with all users in the environment)
  • Add external id feature (allows to define an optional, unique id for a document)
  • Add optional description to documents (allows users to describe a document)
  • Add origin app id to documents (readonly property which indicates whether a document is app-shipped)

1.9.2 Released May 17, 2024​

Patch changes​

  • Fix broken links in the readme file.

1.9.1 Released May 7, 2024​

Patch changes​

  • Use updated http client with fix for Safari multipart/form-data parsing. APPDEV-8496

1.9.0 Released May 6, 2024​

  • Add getSnapshotMetadata endpoint

1.8.1 Released Apr 19, 2024​

Patch changes​

  • Do not print empty fields in the default message of an error. APPDEV-7630
  • Update documentation. APPDEV-8154
  • Updated dependencies

1.8.0 Released Apr 5, 2024​

Minor changes​

  • Add versioning feature

1.7.1 Released Mar 29, 2024​

Patch changes​

  • Update http-client
  • Sanitize links in the documentation
  • Add API reference to the readme file

1.7.0 Released Feb 28, 2024​

Minor changes​

  • Update client-document - improve docs

1.6.1 Released Jan 12, 2024​

Patch changes​

  • Update documentation.

1.6.0 Released Nov 14, 2023​

Minor changes​

  • Release document locking endpoints

1.5.4 Released Nov 10, 2023​

Patch changes​

  • Fixed a bug that caused abort errors from http-client to be wrapped in ApiClientError('UnexpectedError').

1.5.3 Released Nov 8, 2023​

Patch changes​

  • Update dependencies.

1.5.2 Released Nov 2, 2023​

Patch changes​

  • Fixed a bug that caused internal http-client errors to be thrown for error responses.

1.5.1 Released Oct 3, 2023​

Patch changes​

  • Update JSDoc examples.

1.5.0 Released Aug 11, 2023​

Minor changes​

  • Add trash functionality

1.4.1 Released Aug 7, 2023​

Patch changes​

  • Fix transformation of null values for nullable properties

1.4.0 Released Jul 28, 2023​

Minor changes​

  • Add offset-based pagination to all list endpoints

Patch changes​

  • Update documentation

  • Fix transformation of null and Date values

  • Update package description

  • Updated dependencies

    • @dynatrace-sdk/http-client@1.0.6

1.3.2 Released Jul 13, 2023​

Patch changes​

  • Update error messages

  • Updated dependencies

    • @dynatrace-sdk/http-client@1.0.5

1.3.1 Released Jun 27, 2023​

Patch changes​

  • Update documentation

1.3.0 Released Jun 15, 2023​

Minor changes​

  • Add update document (metadata + content)

1.2.2 Released Jun 7, 2023​

Patch changes​

  • Update docs.

1.2.1 Released Jun 6, 2023​

Patch changes​

  • Add JSDoc @example for operations.
  • Fix handling of the application/cloudevent+json content type.

1.2.0 Released Apr 24, 2023​

Minor changes​

  • Update doc-service sdk

1.1.0 Released Apr 19, 2023​

Minor changes​

  • Export model transformations

1.0.6 Released Apr 19, 2023​

Patch changes​

  • Move model transformations to a separate module
  • Update @dynatrace-sdk/http-client to ^1.0.3

1.0.5 Released Apr 5, 2023​

Patch changes​

  • Update @dynatrace-sdk/http-client to ^1.0.1
  • Use parsed response body in error serializer

1.0.4 Released Apr 3, 2023​

Patch changes​

  • Send response body in error serializer
  • Updated dependencies
    • @dynatrace-sdk/http-client@1.0.0

1.0.3 Released Mar 23, 2023​

Patch changes​

  • Generate client package with template-typescript-client v0.13.10. Query question mark is now removed from url when there are no search params.

1.0.2 Released Mar 16, 2023​

Patch changes​

  • Generate client package with template-typescript-client v0.13.9. Config param is now optional for valid operations. Improve error handling of unsupported data types.
  • Process HTML tags in the documentation.

1.0.1 Released Mar 13, 2023​

Patch changes​

  • Fix create-direct-share endpoint response code

1.0.0 Released Mar 9, 2023​

Major changes​

  • Initial release of @dynatrace-sdk/client-document.
Still have questions?
Find answers in the Dynatrace Community