Skip to content

Conversation

@javierbrea
Copy link
Collaborator

Add confluence.apiPrefix option

Description

  • feat: Add confluence.apiPrefix option, enabling to change the apiPrefix option passed to confluence.js. Default set to /rest/
  • chore: Add command to run all package checks to root package.json

closes #63

Agreement

Please check the following boxes after you have read and understood each item.

  • I have read the CONTRIBUTING document
  • I have read the CODE_OF_CONDUCT document
  • I accept that, by signing the Contributor License Agreement through a comment in the PR, my Github user name will be stored by in a branch of this repository for future reference.

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.

@javierbrea javierbrea self-assigned this Nov 24, 2025
Copilot AI review requested due to automatic review settings November 24, 2025 08:11
@javierbrea javierbrea linked an issue Nov 24, 2025 that may be closed by this pull request
1 task
Copy link
Contributor

Copilot AI left a 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.apiPrefix configuration option with /rest/ as the default value
  • Implemented the option across both markdown-confluence-sync and confluence-sync components
  • 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.

@github-actions
Copy link

Check SPDX headers

✅ 245 files have valid headers.

@github-actions
Copy link

Check License Compliance

✅ There are 1450 dependencies with allowed licenses.

⚠️ There are 5 dependencies with dangerous licenses:

✅ Result: Valid licenses

@javierbrea javierbrea merged commit 5246539 into main Nov 24, 2025
11 checks passed
@javierbrea javierbrea deleted the feat/63/api-prefix branch November 24, 2025 09:41
@github-actions github-actions bot locked and limited conversation to collaborators Nov 24, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Feature]: Confluence versions support

4 participants