Conversation
|
All changed packages have been documented.
Show changes
|
|
You can try these changes here
|
commit: |
There was a problem hiding this comment.
Pull request overview
Adds an automated “doc update agent” workflow and refreshes/expands TCGC documentation + Spector coverage to keep docs/specs aligned with current TCGC behavior.
Changes:
- Update TCGC emitter/dev and design docs to reflect newer APIs (
@clientLocation,children,clientInitialization, etc.). - Add new Spector specs + mock APIs for
@clientDocand@responseAsBool, and regenerate the scenario summary. - Introduce a scheduled GitHub Actions workflow plus a custom agent definition to periodically trigger doc maintenance tasks.
Reviewed changes
Copilot reviewed 16 out of 16 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| website/src/content/docs/docs/libraries/typespec-client-generator-core/guideline.md | Updates guidance to use @clientLocation and documents @apiVersion / @clientApiVersions. |
| packages/typespec-client-generator-core/design-docs/client.md | Refreshes terminology for client hierarchy/initialization in the design doc. |
| packages/azure-http-specs/specs/azure/client-generator-core/response-as-bool/mockapi.ts | Adds mock API for the @responseAsBool scenario. |
| packages/azure-http-specs/specs/azure/client-generator-core/response-as-bool/main.tsp | Adds Spector scenario for @responseAsBool. |
| packages/azure-http-specs/specs/azure/client-generator-core/client-doc/mockapi.ts | Adds mock APIs for @clientDoc scenarios. |
| packages/azure-http-specs/specs/azure/client-generator-core/client-doc/main.tsp | Adds Spector scenarios covering @clientDoc replace/append modes. |
| packages/azure-http-specs/spec-summary.md | Regenerated scenarios summary to include new scenarios and updated scenario metadata. |
| cspell.yaml | Adds domain words used by new scenarios/namespaces. |
| .github/workflows/tcgc-doc-update-scheduler.yml | Adds weekly scheduler workflow to trigger the doc-update agent task. |
| .github/agents/tcgc-doc-updater.agent.md | Defines the agent scope/guardrails and update procedure. |
| .chronus/changes/update-tcgc-docs-and-specs-2026-2-5-0-0-0.md | Changelog entry for the new Spector specs. |
packages/azure-http-specs/specs/azure/client-generator-core/response-as-bool/main.tsp
Show resolved
Hide resolved
packages/azure-http-specs/specs/azure/client-generator-core/client-doc/main.tsp
Outdated
Show resolved
Hide resolved
packages/azure-http-specs/specs/azure/client-generator-core/client-doc/main.tsp
Outdated
Show resolved
Hide resolved
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…ient-doc/main.tsp Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…ient-doc/main.tsp Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
website/src/content/docs/docs/howtos/Generate client libraries/05pagingOperations.mdx
Show resolved
Hide resolved
|
|
||
| ```java | ||
| // When @markAsLro is applied, the operation returns a poller | ||
| public SyncPoller<PollOperationDetails, DeploymentResult> beginStartDeployment( |
There was a problem hiding this comment.
Do you know whether/how Java (actually -- TCGC) knows poll response as PollOperationDetails, given the decorator is only @markAsLro?
| // When the service returns "", the value will be deserialized as null | ||
| public final class MyModel { | ||
| public String getDisplayName() { ... } | ||
| public String getDescription() { ... } | ||
| } |
There was a problem hiding this comment.
Java does not support this @deserializeEmptyStringAsNull.
|
Interesting idea. We can use similar solution for simple maintenances tasks like doc and version bump etc. In the execution of the doc pages, I'd hope we could have a validation step, to compare the doc filled by agent, with yaml/code generated from emitter (from the source tsp in doc). So that we can avoid hallucination from LLM pollute downstream consumers (particularly, if one emitter does not support a feature, we'd avoid document saying that it supports). |
Resolve: #3868