René's URL Explorer Experiment


Title: Autogenerated docs for REST API · Issue #3522 · coder/coder · GitHub

Open Graph Title: Autogenerated docs for REST API · Issue #3522 · coder/coder

X Title: Autogenerated docs for REST API · Issue #3522 · coder/coder

Description: Currently, you can examine ./codersdk to see the various REST API queries supported by Coder. If you're interested in official documentation for the REST API (like similar to our approach for Coder Classic), please leave upvote this issu...

Open Graph Description: Currently, you can examine ./codersdk to see the various REST API queries supported by Coder. If you're interested in official documentation for the REST API (like similar to our approach for Coder...

X Description: Currently, you can examine ./codersdk to see the various REST API queries supported by Coder. If you're interested in official documentation for the REST API (like similar to our approach for C...

Opengraph URL: https://github.com/coder/coder/issues/3522

X: @github

direct link

Domain: github.com


Hey, it has json ld scripts:
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Autogenerated docs for REST API","articleBody":"Currently, you can examine [./codersdk](https://github.com/coder/coder/tree/main/codersdk) to see the various REST API queries supported by Coder. If you're interested in official documentation for the REST API (like [similar to our approach for Coder Classic](https://apidocs.coder.com)), please leave upvote this issue or [contact us](https://github.com/coder/coder). \r\n\r\n@mtojek:\r\n\r\nTrack progress\r\n\r\n**OSS**\r\n\r\n`/api/v2`:\r\n- [x] `/` https://github.com/coder/coder/pull/5493\r\n- [x] `/csp/reports` https://github.com/coder/coder/pull/5493\r\n- [x] `/buildinfo` https://github.com/coder/coder/pull/5493\r\n- [x] `/updatecheck` https://github.com/coder/coder/pull/5493\r\n- [x] `/config/deployment` https://github.com/coder/coder/pull/5506\r\n- [x] `/audit` and `/audit/testgenerate` https://github.com/coder/coder/pull/5506\r\n- [x] `/files` https://github.com/coder/coder/pull/5506\r\n- [x] `/parameters` https://github.com/coder/coder/pull/5506\r\n- [x] `/authcheck` https://github.com/coder/coder/pull/5477\r\n- [x] `/applications` https://github.com/coder/coder/pull/5477\r\n- [x] `/workspaceagents` (~11 methods) https://github.com/coder/coder/pull/5538\r\n- [x] `/workspacebuilds/{workspacebuild}` (~5 methods) https://github.com/coder/coder/pull/5538\r\n- [x] `/workspaces` (~9 methods) https://github.com/coder/coder/pull/5383 https://github.com/coder/coder/pull/5538\r\n- [x] `/templates/{template}` (~7 methods) https://github.com/coder/coder/pull/5383 https://github.com/coder/coder/pull/5546\r\n- [x] `/templateversions/{templateversion}` (~11 methods) https://github.com/coder/coder/pull/5546\r\n- [x] `/organizations` (~12 methods) https://github.com/coder/coder/pull/5383 https://github.com/coder/coder/pull/5546\r\n- [x] `/users` (~23 methods) https://github.com/coder/coder/pull/5620\r\n\r\n**Enterprise**\r\n\r\n`/api/v2`: https://github.com/coder/coder/pull/5625\r\n- [x] `/entitlements` (1 method)\r\n- [x] `/replicas` (2 methods)\r\n- [x] `/licenses` (4 methods)\r\n- [x] `/organizations/{organization}/groups` (3 methods)\r\n- [x] `/organizations/{organization}/provisionerdaemons` (2 methods)\r\n- [x] `/groups/{group}` (3 methods)\r\n- [x] `/workspace-quota` (1 method)\r\n- [x] ~~`/service-banner`~~ `/appearance` (2 methods)\r\n- [x] `/scim/v2` (6 methods)\r\n\r\n**Validation**\r\n- [ ] https://github.com/coder/coder/pull/5694\r\n\r\n**UI improvements**\r\n- [x] https://github.com/coder/coder/pull/5567 [Authentication](https://coder.com/docs/coder-oss/latest/api/authentication) page: explain how a user can generate tokens, link with [automation](https://coder.com/docs/coder-oss/latest/admin/automation#tokens) page\r\n\r\n**Other**\r\n- [x] https://github.com/coder/coder/pull/5590","author":{"url":"https://github.com/bpmct","@type":"Person","name":"bpmct"},"datePublished":"2022-08-15T21:41:49Z","url":"https://github.com/coder/coder/issues/3522"}

react-profiling0
react-import-mapreact,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322
route-pattern/_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format)
route-controllervoltron_issues_fragments
route-actionissue_layout
fetch-noncev2:8e4c0ed0-5e4a-9f57-c041-0edbaed6ed8e
current-catalog-service-hash81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114
request-id82BC:1F2F:B227E5:ED7CA0:6B01A9EC
html-safe-nonce5b1696a070e15954f330e3a9b5a028a34d1c96233badc4a001f7ba21f81a579d
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI4MkJDOjFGMkY6QjIyN0U1OkVEN0NBMDo2QjAxQTlFQyIsInZpc2l0b3JfaWQiOiI2ODU2MTk0Nzc5MDMwNTk2MDc2IiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0=
visitor-hmac2fcf5065c3adb965f124a6a2dcd812e10bea10d265ff2813f9c56ff5dc70de0a
hovercard-subject-tagissue:1339543652
github-keyboard-shortcutsrepository,issues,copilot
google-site-verificationApib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I
octolytics-urlhttps://collector.github.com/github/collect
analytics-location///voltron/issues_fragments/issue_layout
fb:app_id1401488693436528
apple-itunes-appapp-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/coder/coder/3522/issue_layout
twitter:imagehttps://opengraph.githubassets.com/cfe6334d8079597114497d6905d912393408913ac734972ff2ef50bd287f4ae6/coder/coder/issues/3522
twitter:cardsummary_large_image
og:imagehttps://opengraph.githubassets.com/cfe6334d8079597114497d6905d912393408913ac734972ff2ef50bd287f4ae6/coder/coder/issues/3522
og:image:altCurrently, you can examine ./codersdk to see the various REST API queries supported by Coder. If you're interested in official documentation for the REST API (like similar to our approach for Coder...
og:image:width1200
og:image:height600
og:site_nameGitHub
og:typeobject
og:author:usernamebpmct
hostnamegithub.com
expected-hostnamegithub.com
Nonecc5dfdd32f62ebd3223cab3af3aa2b268d3605218237326a48a99d1efd89495c
turbo-cache-controlno-preview
go-importgithub.com/coder/coder git https://github.com/coder/coder.git
octolytics-dimension-user_id95932066
octolytics-dimension-user_logincoder
octolytics-dimension-repository_id440752086
octolytics-dimension-repository_nwocoder/coder
octolytics-dimension-repository_publictrue
octolytics-dimension-repository_is_forkfalse
octolytics-dimension-repository_network_root_id440752086
octolytics-dimension-repository_network_root_nwocoder/coder
turbo-body-classeslogged-out env-production page-responsive
disable-turbofalse
browser-stats-urlhttps://api.github.com/_private/browser/stats
browser-errors-urlhttps://api.github.com/_private/browser/errors
release8c77c9e8439031ad54c75a250694842892f693e1
ui-targetfull
theme-color#1e2327
color-schemelight dark
react-app-nameissues

Links:

Skip to contenthttps://github.com/coder/coder/issues/3522#start-of-content
https://github.com/
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fcoder%2Fcoder%2Fissues%2F3522
GitHubRepository hosting, code review, and collaborationhttps://github.com/platform
CopilotAI coding agent for tasks, projects, and automated workhttps://github.com/features/copilot
ActionsCI/CD and automationhttps://github.com/features/actions
Code QualityQuality analysis, fixes, and enforcementhttps://github.com/features/code-quality
CodespacesCloud development environmentshttps://github.com/features/codespaces
Code SecurityVulnerability detection and remediationhttps://github.com/security/advanced-security/code-security
Secret ProtectionSecret scanning and leak preventionhttps://github.com/security/advanced-security/secret-protection
All Featureshttps://github.com/features
Documentationhttps://docs.github.com/en
Traininghttps://learn.github.com/skills
Certificationshttps://learn.github.com/credentials
Build with Copilothttps://github.com/features/ai
Customize Copilothttps://docs.github.com/en/copilot/how-tos/copilot-on-github/customize-copilot/customize-copilot-overview
Integrationshttps://github.com/marketplace
Trending reposhttps://github.com/trending
GitHub Sponsorshttps://github.com/open-source/sponsors
Developer articleshttps://github.com/resources/articles
ChangelogYour source for the latest features, improvements, and fixes across GitHub products, all in one place.https://github.blog/changelog/
Enterpriseshttps://github.com/enterprise
Teamhttps://github.com/team
Startupshttps://github.com/enterprise/startups
Nonprofitshttps://github.com/solutions/industry/nonprofits
Healthcarehttps://github.com/solutions/industry/healthcare
Financial serviceshttps://github.com/solutions/industry/financial-services
Manufacturinghttps://github.com/solutions/industry/manufacturing
Governmenthttps://github.com/solutions/industry/government
See all industrieshttps://github.com/solutions/industry
Why GitHubhttps://github.com/why-github
Customer Storieshttps://github.com/customer-stories
Business insightshttps://github.com/solutions/executive-insights
Trust Centerhttps://github.com/trust-center
GitHub Advanced SecurityEnterprise-grade code securityhttps://github.com/security/advanced-security
Copilot for businessEnterprise-grade AI featureshttps://github.com/features/copilot/copilot-business
Premium SupportEnterprise-grade 24/7 supporthttps://github.com/enterprise/premium-support
Documentationhttps://docs.github.com/en
Resource centerhttps://github.com/resources
Bloghttps://github.blog/
Events & webinarshttps://github.com/resources/events
Community Forumhttps://github.com/orgs/community/discussions
Customer Storieshttps://github.com/customer-stories
Integrationshttps://github.com/marketplace
Customer supporthttps://help.github.com/
Traininghttps://learn.github.com/skills
GitHub Statushttps://www.githubstatus.com/
Abouthttps://github.com/about
Partnershttps://github.com/partners
Changeloghttps://github.blog/changelog/
GitHub UniverseThe event for developers, by developers — talks, workshops, and what’s next for GitHub.https://githubuniverse.com/
Pricinghttps://github.com/pricing
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fcoder%2Fcoder%2Fissues%2F3522
Sign uphttps://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F%3Cuser-name%3E%2F%3Crepo-name%3E%2Fvoltron%2Fissues_fragments%2Fissue_layout&source=header-repo&source_repo=coder%2Fcoder
Reloadhttps://github.com/coder/coder/issues/3522
Reloadhttps://github.com/coder/coder/issues/3522
Reloadhttps://github.com/coder/coder/issues/3522
coderhttps://github.com/coder
coderhttps://github.com/coder/coder
Codehttps://github.com/coder/coder
Issues320 (320)https://github.com/coder/coder/issues
Pull requests470 (470)https://github.com/coder/coder/pulls
Discussionshttps://github.com/coder/coder/discussions
Actionshttps://github.com/coder/coder/actions
Projectshttps://github.com/coder/coder/projects
Security and quality49 (49)https://github.com/coder/coder/security
Insightshttps://github.com/coder/coder/insights
https://github.com/coder/coder
New issuehttps://github.com/login?return_to=https://github.com/coder/coder/issues/3522
New issuehttps://github.com/login?return_to=https://github.com/coder/coder/issues/3522
#5694https://github.com/coder/coder/pull/5694
Autogenerated docs for REST APIhttps://github.com/coder/coder/issues/3522#top
#5694https://github.com/coder/coder/pull/5694
https://github.com/mtojek
docsArea: coder.com/docshttps://github.com/coder/coder/issues?q=state%3Aopen%20label%3A%22docs%22
https://github.com/bpmct
bpmcthttps://github.com/bpmct
on Aug 15, 2022https://github.com/coder/coder/issues/3522#issue-1339543652
./codersdkhttps://github.com/coder/coder/tree/main/codersdk
similar to our approach for Coder Classichttps://apidocs.coder.com
contact ushttps://github.com/coder/coder
@mtojekhttps://github.com/mtojek
docs: api root, buildinfo, csp #5493https://github.com/coder/coder/pull/5493
docs: api root, buildinfo, csp #5493https://github.com/coder/coder/pull/5493
docs: api root, buildinfo, csp #5493https://github.com/coder/coder/pull/5493
docs: api root, buildinfo, csp #5493https://github.com/coder/coder/pull/5493
docs: audit, deploymentconfig, files, parameters #5506https://github.com/coder/coder/pull/5506
docs: audit, deploymentconfig, files, parameters #5506https://github.com/coder/coder/pull/5506
docs: audit, deploymentconfig, files, parameters #5506https://github.com/coder/coder/pull/5506
docs: audit, deploymentconfig, files, parameters #5506https://github.com/coder/coder/pull/5506
docs: applications and authorization #5477https://github.com/coder/coder/pull/5477
docs: applications and authorization #5477https://github.com/coder/coder/pull/5477
docs: API workspace agents and builds #5538https://github.com/coder/coder/pull/5538
docs: API workspace agents and builds #5538https://github.com/coder/coder/pull/5538
feat: Build framework for generating API docs #5383https://github.com/coder/coder/pull/5383
docs: API workspace agents and builds #5538https://github.com/coder/coder/pull/5538
feat: Build framework for generating API docs #5383https://github.com/coder/coder/pull/5383
docs: API templateversions, templates, members, organizations #5546https://github.com/coder/coder/pull/5546
docs: API templateversions, templates, members, organizations #5546https://github.com/coder/coder/pull/5546
feat: Build framework for generating API docs #5383https://github.com/coder/coder/pull/5383
docs: API templateversions, templates, members, organizations #5546https://github.com/coder/coder/pull/5546
docs: API users #5620https://github.com/coder/coder/pull/5620
#5625https://github.com/coder/coder/pull/5625
feat: Validate swagger definitions #5694https://github.com/coder/coder/pull/5694
docs: improve authentication page #5567https://github.com/coder/coder/pull/5567
Authenticationhttps://coder.com/docs/coder-oss/latest/api/authentication
automationhttps://coder.com/docs/coder-oss/latest/admin/automation#tokens
docs: update swaggo/swag v1.8.9 #5590https://github.com/coder/coder/pull/5590
https://github.com/kylecarbs
kylecarbshttps://github.com/kylecarbs
on Aug 15, 2022https://github.com/coder/coder/issues/3522#issuecomment-1215886657
godoc referencehttps://pkg.go.dev/github.com/coder/coder@main/codersdk
https://github.com/Emyrk
Emyrkhttps://github.com/Emyrk
on Aug 16, 2022https://github.com/coder/coder/issues/3522#issuecomment-1216851797
kylecarbshttps://github.com/kylecarbs
docsArea: coder.com/docshttps://github.com/coder/coder/issues?q=state%3Aopen%20label%3A%22docs%22
on Aug 24, 2022https://github.com/coder/coder/issues/3522#event-7253194563
bpmcthttps://github.com/bpmct
on Sep 19, 2022https://github.com/coder/coder/issues/3522#event-7415470898
https://github.com/bpmct
bpmcthttps://github.com/bpmct
on Sep 19, 2022https://github.com/coder/coder/issues/3522#issuecomment-1251302125
https://glab.readthedocs.io/en/latest/completion/index.htmlhttps://glab.readthedocs.io/en/latest/completion/index.html
bpmcthttps://github.com/bpmct
on Sep 19, 2022https://github.com/coder/coder/issues/3522#event-7415495338
https://github.com/apps/github-actions
github-actionshttps://github.com/apps/github-actions
on Nov 19, 2022https://github.com/coder/coder/issues/3522#issuecomment-1320685982
github-actionshttps://github.com/apps/github-actions
staleThis issue is like stale bread.https://github.com/coder/coder/issues?q=state%3Aopen%20label%3A%22stale%22
on Nov 19, 2022https://github.com/coder/coder/issues/3522#event-7848314352
github-actionshttps://github.com/apps/github-actions
not plannedhttps://github.com/coder/coder/issues?q=is%3Aissue%20state%3Aclosed%20archived%3Afalse%20reason%3Anot-planned
on Nov 27, 2022https://github.com/coder/coder/issues/3522#event-7896856993
bpmcthttps://github.com/bpmct
on Dec 1, 2022https://github.com/coder/coder/issues/3522#event-7934992282
github-actionshttps://github.com/apps/github-actions
staleThis issue is like stale bread.https://github.com/coder/coder/issues?q=state%3Aopen%20label%3A%22stale%22
on Dec 2, 2022https://github.com/coder/coder/issues/3522#event-7936574466
bpmcthttps://github.com/bpmct
mtojekhttps://github.com/mtojek
on Dec 6, 2022https://github.com/coder/coder/issues/3522#event-7968931836
https://github.com/mtojek
mtojekhttps://github.com/mtojek
on Dec 9, 2022https://github.com/coder/coder/issues/3522#issuecomment-1344156914
https://github.com/mtojek
mtojekhttps://github.com/mtojek
on Dec 9, 2022https://github.com/coder/coder/issues/3522#issuecomment-1344306615
Go commentshttps://github.com/swaggo/swag#declarative-comments-format
swaghttps://github.com/swaggo/swag
chi-go/docgenhttps://github.com/go-chi/docgen
https://user-images.githubusercontent.com/14044910/206711332-b74e26d2-d620-4e5a-893e-657a0b4ac495.png
widdershinshttps://github.com/Mermade/widdershins
promissinghttps://speckleworks.github.io/SpeckleSpecs/#streamcreate
https://github.com/Emyrk
Emyrkhttps://github.com/Emyrk
on Dec 9, 2022https://github.com/coder/coder/issues/3522#issuecomment-1344454775
Go commentshttps://github.com/swaggo/swag#declarative-comments-format
swaghttps://github.com/swaggo/swag
chi-go/docgenhttps://github.com/go-chi/docgen
https://github.com/mtojek
mtojekhttps://github.com/mtojek
on Dec 9, 2022https://github.com/coder/coder/issues/3522#issuecomment-1344503489
@Emyrkhttps://github.com/Emyrk
@johnstcnhttps://github.com/johnstcn
https://github.com/mtojek
mtojekhttps://github.com/mtojek
on Dec 19, 2022https://github.com/coder/coder/issues/3522#issuecomment-1358018919
bpmcthttps://github.com/bpmct
on Dec 19, 2022https://github.com/coder/coder/issues/3522#event-8073280419
mtojekhttps://github.com/mtojek
completedhttps://github.com/coder/coder/issues?q=is%3Aissue%20state%3Aclosed%20archived%3Afalse%20reason%3Acompleted
#5694https://github.com/coder/coder/pull/5694
on Jan 13, 2023https://github.com/coder/coder/issues/3522#event-8219945822
Sign up for freehttps://github.com/signup?return_to=https://github.com/coder/coder/issues/3522
Sign in to commenthttps://github.com/login?return_to=https://github.com/coder/coder/issues/3522
mtojekhttps://github.com/mtojek
docsArea: coder.com/docshttps://github.com/coder/coder/issues?q=state%3Aopen%20label%3A%22docs%22
https://github.com
Termshttps://docs.github.com/site-policy/github-terms/github-terms-of-service
Privacyhttps://docs.github.com/site-policy/privacy-policies/github-privacy-statement
Securityhttps://github.com/security
Statushttps://www.githubstatus.com/
Communityhttps://github.community/
Docshttps://docs.github.com/
Contacthttps://support.github.com?tags=dotcom-footer

Viewport: width=device-width


URLs of crawlers that visited me.