feat(source-workday) update docs #67214

darynaishchenko · 2025-10-07T12:36:12Z

What

Updates docs for source workday and source workday rest changes added in this pr

How

Review guide

User Impact

Can this PR be safely reverted and rolled back?

YES 💚
NO ❌

… rest docs

github-actions · 2025-10-07T12:36:36Z

👋 Greetings, Airbyte Team Member!

Here are some helpful tips and reminders for your convenience.

Helpful Resources

PR Slash Commands

Airbyte Maintainers (that's you!) can execute the following slash commands on your PR:

/format-fix - Fixes most formatting issues.
/update-connector-cdk-version connector=<CONNECTOR_NAME> - Updates the specified connector to the latest CDK version.
Example: /update-connector-cdk-version connector=destination-bigquery
/bump-version - Bumps connector versions.
- You can specify a custom changelog by passing changelog. Example: /bump-version changelog="My cool update"
- Leaving the changelog arg blank will auto-populate the changelog from the PR title.
/run-cat-tests - Runs legacy CAT tests (Connector Acceptance Tests)
/build-connector-images - Builds and publishes a pre-release docker image for the modified connector(s).
/poe connector source-example lock - Run the Poe lock task on the source-example connector, committing the results back to the branch.
/poe source example lock - Alias for /poe connector source-example lock.
/poe source example use-cdk-branch my/branch - Pin the source-example CDK reference to the branch name specified.
/poe source example use-cdk-latest - Update the source-example CDK dependency to the latest available version.

📝 Edit this welcome message.

github-actions

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

markdownlint

[markdownlint] _{reported by reviewdog 🐶}
MD004/ul-style Unordered list style [Expected: dash; Actual: asterisk]

airbyte/docs/integrations/enterprise-connectors/source-workday.md

Line 28 in e231003

* Report IDs - Each report in Workday has a unique Report ID.

darynaishchenko · 2025-10-07T15:09:17Z

/format-fix

Format-fix job started... Check job output.

🟦 Job completed successfully (no changes).

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

docs/integrations/enterprise-connectors/source-workday-migrations.md

docs/integrations/enterprise-connectors/source-workday-rest.md

katmarkham · 2025-10-09T02:39:13Z

Approved review not to be blocking but please make docs changes as noted above! Thanks :)

github-actions · 2025-10-10T17:50:55Z

Deploy preview for airbyte-docs ready!

✅ Preview
https://airbyte-docs-9nvpdt8qz-airbyte-growth.vercel.app

Built with commit 418bb0f.
This pull request is being automatically deployed with vercel-action

github-actions · 2025-10-13T08:46:23Z

docs/integrations/enterprise-connectors/source-workday-migrations.md

@@ -0,0 +1,18 @@
+# Workday Migration Guide


⚠️ [vale] _{reported by reviewdog 🐶}
[Google.Headings] 'Workday Migration Guide' should use sentence-style capitalization.

github-actions · 2025-10-13T08:46:23Z

docs/integrations/enterprise-connectors/source-workday-migrations.md

+## Upgrading to 1.0.0
+
+This release splits Source Workday into two separate connectors - Source Workday (for RaaS streams) and Source Workday REST (for REST streams).
+The connector you're currently using is deprecating REST streams and will continue to support only RAAS streams.   REST streams will be available in the new Source Workday REST.


⚠️ [vale] _{reported by reviewdog 🐶}
[Google.Will] Avoid using 'will'.

github-actions · 2025-10-13T08:46:23Z

docs/integrations/enterprise-connectors/source-workday-migrations.md

+## Upgrading to 1.0.0
+
+This release splits Source Workday into two separate connectors - Source Workday (for RaaS streams) and Source Workday REST (for REST streams).
+The connector you're currently using is deprecating REST streams and will continue to support only RAAS streams.   REST streams will be available in the new Source Workday REST.


🚫 [vale] _{reported by reviewdog 🐶}
[Google.Spacing] 's. R' should have one space.

github-actions · 2025-10-13T08:46:23Z

docs/integrations/enterprise-connectors/source-workday-migrations.md

+## Upgrading to 1.0.0
+
+This release splits Source Workday into two separate connectors - Source Workday (for RaaS streams) and Source Workday REST (for REST streams).
+The connector you're currently using is deprecating REST streams and will continue to support only RAAS streams.   REST streams will be available in the new Source Workday REST.


⚠️ [vale] _{reported by reviewdog 🐶}
[Google.Will] Avoid using 'will'.

github-actions · 2025-10-13T08:46:24Z

docs/integrations/enterprise-connectors/source-workday-migrations.md

+This release splits Source Workday into two separate connectors - Source Workday (for RaaS streams) and Source Workday REST (for REST streams).
+The connector you're currently using is deprecating REST streams and will continue to support only RAAS streams.   REST streams will be available in the new Source Workday REST.
+
+Action required only if you were using this source to sync REST streams (REST authentication on Setup Page).  In that case, you will need to disable this connection and create a new connection using new Source Workday REST. Otherwise, simply upgrade this source to v1.0.0 and continue syncing RaaS streams as usual.


⚠️ [vale] _{reported by reviewdog 🐶}
[Google.Will] Avoid using 'will'.

github-actions · 2025-10-13T08:46:25Z

docs/integrations/enterprise-connectors/source-workday-rest.md

+- Workday hostname - The endpoint for connecting into your Workday environment. This can be found by logging into your Workday instance and searching “Public Web Service” in the search bar and selecting the appropriate report. Use the ellipse (...) button to select **Web Service > View WSDL**
+- Access token - An OAuth 2.0 access token for API client integrations. More information and instructions can be found in the Workday community documentation for your environment about creating and registering a Workday API Client. If you are using Airbyte Teams, when registering the API Client for Airbyte, you can use https://cloud.airbyte.com/auth_flow for the Redirection URI field . If you are using Self-Managed Enterprise, you can use the URL of your Airbyte deployment instead.
+
+## Setup Guide


⚠️ [vale] _{reported by reviewdog 🐶}
[Google.Headings] 'Setup Guide' should use sentence-style capitalization.

github-actions · 2025-10-13T08:46:25Z

docs/integrations/enterprise-connectors/source-workday-rest.md

+2. Click Sources and then click **+ New source**.
+3. On the Set up the source page, select Workday REST.
+4. Enter a name for the Workday connector.
+5. Enter the Tenant and Hostname for your Workday environment.


🚫 [vale] _{reported by reviewdog 🐶}
[Vale.Spelling] Did you really mean 'Hostname'?

github-actions · 2025-10-13T08:46:26Z

docs/integrations/enterprise-connectors/source-workday-rest.md

+4. Enter a name for the Workday connector.
+5. Enter the Tenant and Hostname for your Workday environment.
+6. Enter the access token.
+7. **Start Date (Optional)** is the earliest date for data that will be synced. If a date is not specified, all data from the last 2 years will be synced.


⚠️ [vale] _{reported by reviewdog 🐶}
[Google.Will] Avoid using 'will'.

github-actions · 2025-10-13T08:46:26Z

docs/integrations/enterprise-connectors/source-workday-rest.md

+4. Enter a name for the Workday connector.
+5. Enter the Tenant and Hostname for your Workday environment.
+6. Enter the access token.
+7. **Start Date (Optional)** is the earliest date for data that will be synced. If a date is not specified, all data from the last 2 years will be synced.


⚠️ [vale] _{reported by reviewdog 🐶}
[Google.Will] Avoid using 'will'.

github-actions · 2025-10-13T08:46:26Z

docs/integrations/enterprise-connectors/source-workday-rest.md

+  - Worker Payslips
+  - Worker Time Off Entries
+
+## Supported Streams


⚠️ [vale] _{reported by reviewdog 🐶}
[Google.Headings] 'Supported Streams' should use sentence-style capitalization.

@darynaishchenko

## What  This PR adds support for migration guides on enterprise connectors. <img width="1920" height="883" alt="image" src="https://github.com/user-attachments/assets/8a94d7a7-e390-4460-900c-bfaf000e6f0b" /> ## How  Updated filtering logic to support top-level `id` as well as nested `link.id`. The existing filtering logic for enterprise connectors in the sidebar did not expect nested migration guides. The reason is because the getFilenamesInDir() function returns two different object structures. Simple doc (no migration file): { type: "doc", id: "...", label: "..." } - has id at top level Category with migration doc: { type: "category", label: "...", link: { id: "..." }, items: [...] } - has id nested in link.id @darynaishchenko discovered during work on #67214 that all builds failed when a migration guide was added to an enterprise connector. ## Review guide 1. Review the logic in the sidebar filtering code. 2. There is currently no migration guide in master to test this on, but I did test this fix with Darnya's PR and it built correctly with the updated code. You can simulate a migration guide by adding a dummy `<connector_filename>-migrations.md` doc for an enterprise connector. At build time it should nest appropriately under its parent object. ## User Impact  Enterprise customers can have migration guides too. ## Can this PR be safely reverted and rolled back?  - [x] YES 💚 - [ ] NO ❌

darynaishchenko added 2 commits October 7, 2025 15:33

update docs for source workdat, add migration gude and source workday…

2ca4c02

… rest docs

update docs

e231003

darynaishchenko self-assigned this Oct 7, 2025

darynaishchenko requested a review from a team as a code owner October 7, 2025 12:36

github-actions bot reviewed Oct 7, 2025

View reviewed changes

format fix

ad122ad

darynaishchenko and others added 3 commits October 7, 2025 18:17

format fix

8048a75

format fix

fa39381

Update docs/integrations/enterprise-connectors/source-workday-rest.md

d0d98af

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

darynaishchenko requested a review from katmarkham October 7, 2025 15:22

darynaishchenko and others added 3 commits October 7, 2025 18:25

Update docs/integrations/enterprise-connectors/source-workday-rest.md

c473ef0

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

Merge branch 'master' into daryna/source-workday/update-docs

34bfaee

Merge branch 'master' into daryna/source-workday/update-docs

f2c2707

katmarkham approved these changes Oct 9, 2025

View reviewed changes

darynaishchenko and others added 3 commits October 10, 2025 14:30

update docs

8375b48

Merge branch 'master' into daryna/source-workday/update-docs

a57b8ce

renamed migration docs

44f9086

renamed again

4c7da4e

ian-at-airbyte mentioned this pull request Oct 10, 2025

feat: Support migration guides for enterprise connectors #67615

Merged

2 tasks

Merge branch 'master' into daryna/source-workday/update-docs

513324c

github-actions bot reviewed Oct 13, 2025

View reviewed changes

Merge branch 'master' into daryna/source-workday/update-docs

418bb0f

feat(source-workday) update docs #67214

Are you sure you want to change the base?

feat(source-workday) update docs #67214

Conversation

darynaishchenko commented Oct 7, 2025

What

How

Review guide

User Impact

Can this PR be safely reverted and rolled back?

Uh oh!

github-actions bot commented Oct 7, 2025

👋 Greetings, Airbyte Team Member!

Helpful Resources

PR Slash Commands

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

darynaishchenko commented Oct 7, 2025 • edited by github-actions bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

katmarkham commented Oct 9, 2025

Uh oh!

github-actions bot commented Oct 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot Oct 13, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Oct 13, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Oct 13, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Oct 13, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Oct 13, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Oct 13, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Oct 13, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Oct 13, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Oct 13, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Oct 13, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

darynaishchenko commented Oct 7, 2025 •

edited by github-actions bot

Loading

github-actions bot commented Oct 10, 2025 •

edited

Loading