generated from AdobeDocs/dev-site-documentation-template
-
Notifications
You must be signed in to change notification settings - Fork 199
added howtos and release notes for accessibility checker GA #905
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
rajatgaur30
wants to merge
8
commits into
develop
Choose a base branch
from
accessibilitycheckerGA
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
ec0afdc
added howtos and release notes for accessibility checker GA
rajatgaur30 6e4bf24
changed parameters tags
rajatgaur30 c8483f6
changed parameters tags
rajatgaur30 c7222d4
changed info
rajatgaur30 eb3264b
adding [DCSV-90853] : Changes for adding a release notes section - PD…
rajatgaur30 5ba889b
adding checker to GA
rajatgaur30 e5642a0
added in gatsby config
rajatgaur30 9869620
adding changes to branch
rajatgaur30 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
49 changes: 49 additions & 0 deletions
49
src/pages/overview/pdf-services-api/howtos/pdf-accessibility-checker-api.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
--- | ||
title: PDF Accessibility Checker | How Tos | PDF Services API | Adobe PDF Services | ||
--- | ||
<InlineAlert slots="text"/> | ||
|
||
PDF Accessibility Checker is currently accessible through the REST API only. | ||
|
||
# PDF Accessibility Checker | ||
|
||
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 | ||
rajatgaur30 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
A PDF document for which accessibility is to be checked. | ||
|
||
### Page start (_pageStart_) | ||
|
||
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_) | ||
|
||
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 the [PDF Accessibility Checker API](../../../apis/#tag/PDF-Accessibility-Checker). | ||
|
||
## Check accessibility for specified pages | ||
|
||
The sample below performs an accessibility check operation for specified pages of a given PDF. | ||
|
||
Please refer to the [API usage guide](../gettingstarted.md) to understand how to use our APIs. | ||
|
||
<CodeBlock slots="heading, code" repeat="1" languages="REST API" /> | ||
|
||
#### 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 | ||
}' | ||
``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.