Version - Support policy

This document describes the PDF Services SDK's and Public API's versioning and support policies.

SDK

Versioning scheme

The SDK has a version format of #.#.# (e.g. 1.1.0) where the numbers correspond to a major release, minor release, and patch/update (Major.Minor.Patch). Releases are defined as follows:

• Major Releases (1.x.x): Major releases introduce backward-incompatible changes to the APIs and interfaces and start the EOL clock for all previous releases. Developers should plan on migrating their code prior to the end of life of the previous major release.
• Minor Releases (x.1.x): Minor releases typically appear quarterly. Changes are backward compatible to the last major release. Minor releases introduce new interfaces. Existing interfaces continue to function but some interfaces may be deprecated; deprecated interfaces will be removed in a next major release.
• Patch Releases (x.x.1): Patch releases only deliver critical security or bug fixes as needed. Patch release changes are rolled into the next minor release so that developers can update and deploy new code based on their business requirements.

Public API

Versioning

As mentioned on Public API Docs, each operation has a unique assetId which is passed in Form Parameters. Generally, APIs will be enhanced while keeping them backward compatible. If its functionality can't be enhanced without breaking changes, then its new version will be released with its own unique assetId. The supported older API versions info will be present on Public API Docs

Additionally, the output for the PDF Extract API is generated by a machine learning pipeline that is frequently trained to improve inference of document layout and structure.As a result, while changes to the output structure are not expected between versions, specific results may vary as the model output improves.

Supported versions

This document as well as the URLs on Adobe's website and other documentation link to the latest product version.

Note: Links to repository assets (e.g. GIT, Maven, etc.) direct to the top level directory. To download assets that match the documentation, navigate to the correct version. For example, When using the 1.0.0 Java documentation, you can find the 1.0.0 samples in the GIT repo as follows:

1. Go to the GIT repo.
2. Select Releases.
3. Select and download the needed release.

Migration Guide to PDF Services SDK

Refer to the following table for migrating to PDF Services SDK version 3.4.0, you can also refer our Samples( Java, Node JS, .NET). for the latest release.

Java changes

• artifactId changed from pdftools-sdk to pdfservices-sdk
• Replace the <properties> tag and SDK <dependency> tag in your project’s pom.xml file with the following:

<properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <maven.compiler.source>1.8</maven.compiler.source>
    <maven.compiler.target>1.8</maven.compiler.target>
    <pdfservices.sdk.version>3.4.0</pdfservices.sdk.version>
    <pdfservices.sdk.samples.version>3.4.0</pdfservices.sdk.samples.version>
</properties>

<dependency>
    <groupId>com.adobe.documentservices</groupId>
    <artifactId>pdfservices-sdk</artifactId>
    <version>${pdfservices.sdk.version}</version>
</dependency>
CopyCopied to your clipboard
1<properties>
2    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
3    <maven.compiler.source>1.8</maven.compiler.source>
4    <maven.compiler.target>1.8</maven.compiler.target>
5    <pdfservices.sdk.version>3.4.0</pdfservices.sdk.version>
6    <pdfservices.sdk.samples.version>3.4.0</pdfservices.sdk.samples.version>
7</properties>
8
9<dependency>
10    <groupId>com.adobe.documentservices</groupId>
11    <artifactId>pdfservices-sdk</artifactId>
12    <version>${pdfservices.sdk.version}</version>
13</dependency>

• Update import statements as per new Package structure. For e.g.

import com.adobe.pdfservices.operation.ExecutionContext; 
CopyCopied to your clipboard
import com.adobe.pdfservices.operation.ExecutionContext; 

Node JS changes

• NPM package name changed from @adobe/documentservices-pdftools-node-sdk to @adobe/pdfservices-node-sdk
• Update the latest SDK dependency in package.json file of your project

"@adobe/pdfservices-node-sdk": "3.4.0"
CopyCopied to your clipboard
"@adobe/pdfservices-node-sdk": "3.4.0"

• Require the @adobe/pdfservices-node-sdk in the Sample file to access the SDK interface

const PDFServicesSdk = require('@adobe/pdfservices-node-sdk'); 
CopyCopied to your clipboard
const PDFServicesSdk = require('@adobe/pdfservices-node-sdk'); 

For HTML to PDF Conversions, the PageLayout object is moved inside html object. To access the PageLayout interface use the following code:

const pageLayout = new PDFServicesSdk.CreatePDF.options.html.PageLayout(); 
CopyCopied to your clipboard
const pageLayout = new PDFServicesSdk.CreatePDF.options.html.PageLayout(); 

.NET changes

• Nuget package name changed from Adobe.DocumentServices.PDFTools to Adobe.PDFServicesSDK
• Update the SDK dependency in your project’s .csproj file with the following:

<ItemGroup>
    <PackageReference Include="log4net" Version="2.0.12" />
    <PackageReference Include="Adobe.PDFServicesSDK" Version="3.4.0" />
</ItemGroup> 
CopyCopied to your clipboard
1<ItemGroup>
2    <PackageReference Include="log4net" Version="2.0.12" />
3    <PackageReference Include="Adobe.PDFServicesSDK" Version="3.4.0" />
4</ItemGroup> 

• Update the namespaces accordingly in your .cs file as per the new dependency:

using Adobe.PDFServicesSDK;
CopyCopied to your clipboard
using Adobe.PDFServicesSDK;

Documentation library

Refer to the following for links to supported product documentation.

Change types

Change types include the following:

• New: Features or implementation changes added in the current release.
• Changed: Modified code that changes a feature or implementation detail.
• Security: A patch or bug fixed released in an out-of-band patch.
• Deprecated: Existing functionality for which support is ending (or ended).

Change history

3.4.0 (June, 2023; minor release)

Python SDK 2.3.0 (June, 2023; minor release)

Adobe Document Generation Server Side Release (June, 2023; server side release)

3.3.0 (May, 2023; minor release)

Python SDK 2.2.0 (May, 2023; minor release)

Adobe Document Generation Server Side Release (April, 2023; server side release)

Extract PDF Server Side Release (06 March, 2023; server side release)

Adobe Document Generation Server Side Release (March, 2023; server side release)

2.3.0 (February, 2023, minor release)

Adobe Document Generation Server Side Release (January, 2023; server side release)

Python SDK 2.1.2 (January, 2023, minor release)

3.2.0 (January, 2023; minor release)

Python SDK 2.0.0 (December, 2022, major release)

3.0.0 (September, 2022; major release)

2.2.3 (July, 2022; patch release)

PDF Accessibility Auto-Tag Release - Available under Early Access Program (21 June, 2022)

Extract PDF Server Side Release (21 June, 2022; server side release)

Extract PDF Server Side Release (16 May, 2022; server side release)

2.2.2 (May, 2022; patch release)

Create PDF Server Side Release (6 April, 2022; server side release)

Extract PDF Server Side Release (05 April, 2022; server side release)

2.2.1 (March, 2022; patch release)

Extract PDF Server Side Release (22 February, 2022; server side release)

2.2.1 (February, 2022; patch release)

2.2.1 (January, 2022; patch release)

2.2.0 (January, 2022; minor release)

Adobe Document Generation Server Side Release (10 January, 2022; server side release)

Adobe Document Generation Server Side Release (14 December, 2021; server side release)

Extract PDF Server Side Release (15 November, 2021; server side release)

Adobe Document Generation Server Side Release (20 October, 2021; server side release)

Extract PDF Server Side Release (29 September, 2021; server side release)

2.1.0 (September, 2021; minor release)

Extract PDF Server Side Release (26 Aug, 2021; server side release)

2.0.0 (May, 2021; major release)

1.3.0 (March, 2021; minor release)

1.2.0 (September, 2020; minor release)

1.1.0 (June, 2020; minor release)

1.0.0 (March, 2020; First major release)

Last updated 6/21/2023

Was this helpful?

Yes

No