infra: regen-js-client skill#48
Open
bzajzon-laserfiche wants to merge 2 commits into
Open
Conversation
First team-shared skill for AI coding assistants in this repo. Documents the NSwag-generated V2 client regen against site-api-repository's swagger, plus the four traps that have silently broken the JS test suite in the past: swagger-override-filepath, baseUrl trailing-slash, jsdom multipart-Blob skip (#658052), and OpenApiTag client-split. README.md explains discovery (auto-scan of .claude/skills/*/SKILL.md frontmatter; vendor-neutral bodies so other assistants can read them) and authoring conventions. No change to the repo-level README intentionally; the skills system is scoped to its own directory in client libraries.
Replaces the reference to the (now-deleted) preview-NuGet user-story memory with a direct link to the regen-dotnet-client skill, which is the canonical home for the dotnet client publish workflow and the in-flight #659276 Phase 2 details.
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
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.
Summary
First team-shared playbook for AI coding assistants in this repo. No code changes.
.claude/skills/regen-js-client/SKILL.mdcovers the NSwag regen flow for the V2 client (packages/lf-repository-api-client-v2) and the four traps that have silently broken the test suite in the past:--swagger-override-filepathis mandatory — without it,Entry.fromJSregenerates as throw-only and everyimportEntry/getEntry/listEntriescall fails at deserialization..envbaseUrl must NOT have a trailing slash — NSwag prepends/to every path; trailing slash yields//v2/…and 404s.describe.skipIf(SKIP_UNDER_JSDOM)until #658052 closes. The current 12 wrapped files are listed in the skill.[OpenApiTag]client-split — NSwag'sMultipleClientsFromFirstTagAndOperationIdmode generates one client class per unique tag; an outlier tag on the server side silently disappears the method fromentriesClient..claude/skills/README.mdexplains discovery (Claude Code auto-scans SKILL.md frontmatter; bodies are vendor-neutral) and authoring conventions.Architecture rationale:
site-api-repository/docs/design-ai-assistant-skills.md(in companion PR).Companion PRs
site-api-repository: add-v2-endpoint skill + design doclf-repository-api-client-dotnet: regen-dotnet-client skill