fix: api docs by clarifying file extension requirements in API paths

[kmurugulla]

Description

In DA admin api docs clarified file extension requirements in API paths

• Added examples showing file paths must include extensions (e.g., .html, .json)
• Added examples showing folder paths must omit extensions
• Clarified version APIs require extensions in path parameters

Related Issue

• Fixes [doc]: API - missing extension #129

Motivation and Context

AI coding agents were not actually interpreting the API docs

How Has This Been Tested?

• generated api docs using npm run build:docs after modification
• ensured that instructions provided are accurate with respect to files and folders

Screenshots (if appropriate):

Types of changes

• Bug fix (non-breaking change which fixes an issue with docs
• 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.

Note - Please review the new docs

index.html

[kmurugulla]

The integration test failure seems due to stale data in the CI test environment (3 config entries instead of expected 2). This is unrelated to the documentation changes in this PR, which only modify OpenAPI YAML files and don't affect API behavior. A CI environment cleanup or test re-run should resolve this.

[auniverseaway]

@kmurugulla if you would have told me you were going to do this, I would have said to update the docs in the correct location. :-) Thanks for doing this.

[auniverseaway]

Oh, one other thing: you'll need to build locally and commit the output. I don't believe our docs update on commit.

[kmurugulla]

@kmurugulla if you would have told me you were going to do this, I would have said to update the docs in the correct location. :-) Thanks for doing this.

@auniverseaway - could you please let me know the correct location ?
I have attached the pre built api docs ( index.html) that i generated locally as archive to the PR assuming that they needs to be uploaded to the location that url is pointing to https://opensource.adobe.com/da-admin/ . Also added that index.html to the recent commit . Happy to upload them once you review and give me green

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

[adobe-bot]

🎉 This PR is included in version 1.1.4 🎉

The release is available on:

• v1.1.4
• GitHub release

Your semantic-release bot 📦🚀