Skip to content

Commit f54ad5e

Browse files
committed
docs(ci): ignore local docs and document remote swagger fetch
1 parent 6c152b7 commit f54ad5e

2 files changed

Lines changed: 8 additions & 1 deletion

File tree

.gitignore

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ packages/
1919
openapi/goaffpro.openapi.json
2020
openapi/goaffpro-user.openapi.json
2121
openapi/goaffpro-public.openapi.json
22+
openapi/swagger-ui-init.js
2223
obj/GoAffPro.Client.Generator.hash
2324

2425
# Generated code (tracked, but can be regenerated)
@@ -35,3 +36,8 @@ Thumbs.db
3536

3637
# Local development overrides
3738
examples/GoAffPro.Client.Example/appsettings.development.json
39+
40+
# Local LLM/notes docs (not published to GitHub)
41+
AGENTS.md
42+
ARCHITECTURE.md
43+
docs/

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,8 @@ dotnet run --project examples/GoAffPro.Client.Example
122122

123123
On build, `GoAffPro.Client.Generator`:
124124

125-
1. Reads `openapi/swagger-ui-init.js` (or falls back to `https://api.goaffpro.com/docs/admin/swagger-ui-init.js`)
125+
1. Fetches `https://api.goaffpro.com/docs/admin/swagger-ui-init.js`
126+
(or uses `openapi/swagger-ui-init.js` only if you provide a local override file)
126127
2. Extracts OpenAPI JSON
127128
3. Filters to `/user/*` and `/public/*`
128129
4. Normalizes schema gaps for generation

0 commit comments

Comments
 (0)