-
Notifications
You must be signed in to change notification settings - Fork 3
feat: Add confluence.apiPrefix option #68
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR adds support for configuring a custom Confluence API prefix through a new confluence.apiPrefix option, enabling compatibility with Confluence instances that use non-standard API paths. The default value is set to /rest/ to maintain backward compatibility.
Key Changes:
- Added
confluence.apiPrefixconfiguration option with/rest/as the default value - Implemented the option across both
markdown-confluence-syncandconfluence-synccomponents - Added test coverage for the new configuration option
- Updated documentation to reflect the new option
Reviewed changes
Copilot reviewed 15 out of 15 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| package.json | Added check:all command to run all package checks |
| components/markdown-confluence-sync/src/lib/confluence/ConfluenceSync.types.ts | Added type definitions for the apiPrefix option |
| components/markdown-confluence-sync/src/lib/confluence/ConfluenceSync.ts | Implemented apiPrefix option initialization and usage |
| components/markdown-confluence-sync/test/component/specs/config.spec.ts | Added tests for default and custom apiPrefix values |
| components/markdown-confluence-sync/README.md | Documented the new apiPrefix configuration option |
| components/markdown-confluence-sync/CHANGELOG.md | Added changelog entry for the new feature |
| components/confluence-sync/src/confluence/CustomConfluenceClient.types.ts | Added apiPrefix to the client configuration interface |
| components/confluence-sync/src/confluence/CustomConfluenceClient.ts | Implemented apiPrefix with fallback to default value |
| components/confluence-sync/src/ConfluenceSyncPages.types.ts | Added apiPrefix to sync pages configuration |
| components/confluence-sync/src/ConfluenceSyncPages.ts | Passed apiPrefix to the Confluence client |
| components/confluence-sync/test/unit/specs/confluence/CustomConfluenceClient.test.ts | Added test for custom apiPrefix configuration |
| components/confluence-sync/package.json | Bumped version to 2.2.0 |
| components/confluence-sync/README.md | Documented the apiPrefix option in the sync library |
| components/confluence-sync/CHANGELOG.md | Added changelog entry with release date |
| .github/CONTRIBUTING.md | Updated documentation for running tasks across all components |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
Check SPDX headers ✅ 245 files have valid headers. |
|
Check License Compliance ✅ There are 1450 dependencies with allowed licenses.
✅ Result: Valid licenses |
Add confluence.apiPrefix option
Description
confluence.apiPrefixoption, enabling to change the apiPrefix option passed toconfluence.js. Default set to/rest/closes #63
Agreement
Please check the following boxes after you have read and understood each item.
In case this is your first contribution to this project, you will also have to add a comment with the following text: "I have read the CLA Document and I hereby sign the CLA", otherwise the PR status will fail and our bot will request you to add it. Once you have signed it in a PR, you will not have to sign it again for future contributions.