Convert indesign to idml prod by shreyaguptaforwork · Pull Request #74 · AdobeDocs/ffs-indesign-API

shreyaguptaforwork · 2026-10-01T11:25:46Z

Description

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

I have signed the Adobe Open Source CLA.
My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have read the CONTRIBUTING document.
I have added tests to cover my changes.
All new and existing tests passed.

into V4Change

fix: correct pageRange/exportingSpread description in rendition API spec

Rendition and Data Merge multi-file outputs (per-page or per-record) use InDesign's native sequential naming, not an underscore-delimited scheme, which integrators have misread when predicting outputs[].source values. Document the rule once in Key Concepts and cross-link it from both guides, including a caution about base strings ending in a digit.

* Output Path Variations, add info about 'failedAssets' key * chore: auto-generate contributors * adding review * chore: auto-generate contributors * adding copyfitting note * chore: auto-generate contributors

github-actions · 2026-10-01T11:26:34Z

🔍 Linter Report

Click to expand full report

═══════════════════════════════════════════════════════════════
                     LINTER REPORT
═══════════════════════════════════════════════════════════════

Generated: 2026-10-01T11:26:16.139Z
Mode: Full Linting (all rules + dead links check)
Target Directory: /home/runner/work/ffs-indesign-API/ffs-indesign-API

───────────────────────────────────────────────────────────────

Files to process: 13

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/getting-started/concepts/index.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 434:1
    Message: Unexpected dead URL `https://docs.aws.amazon.com/AmazonS3/latest/userguide/ShareObjectPreSignedURL.html`, expected live URL
    Rule: no-dead-urls

  ⚠️  WARNING
    Location: Line 435:1
    Message: Unexpected dead URL `https://dropbox.github.io/dropbox-api-v2-explorer/#files_get_temporary_link`, expected live URL
    Rule: no-dead-urls

  ⚠️  WARNING
    Location: Line 438:1
    Message: Unexpected dead URL `https://developer.adobe.com/events/docs/guides/using/indesign-apis/indesign-apis-events-data-stream-setup/`, expected live URL
    Rule: no-dead-urls

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/getting-started/index.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 53:1
    Message: Unexpected dead URL `https://developer.adobe.com/developer-console/docs/guides/services/services-add-api-oauth-s2s/`, expected live URL
    Rule: no-dead-urls

  ⚠️  WARNING
    Location: Line 54:1
    Message: Unexpected dead URL `https://developer.adobe.com/developer-console/docs/guides/services/services-add-api-oauth-s2s/#api-overview`, expected live URL
    Rule: no-dead-urls

  ⚠️  WARNING
    Location: Line 52:1
    Message: Unexpected dead URL `https://developer.adobe.com/developer-console/docs/guides/projects/projects-empty/`, expected live URL
    Rule: no-dead-urls

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/guides/working-with-custom-scripts-api/index.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 155:1
    Message: Unexpected dead URL `https://developer.adobe.com/commerce/webapi/get-started/gs-curl/`, expected live URL
    Rule: no-dead-urls

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/guides/working-with-datamerge-api/index.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 121:23
    Message: Unexpected dead URL `https://developer.adobe.com/commerce/webapi/get-started/gs-curl/`, expected live URL
    Rule: no-dead-urls

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/guides/working-with-rendition-api/index.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 84:1
    Message: Unexpected dead URL `https://developer.adobe.com/commerce/webapi/get-started/gs-curl/`, expected live URL
    Rule: no-dead-urls

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/guides/writing-scripts-for-custom-scripts-api/index.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 381:1
    Message: Unexpected dead URL `https://www.indesignjs.de/extendscriptAPI/indesign-server14/#Application.html`, expected live URL
    Rule: no-dead-urls


═══════════════════════════════════════════════════════════════
                        SUMMARY
═══════════════════════════════════════════════════════════════

  📁 Files processed:    13
  📄 Files with issues:  6
  ❌ Total errors:       0
  ⚠️  Total warnings:     10
  📋 Total issues:       10

Result: ⚠️  PASSED WITH WARNINGS - No fatal errors

═══════════════════════════════════════════════════════════════

This comment was automatically generated by the linter bot.

SumitCo

LGTM

Rendition and Data Merge multi-file outputs (per-page or per-record) use InDesign's native sequential naming, not an underscore-delimited scheme, which integrators have misread when predicting outputs[].source values. Document the rule once in Key Concepts and cross-link it from both guides, including a caution about base strings ending in a digit.

* Output Path Variations, add info about 'failedAssets' key * chore: auto-generate contributors * adding review * chore: auto-generate contributors * adding copyfitting note * chore: auto-generate contributors

into V4Change

github-actions · 2026-11-02T04:53:12Z

🔍 Linter Report

Click to expand full report

═══════════════════════════════════════════════════════════════
                     LINTER REPORT
═══════════════════════════════════════════════════════════════

Generated: 2026-11-02T04:52:56.566Z
Mode: Full Linting (all rules + dead links check)
Target Directory: /home/runner/work/ffs-indesign-API/ffs-indesign-API

───────────────────────────────────────────────────────────────

Files to process: 15

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/getting-started/concepts/index.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 454:1
    Message: Unexpected dead URL `https://dropbox.github.io/dropbox-api-v2-explorer/#files_get_temporary_link`, expected live URL
    Rule: no-dead-urls

  ⚠️  WARNING
    Location: Line 453:1
    Message: Unexpected dead URL `https://docs.aws.amazon.com/AmazonS3/latest/userguide/ShareObjectPreSignedURL.html`, expected live URL
    Rule: no-dead-urls

  ⚠️  WARNING
    Location: Line 457:1
    Message: Unexpected dead URL `https://developer.adobe.com/events/docs/guides/using/indesign-apis/indesign-apis-events-data-stream-setup/`, expected live URL
    Rule: no-dead-urls

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/getting-started/index.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 53:1
    Message: Unexpected dead URL `https://developer.adobe.com/developer-console/docs/guides/services/services-add-api-oauth-s2s/`, expected live URL
    Rule: no-dead-urls

  ⚠️  WARNING
    Location: Line 54:1
    Message: Unexpected dead URL `https://developer.adobe.com/developer-console/docs/guides/services/services-add-api-oauth-s2s/#api-overview`, expected live URL
    Rule: no-dead-urls

  ⚠️  WARNING
    Location: Line 52:1
    Message: Unexpected dead URL `https://developer.adobe.com/developer-console/docs/guides/projects/projects-empty/`, expected live URL
    Rule: no-dead-urls

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/guides/using-adobe-fonts/index.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 44:61
    Message: Unexpected dead URL `https://helpx.adobe.com/business/enterprise/products-entitlements/manage-product-profiles/create-product-profiles.html`, expected live URL
    Rule: no-dead-urls

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/guides/working-with-custom-scripts-api/index.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 155:1
    Message: Unexpected dead URL `https://developer.adobe.com/commerce/webapi/get-started/gs-curl/`, expected live URL
    Rule: no-dead-urls

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/guides/working-with-datamerge-api/index.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 121:23
    Message: Unexpected dead URL `https://developer.adobe.com/commerce/webapi/get-started/gs-curl/`, expected live URL
    Rule: no-dead-urls

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/guides/working-with-rendition-api/index.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 88:1
    Message: Unexpected dead URL `https://developer.adobe.com/commerce/webapi/get-started/gs-curl/`, expected live URL
    Rule: no-dead-urls

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/guides/writing-scripts-for-custom-scripts-api/index.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 381:1
    Message: Unexpected dead URL `https://www.indesignjs.de/extendscriptAPI/indesign-server14/#Application.html`, expected live URL
    Rule: no-dead-urls


═══════════════════════════════════════════════════════════════
                        SUMMARY
═══════════════════════════════════════════════════════════════

  📁 Files processed:    15
  📄 Files with issues:  7
  ❌ Total errors:       0
  ⚠️  Total warnings:     11
  📋 Total issues:       11

Result: ⚠️  PASSED WITH WARNINGS - No fatal errors

═══════════════════════════════════════════════════════════════

This comment was automatically generated by the linter bot.

github-actions · 2026-11-02T05:04:03Z

🔍 Linter Report

Click to expand full report

═══════════════════════════════════════════════════════════════
                     LINTER REPORT
═══════════════════════════════════════════════════════════════

Generated: 2026-11-02T05:03:47.475Z
Mode: Full Linting (all rules + dead links check)
Target Directory: /home/runner/work/ffs-indesign-API/ffs-indesign-API

───────────────────────────────────────────────────────────────

Files to process: 15

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/getting-started/concepts/index.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 454:1
    Message: Unexpected dead URL `https://dropbox.github.io/dropbox-api-v2-explorer/#files_get_temporary_link`, expected live URL
    Rule: no-dead-urls

  ⚠️  WARNING
    Location: Line 457:1
    Message: Unexpected dead URL `https://developer.adobe.com/events/docs/guides/using/indesign-apis/indesign-apis-events-data-stream-setup/`, expected live URL
    Rule: no-dead-urls

  ⚠️  WARNING
    Location: Line 453:1
    Message: Unexpected dead URL `https://docs.aws.amazon.com/AmazonS3/latest/userguide/ShareObjectPreSignedURL.html`, expected live URL
    Rule: no-dead-urls

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/getting-started/index.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 54:1
    Message: Unexpected dead URL `https://developer.adobe.com/developer-console/docs/guides/services/services-add-api-oauth-s2s/#api-overview`, expected live URL
    Rule: no-dead-urls

  ⚠️  WARNING
    Location: Line 52:1
    Message: Unexpected dead URL `https://developer.adobe.com/developer-console/docs/guides/projects/projects-empty/`, expected live URL
    Rule: no-dead-urls

  ⚠️  WARNING
    Location: Line 53:1
    Message: Unexpected dead URL `https://developer.adobe.com/developer-console/docs/guides/services/services-add-api-oauth-s2s/`, expected live URL
    Rule: no-dead-urls

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/guides/using-adobe-fonts/index.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 44:61
    Message: Unexpected dead URL `https://helpx.adobe.com/business/enterprise/products-entitlements/manage-product-profiles/create-product-profiles.html`, expected live URL
    Rule: no-dead-urls

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/guides/working-with-custom-scripts-api/index.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 155:1
    Message: Unexpected dead URL `https://developer.adobe.com/commerce/webapi/get-started/gs-curl/`, expected live URL
    Rule: no-dead-urls

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/guides/working-with-datamerge-api/index.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 121:23
    Message: Unexpected dead URL `https://developer.adobe.com/commerce/webapi/get-started/gs-curl/`, expected live URL
    Rule: no-dead-urls

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/guides/working-with-rendition-api/index.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 88:1
    Message: Unexpected dead URL `https://developer.adobe.com/commerce/webapi/get-started/gs-curl/`, expected live URL
    Rule: no-dead-urls

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/guides/writing-scripts-for-custom-scripts-api/index.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 381:1
    Message: Unexpected dead URL `https://www.indesignjs.de/extendscriptAPI/indesign-server14/#Application.html`, expected live URL
    Rule: no-dead-urls


═══════════════════════════════════════════════════════════════
                        SUMMARY
═══════════════════════════════════════════════════════════════

  📁 Files processed:    15
  📄 Files with issues:  7
  ❌ Total errors:       0
  ⚠️  Total warnings:     11
  📋 Total issues:       11

Result: ⚠️  PASSED WITH WARNINGS - No fatal errors

═══════════════════════════════════════════════════════════════

This comment was automatically generated by the linter bot.

SumitCo and others added 30 commits August 10, 2026 23:00

documentation for V4

fc573b5

more changes for V4

dab080b

fixing linting error

fa03c3a

chore: auto-generate contributors

11d1433

minor fixes

fc4f291

Merge branch 'V4Change' of https://github.com/AdobeDocs/ffs-indesign-API

1f608e0

into V4Change

Changes fo V4

1ef35d3

More changes for V4

5dab7d7

Update screenshot for v3

ec2607c

copyfitting changes

84b2640

Merge branch 'V4Change' of https://github.com/AdobeDocs/ffs-indesign-API

55de329

into V4Change

chore: auto-generate contributors

30daf45

More V4 changes

0df464c

Merge branch 'V4Change' of https://github.com/AdobeDocs/ffs-indesign-API

4315a4a

into V4Change

Bringing V4 change back

83e1bb0

Changes as per styleguide

c9f19bf

chore: auto-generate contributors

0f40675

Merge pull request #69 from AdobeDocs/users-rhythmj-exporting_spread

2ee4735

fix: correct pageRange/exportingSpread description in rendition API spec

chore: auto-generate contributors

96814be

Adding Review (#71)

8331cac

* Output Path Variations, add info about 'failedAssets' key * chore: auto-generate contributors * adding review * chore: auto-generate contributors * adding copyfitting note * chore: auto-generate contributors

chore: auto-generate contributors

dfb5faa

documentation update

91c879c

update

4d03b8e

update

eff55c4

resolved comments

b9e4534

name change

3f50292

update name

8b8af55

Update indesignapi.json

f4bfe84

resolved comments

a6aca84

shreyaguptaforwork requested review from SumitCo and rhythmjain18-adobe October 1, 2026 11:25

SumitCo approved these changes Oct 1, 2026

View reviewed changes

SumitCo and others added 23 commits November 1, 2026 23:34

documentation for V4

f59f72c

more changes for V4

479360c

fixing linting error

b8d38d7

minor fixes

689c30c

chore: auto-generate contributors

78a4f90

Changes fo V4

7157f83

More changes for V4

c0e942c

copyfitting changes

bcca32e

Update screenshot for v3

b8e445c

More V4 changes

6e1c678

chore: auto-generate contributors

7b30f6f

Bringing V4 change back

a377fb9

Changes as per styleguide

9a9cdd5

chore: auto-generate contributors

68415c0

chore: auto-generate contributors

0e779dd

Adding Review (#71)

4f6c399

* Output Path Variations, add info about 'failedAssets' key * chore: auto-generate contributors * adding review * chore: auto-generate contributors * adding copyfitting note * chore: auto-generate contributors

chore: auto-generate contributors

0c1ae7d

Merge branch 'V4Change' of https://github.com/AdobeDocs/ffs-indesign-API

f3803c4

into V4Change

feedback changes

560a6e9

Adobe fonts documentation

f91aa2b

chore: auto-generate contributors

35da6b0

Merge branch 'V4Change' into convert-to-idml-prod

8d84f9a

update

9aa5b7e

Navigation Menu

Repository navigation

Convert indesign to idml prod - #74

Convert indesign to idml prod#74
shreyaguptaforwork wants to merge 55 commits into
mainfrom
convert-to-idml-prod

shreyaguptaforwork commented Oct 1, 2026

Uh oh!

github-actions Bot commented Oct 1, 2026

Uh oh!

SumitCo left a comment

Uh oh!

github-actions Bot commented Nov 2, 2026

Uh oh!

github-actions Bot commented Nov 2, 2026

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

shreyaguptaforwork commented Oct 1, 2026

Description

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

Checklist:

Uh oh!

github-actions Bot commented Oct 1, 2026

🔍 Linter Report

Uh oh!

SumitCo left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented Nov 2, 2026

🔍 Linter Report

Uh oh!

github-actions Bot commented Nov 2, 2026

🔍 Linter Report

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants