Skip to content

Conversation

@mario130
Copy link
Contributor

@mario130 mario130 commented Apr 16, 2025

Checklist:

  • I have updated the necessary documentation
  • I have signed off all my commits as required by DCO
  • My build is green

This pull request introduces support for "unversioned" API requests, allowing users to make requests without specifying an API version. The changes include updates to documentation, the client implementation, and tests to accommodate this new feature.

Feature: Support for "unversioned" API requests

  • Documentation updates:

    • Added an entry in CHANGELOG.md to document the new "unversioned" API request feature.
    • Updated README.md with an example of using the version: 'unversioned' option in API requests.
  • Client implementation:

    • Modified the urlConfig method in lib/client.ts to construct URLs without a version prefix when version: 'unversioned' is specified.
    • Updated the version method in lib/client.ts to return an empty string for "unversioned" requests.
  • Testing:

    • Added a new test case in test/client.spec.ts to verify that "unversioned" API requests function correctly.

Signed-off-by: Mario Yonan <mario.yonan@procore.com>
@mario130 mario130 requested review from a team as code owners April 16, 2025 20:19
@m-graf m-graf self-requested a review April 16, 2025 20:35
m-graf
m-graf previously approved these changes Apr 16, 2025
Copy link
Contributor

@m-graf m-graf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should update the changelog as well- code looks fine though!

njbbaer
njbbaer previously approved these changes Apr 17, 2025
@mario130 mario130 dismissed stale reviews from njbbaer and m-graf via af1ed12 April 18, 2025 23:31
tedyangx
tedyangx previously approved these changes Apr 18, 2025
…t support

Signed-off-by: Mario Yonan <mario.yonan@procore.com>
@mario130 mario130 force-pushed the support-unversioned branch from af1ed12 to d599745 Compare April 20, 2025 16:42
Signed-off-by: Mario Yonan <mario.yonan@procore.com>
@njbbaer njbbaer merged commit 7b484e7 into procore-oss:main Apr 22, 2025
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants