-
Notifications
You must be signed in to change notification settings - Fork 887
feat: Build framework for generating API docs #5383
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
99 commits
Select commit
Hold shift + click to select a range
92f4f83
WIP
mtojek f92bf47
Gen
mtojek c9de1a6
WIP
mtojek bd6ed04
chi swagger
mtojek 484f1e9
WIP
mtojek 9a2493b
WIP
mtojek fe48812
WIP
mtojek dab3704
GetWorkspaces
mtojek b43e6c3
GetWorkspaces
mtojek 8358457
Markdown
mtojek d32b7b7
Use widdershins
mtojek a087ace
WIP
mtojek 90dea8c
WIP
mtojek eef09e6
WIP
mtojek 37e51cd
Markdown template
mtojek aa27c9f
Fix: makefile
mtojek 23307e5
fmt
mtojek f4349e1
Fix: comment
mtojek 09ca65a
Merge branch 'main' into 3522-autogenerate-docs-2
mtojek 357c044
Enable swagger conditionally
mtojek 0dcad6c
fix: site
mtojek cb9da6d
Default false
mtojek 1844264
Flag tests
mtojek 1a7ba5c
fix
mtojek 3c51729
fix
mtojek ba00bfc
template fixes
mtojek cc5d9ac
Fix
mtojek ae0e284
Fix
mtojek fb4ef9f
Fix
mtojek d022f99
WIP
mtojek 23a1dc3
Formatted
mtojek 1a1ccc4
Cleanup
mtojek c49f146
Templates
mtojek 54b06d4
BEGIN END SECTION
mtojek 5fe7f59
subshell exit code
mtojek 8c8ce44
Fix
mtojek 423650b
Merge branch 'main' into 3522-autogenerate-docs-2
mtojek c3902d5
Fix merge
mtojek b7c22dc
WIP
mtojek 5f68605
Fix
mtojek 7208269
Fix fmt
mtojek c69c157
Fix
mtojek 14a659e
Generic api.md page
mtojek 1c8b44f
Merge branch 'main' into 3522-autogenerate-docs-2
mtojek 04540f8
Fix merge
mtojek bb57436
Link pages
mtojek 84a5de4
Fix
mtojek c7c93ab
Fix
mtojek 574e79d
Fix: links
mtojek 87689fc
Add icon
mtojek 9b1ed37
Write manifest file
mtojek f58a114
Fix fmt
mtojek 18effcd
Fix: enterprise
mtojek ebf2e9e
Fix: Swagger.Enable
mtojek 2564f31
Fix: rename apidocs to apidoc
mtojek c69a0d9
Fix: find -not -prune
mtojek a9a62b3
Fix: json not available
mtojek 79285d2
Fix: rename Coderd API to Coder API
mtojek 59d9334
Fix: npm exec
mtojek 80dbf3d
Fix: api dir
mtojek d8cb335
Fix: by ID
mtojek 8a0aa36
Fix: string uuid
mtojek e4db936
Fix: include deleted
mtojek cfb86da
Fix: indirect go.mod
mtojek 638f5ba
Fix: source lib.sh
mtojek 5bac489
Fix: shellcheck
mtojek 2853405
Fix: pushd popd
mtojek c090ef8
Fix: fmt
mtojek e310b79
Fix: improve workspaces
mtojek c7533fa
Fix: swagger-enable
mtojek 83aa9d3
Fix
mtojek 6309f07
Fix: mention only HTTP 200
mtojek 8bc8a25
Fix: IDs
mtojek 209d9cc
Fix: https
mtojek be283e5
Fix: icon
mtojek f7c4d97
Merge branch 'main' into 3522-autogenerate-docs-2
mtojek 0d917dc
More APis
mtojek a07e2ab
Fix: format swagger.json
mtojek 82a680d
Fix: SwaggerEndpoint
mtojek 73a7013
Fix: SCRIPT_DIR
mtojek 7ab3a1f
Fix: PROJECT_ROOT
mtojek fcaba60
Fix: use code tags in schemas.md
mtojek 1677409
Fix: examples
mtojek 75f37c6
Fix: examples
mtojek d80d94b
Fix: improve format
mtojek 4a52aa8
Fix: date-time,enums
mtojek a719007
Fix: include_deleted
mtojek 5de5b3a
Fix: array of
mtojek 802b2b4
Fix: parameter, response
mtojek 83a815b
Fix: string time or null
mtojek 7282eca
Workspaces: more docs
mtojek ddd2d7d
Workspaces: more docs
mtojek 95718aa
Fix: renderDisplayName
mtojek 1f5e17e
Fix: ActiveUserCount
mtojek fb59fbd
Fix
mtojek 7aa7f1c
Fix: typo
mtojek 9c97e0c
Merge branch 'main' into 3522-autogenerate-docs-2
mtojek 3f182cc
Templates: docs
mtojek 1f28dc6
Notice: incomplete
mtojek File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
sanity check: New API docs (swagger and markdown) are being generated (and committed) during each release? Is this also how we generate our Prometheus docs?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Both actions, Prometheus and API docs, use the same target,
make gen
, so every generated doc is stored in the repository. If you see possible drawbacks, we can sync offline.