fix(docs): generate the Integration Service API reference pages - #762
Merged
Merged
Conversation
Contributor
|
✅ No issues found. Checked for bugs and CLAUDE.md compliance. |
vnaren23
approved these changes
Sep 18, 2026
anil-uipath
approved these changes
Sep 18, 2026
Contributor
|
✅ No issues found. Checked for bugs and CLAUDE.md compliance. |
anil-uipath
approved these changes
Sep 18, 2026
Contributor
|
✅ No issues found. Checked for bugs and CLAUDE.md compliance. |
![claude[bot]](https://avatars.githubusercontent.com/in/1236702?s=60&v=4){kind=small}
Contributor
|
✅ No issues found. Checked for bugs and CLAUDE.md compliance. |
1 similar comment
Contributor
|
✅ No issues found. Checked for bugs and CLAUDE.md compliance. |
The Connections nav section pointed at three pages TypeDoc never emitted, so every entry under it 404'd. TypeDoc runs off a single entry point, src/index.ts, which never reached src/models/integration-service: the directory had no barrel and no export line. Add the barrel and export it, mirroring models/platform, whose barrel is why the Users pages from the same release do render. Exporting it collided with the identically-shaped ConnectionState enum in conversational-agent (TS2308), so declare that enum once in models/common/types.ts beside JobState and re-export it from each domain's connections.types.ts, the way jobs.types.ts re-exports StopStrategy. Both subpaths still export it as a value and the published api/enumerations/ConnectionState page is unchanged, so nothing breaks for consumers. The Integration Service barrel now exports the models barrel instead of listing the eight model files individually. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
ninja-shreyash
force-pushed
the
fix/is-docs-nav
branch
from
September 18, 2026 11:25
663b1ec to
01ff2ad
Compare
Contributor
|
✅ No issues found. Checked for bugs and CLAUDE.md compliance. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The Connections section of the API reference is empty. The three pages linked from
mkdocs.yml:215-218(ConnectorsServiceModel,ConnectionsServiceModel,ElementsServiceModel) all 404.TypeDoc runs off
src/index.tsonly, and nothing there reachedsrc/models/integration-service/, so those pages were never generated.Usersfrom the same release works becausesrc/index.tsalready exports./models/platform.Changes
src/models/integration-service/index.tsand export it fromsrc/index.ts, same asmodels/platform. Models only, services stay subpath-only. This is the docs fix.ConnectionStateonce insrc/models/common/types.ts, beside the existingJobState. Integration Service and conversational-agent each had their own copy with identical values (Enabled,Disabled,Expired,Failed), which collided withTS2308once the models reached the root barrel.export *they already have. Tests import it from the models path, alongside the response types they already take from there.No breaking change.
ConnectionStatekeeps its name and values,@uipath/uipath-typescript/connectionsand@uipath/uipath-typescript/conversational-agentboth still export it as a value, and the publishedapi/enumerations/ConnectionStatepage keeps working. It is now also importable from the root without ambiguity.Verification
typedocgenerates all three pages plus a singleConnectionStateenum page,typecheckclean,oxlint0 errors,test:unit2873 passing,buildclean,docs:validatematchesmain. Checked indistthatConnectionStateis exported from/connections,/conversational-agentand the root, and thatConnectionGetResponse,ConnectorGetResponse,ElementObjectandExecuteResultsurvive the barrel swap.Please merge before #760 (1.7.2 bump), so the pages go live with that release.
Context: Slack thread where this duplicate name was raised.
Follow-ups, not here
mkdocs.ymllinks a page TypeDoc skips. Either setstrict: trueor add the API pages to anllmstxtsection.tsconfig.jsonisinclude: ['src/**/*']withtestsexcluded, sotypechecknever validates test-file imports, and roughly 70 type errors have accumulated in the integration suite (mostlytests/integration/shared/maestro/).execute()is missing fromrelease-metadata.json(per the bot on chore: bump version to 1.7.2 #760). The generator only walks*ServiceModelinterfaces, andexecute()is a standalone function.FieldandLogicalOperatorare also declared twice (data-fabric and document-understanding), coexisting only because DU framework is root-exported as a namespace.