From ec0afdc522597da22d659c6167f3df9248f7d8d7 Mon Sep 17 00:00:00 2001 From: Rajat Gaur Date: Wed, 10 Jul 2024 16:36:43 +0530 Subject: [PATCH 1/8] added howtos and release notes for accessibility checker GA --- .../howtos/pdf-accessibility-checker-api.md | 52 +++++++++++++++++++ src/pages/overview/releasenotes.md | 4 ++ 2 files changed, 56 insertions(+) create mode 100644 src/pages/overview/pdf-services-api/howtos/pdf-accessibility-checker-api.md diff --git a/src/pages/overview/pdf-services-api/howtos/pdf-accessibility-checker-api.md b/src/pages/overview/pdf-services-api/howtos/pdf-accessibility-checker-api.md new file mode 100644 index 000000000..836a1eb81 --- /dev/null +++ b/src/pages/overview/pdf-services-api/howtos/pdf-accessibility-checker-api.md @@ -0,0 +1,52 @@ +--- +title: PDF Accessibility Checker | How Tos | PDF Services API | Adobe PDF Services +--- + + +PDF Accessibility Checker is currently accessible through the REST API only. + +# PDF Accessibility Checker + +Accessibility Checker API will check PDF files to see if they meet the machine-verifiable requirements of PDF/UA and WCAG 2.0. It will generate a report that summarizes the findings of the accessibility checks. Additional human remediation may be required to ensure that the reading order of elements is correct and that alternative text tags properly convey the meaning of an image. The report contains links to documentation that assist in manually fixing problems using Adobe Acrobat Pro. + +## Input Documents : **Required** + +Supported format is PDF (application/pdf). Input PDF with version 1.6 and above is supported. + +### Input Document + +A PDF document for which accessibility to be checked. + +## API Parameters + +### Page ranges (_pageRanges_) + +Specifies the number of pages for which accessibility to be checked. Each object has the following properties: +* **Start Page** (*start*) : If "pageStart" is not provided, the first page is considered the default startPage. It should be greater than equal to 1. +* **End Page** (*end*) : If "pageEnd" is not provided, the last page is considered the default pageEnd. It should be greater than equal to 1. + +## REST API + +See our public API Reference for [PDF Accessibility Checker API](../../../apis/#tag/PDF-Accessibility-Checker). + +## Check accessibility for specified pages + +The sample below performs accessibility checker operation for specified pages of a given PDF. + +Please refer the [API usage guide](../gettingstarted.md) to understand how to use our APIs. + + + +#### REST API + +```javascript +curl --location --request POST 'https://pdf-services.adobe.io/operation/accessibilitychecker' \ +--header 'x-api-key: {{Placeholder for client_id}}' \ +--header 'Content-Type: application/json' \ +--header 'Authorization: Bearer {{Placeholder for token}}' \ +--data-raw '{ + "assetID": "urn:aaid:AS:UE1:54cbf87f-d7f5-4918-8e4b-9f1878678e68", + "pageStart":1, + "pageEnd":5 +}' +``` diff --git a/src/pages/overview/releasenotes.md b/src/pages/overview/releasenotes.md index fd0da6263..0488e27bb 100644 --- a/src/pages/overview/releasenotes.md +++ b/src/pages/overview/releasenotes.md @@ -181,6 +181,10 @@ Upgrading to the latest SDK should not break existing applications. ## Change history +### July 17, 2024; PDF Accessibility Checker API Added + +- Added [PDF Accessibility Checker](../pdf-services-api/howtos/pdf-accessibility-checker-api/) operation in PDF Services API to check accessibility on specified pages of PDF document. + ### July 08, 2024; PDF Watermark API Added - Added [PDF Watermark](../pdf-services-api/howtos/pdf-watermark-api/) operation in PDF Services API to add a watermark on specified pages of PDF document. From 6e4bf24a7b32aaa9f412a2081cdf596e92d3e530 Mon Sep 17 00:00:00 2001 From: Rajat Gaur Date: Wed, 10 Jul 2024 16:43:36 +0530 Subject: [PATCH 2/8] changed parameters tags --- .../howtos/pdf-accessibility-checker-api.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/src/pages/overview/pdf-services-api/howtos/pdf-accessibility-checker-api.md b/src/pages/overview/pdf-services-api/howtos/pdf-accessibility-checker-api.md index 836a1eb81..28f6cfb5b 100644 --- a/src/pages/overview/pdf-services-api/howtos/pdf-accessibility-checker-api.md +++ b/src/pages/overview/pdf-services-api/howtos/pdf-accessibility-checker-api.md @@ -19,11 +19,13 @@ A PDF document for which accessibility to be checked. ## API Parameters -### Page ranges (_pageRanges_) +### Page start (_pageStart_) -Specifies the number of pages for which accessibility to be checked. Each object has the following properties: -* **Start Page** (*start*) : If "pageStart" is not provided, the first page is considered the default startPage. It should be greater than equal to 1. -* **End Page** (*end*) : If "pageEnd" is not provided, the last page is considered the default pageEnd. It should be greater than equal to 1. +The parameter allows for the specification of the starting page for the accessibility check. If "pageStart" is not provided, the first page is considered the default startPage. It should be greater than equal to 1. + +### Page end (_pageEnd_) + +The parameter allows for the specification of the ending page for the accessibility check. If "pageEnd" is not provided, the last page is considered the default pageEnd. It should be greater than equal to 1.g ## REST API From c8483f644211615c5c8f540b0de07383c0466534 Mon Sep 17 00:00:00 2001 From: Rajat Gaur Date: Wed, 10 Jul 2024 16:44:15 +0530 Subject: [PATCH 3/8] changed parameters tags --- .../pdf-services-api/howtos/pdf-accessibility-checker-api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/pages/overview/pdf-services-api/howtos/pdf-accessibility-checker-api.md b/src/pages/overview/pdf-services-api/howtos/pdf-accessibility-checker-api.md index 28f6cfb5b..3319d71e7 100644 --- a/src/pages/overview/pdf-services-api/howtos/pdf-accessibility-checker-api.md +++ b/src/pages/overview/pdf-services-api/howtos/pdf-accessibility-checker-api.md @@ -25,7 +25,7 @@ The parameter allows for the specification of the starting page for the accessib ### Page end (_pageEnd_) -The parameter allows for the specification of the ending page for the accessibility check. If "pageEnd" is not provided, the last page is considered the default pageEnd. It should be greater than equal to 1.g +The parameter allows for the specification of the ending page for the accessibility check. If "pageEnd" is not provided, the last page is considered the default pageEnd. It should be greater than equal to 1. ## REST API From c7222d474b129a64e5cf21887162b883ffd3bc78 Mon Sep 17 00:00:00 2001 From: Rajat Gaur Date: Thu, 11 Jul 2024 21:07:24 +0530 Subject: [PATCH 4/8] changed info --- .../howtos/pdf-accessibility-checker-api.md | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/src/pages/overview/pdf-services-api/howtos/pdf-accessibility-checker-api.md b/src/pages/overview/pdf-services-api/howtos/pdf-accessibility-checker-api.md index 3319d71e7..3d336ac20 100644 --- a/src/pages/overview/pdf-services-api/howtos/pdf-accessibility-checker-api.md +++ b/src/pages/overview/pdf-services-api/howtos/pdf-accessibility-checker-api.md @@ -9,16 +9,12 @@ PDF Accessibility Checker is currently accessible through the REST API only. Accessibility Checker API will check PDF files to see if they meet the machine-verifiable requirements of PDF/UA and WCAG 2.0. It will generate a report that summarizes the findings of the accessibility checks. Additional human remediation may be required to ensure that the reading order of elements is correct and that alternative text tags properly convey the meaning of an image. The report contains links to documentation that assist in manually fixing problems using Adobe Acrobat Pro. -## Input Documents : **Required** - -Supported format is PDF (application/pdf). Input PDF with version 1.6 and above is supported. +## API Parameters ### Input Document A PDF document for which accessibility to be checked. -## API Parameters - ### Page start (_pageStart_) The parameter allows for the specification of the starting page for the accessibility check. If "pageStart" is not provided, the first page is considered the default startPage. It should be greater than equal to 1. From eb3264bff1f51444978664ca5f9dadac5d64d9cf Mon Sep 17 00:00:00 2001 From: Rajat Gaur Date: Mon, 15 Jul 2024 14:42:00 +0530 Subject: [PATCH 5/8] adding [DCSV-90853] : Changes for adding a release notes section - PDFPropeties API --- src/pages/overview/releasenotes.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/src/pages/overview/releasenotes.md b/src/pages/overview/releasenotes.md index 0488e27bb..7b795f740 100644 --- a/src/pages/overview/releasenotes.md +++ b/src/pages/overview/releasenotes.md @@ -178,13 +178,17 @@ Change types include the following: Minor and Patch releases are backward compatible with the previous release. Upgrading to the latest SDK should not break existing applications. - +h ## Change history ### July 17, 2024; PDF Accessibility Checker API Added - Added [PDF Accessibility Checker](../pdf-services-api/howtos/pdf-accessibility-checker-api/) operation in PDF Services API to check accessibility on specified pages of PDF document. +### July 12, 2024; Server Side Release - Get PDF Properties + +- Bug fixes [Get PDF Properties](../pdf-services-api/howtos/pdf-properties/) fixed data issue related to permissions in JSON response. + ### July 08, 2024; PDF Watermark API Added - Added [PDF Watermark](../pdf-services-api/howtos/pdf-watermark-api/) operation in PDF Services API to add a watermark on specified pages of PDF document. From 5ba889b9f75fe0458fbb0c58d59789c172e89e94 Mon Sep 17 00:00:00 2001 From: Rajat Gaur Date: Mon, 15 Jul 2024 15:10:40 +0530 Subject: [PATCH 6/8] adding checker to GA --- src/pages/resources/openapi.json | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/src/pages/resources/openapi.json b/src/pages/resources/openapi.json index 622035ae0..55b68b194 100644 --- a/src/pages/resources/openapi.json +++ b/src/pages/resources/openapi.json @@ -132,12 +132,7 @@ "PDF Properties", "Remove Protection", "Split PDF", - "PDF Watermark" - ] - }, - { - "name": "PDF operations Beta", - "tags": [ + "PDF Watermark", "PDF Accessibility Checker" ] } From e5642a01a58c01e40870f1fc7f4af198942618d1 Mon Sep 17 00:00:00 2001 From: Rajat Gaur Date: Mon, 15 Jul 2024 15:30:44 +0530 Subject: [PATCH 7/8] added in gatsby config --- gatsby-config.js | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/gatsby-config.js b/gatsby-config.js index 59d0ad690..8cabcb41e 100644 --- a/gatsby-config.js +++ b/gatsby-config.js @@ -280,6 +280,10 @@ module.exports = { { title: 'PDF Watermark', path: 'overview/pdf-services-api/howtos/pdf-watermark-api.md' + }, + { + title: 'PDF Accessibility Checker', + path: 'overview/pdf-services-api/howtos/pdf-accessibility-checker-api.md' } ] } From 986962095f76c935643908c98d6bc4455307c9f1 Mon Sep 17 00:00:00 2001 From: Rajat Gaur Date: Tue, 16 Jul 2024 15:11:52 +0530 Subject: [PATCH 8/8] adding changes to branch --- gatsby-config.js | 38 ++++++++++--------- .../howtos/pdf-accessibility-checker-api.md | 17 ++++----- 2 files changed, 29 insertions(+), 26 deletions(-) diff --git a/gatsby-config.js b/gatsby-config.js index 8cabcb41e..0c6e6adb8 100644 --- a/gatsby-config.js +++ b/gatsby-config.js @@ -93,14 +93,14 @@ module.exports = { title: 'Sales FAQ', path: '../document-services/faq/sales/' }, - { - title: 'Tech Support FAQ', - path: '../document-services/faq/tech-support/' - }, - { - title: 'Contact Us', - path: '../document-services/pricing/contact/' - } + { + title: 'Tech Support FAQ', + path: '../document-services/faq/tech-support/' + }, + { + title: 'Contact Us', + path: '../document-services/pricing/contact/' + } ] }, { @@ -576,6 +576,10 @@ module.exports = { title: 'Support', path: 'overview/support.md' }, + { + title: 'FAQ', + path: 'overview/faq.md' + }, { title: 'API Status', path: 'overview/status.md' @@ -829,14 +833,14 @@ module.exports = { ] }, plugins: [`@adobe/gatsby-theme-aio`, - { - resolve: `gatsby-source-filesystem`, - options: { - path: `${__dirname}/src/pages`, - name: "pages", - ignore: [`**/legacy-documentation`] - } - } + { + resolve: `gatsby-source-filesystem`, + options: { + path: `${__dirname}/src/pages`, + name: "pages", + ignore: [`**/legacy-documentation`] + } + } ], pathPrefix: process.env.PATH_PREFIX || '/document-services/docs/', -}; +}; \ No newline at end of file diff --git a/src/pages/overview/pdf-services-api/howtos/pdf-accessibility-checker-api.md b/src/pages/overview/pdf-services-api/howtos/pdf-accessibility-checker-api.md index 3d336ac20..44f64c7a5 100644 --- a/src/pages/overview/pdf-services-api/howtos/pdf-accessibility-checker-api.md +++ b/src/pages/overview/pdf-services-api/howtos/pdf-accessibility-checker-api.md @@ -7,31 +7,30 @@ PDF Accessibility Checker is currently accessible through the REST API only. # PDF Accessibility Checker -Accessibility Checker API will check PDF files to see if they meet the machine-verifiable requirements of PDF/UA and WCAG 2.0. It will generate a report that summarizes the findings of the accessibility checks. Additional human remediation may be required to ensure that the reading order of elements is correct and that alternative text tags properly convey the meaning of an image. The report contains links to documentation that assist in manually fixing problems using Adobe Acrobat Pro. +The Accessibility Checker API verifies if PDF files meet the machine-verifiable requirements of PDF/UA and WCAG 2.0. It generates a report summarizing the findings of the accessibility checks. Additional human remediation may be required to ensure the reading order of elements is correct and that alternative text tags properly convey the meaning of images. The report contains links to documentation that assists in manually fixing problems using Adobe Acrobat Pro. ## API Parameters ### Input Document -A PDF document for which accessibility to be checked. +A PDF document for which accessibility is to be checked. ### Page start (_pageStart_) -The parameter allows for the specification of the starting page for the accessibility check. If "pageStart" is not provided, the first page is considered the default startPage. It should be greater than equal to 1. +This parameter specifies the starting page for the accessibility check. If "pageStart" is not provided, the first page is considered the default start page. It should be greater than or equal to 1. ### Page end (_pageEnd_) -The parameter allows for the specification of the ending page for the accessibility check. If "pageEnd" is not provided, the last page is considered the default pageEnd. It should be greater than equal to 1. - +This parameter specifies the ending page for the accessibility check. If "pageEnd" is not provided, the last page is considered the default end page. It should be greater than or equal to 1. ## REST API -See our public API Reference for [PDF Accessibility Checker API](../../../apis/#tag/PDF-Accessibility-Checker). +See our public API Reference for the [PDF Accessibility Checker API](../../../apis/#tag/PDF-Accessibility-Checker). ## Check accessibility for specified pages -The sample below performs accessibility checker operation for specified pages of a given PDF. +The sample below performs an accessibility check operation for specified pages of a given PDF. -Please refer the [API usage guide](../gettingstarted.md) to understand how to use our APIs. +Please refer to the [API usage guide](../gettingstarted.md) to understand how to use our APIs. @@ -47,4 +46,4 @@ curl --location --request POST 'https://pdf-services.adobe.io/operation/accessib "pageStart":1, "pageEnd":5 }' -``` +``` \ No newline at end of file