Complete CLI documentation coverage

Complete CLI documentation coverage

Deploy story

What this commit did to the running system — joined from the forge receipt chain, the part a commit page elsewhere cannot show.

Not deployed through the forge lane

No push, promotion, build, or deploy receipt references this commit (receipts are scanned over a bounded recent window). Changes shipped by full node replacement carry their proof in the release gate receipt instead.

Changed files

modified docs/github-api-issues-projects-assessment.md
modified test/openagents_web/docs_catalog_test.exs

Diff

2 files changed, +15 -7

# GitHub-shaped Issues and Projects API assessment

Date: 2026-08-20
Date: 2026-08-22

Status: Repository-scoped subset implemented; bounded compatibility gaps remain



| Concern | Methods and paths |
| --- | --- |
| Issues | `GET, POST /repos/{owner}/{repo}/issues`; `GET, PATCH /repos/{owner}/{repo}/issues/{number}` |
| Comments | `GET, POST /repos/{owner}/{repo}/issues/{number}/comments`; `GET, PATCH, DELETE /repos/{owner}/{repo}/issues/comments/{id}` |
| Labels | `GET, POST /repos/{owner}/{repo}/labels`; `GET, PATCH, DELETE /repos/{owner}/{repo}/labels/{name}` |
| Issues | `GET, POST /repos/{owner}/{repo}/issues`; `GET, PUT, PATCH /repos/{owner}/{repo}/issues/{number}` |
| Comments | `GET, POST /repos/{owner}/{repo}/issues/{number}/comments`; `GET, PUT, PATCH, DELETE /repos/{owner}/{repo}/issues/comments/{id}` |
| Labels | `GET, POST /repos/{owner}/{repo}/labels`; `GET, PUT, PATCH, DELETE /repos/{owner}/{repo}/labels/{name}` |
| Issue labels | `GET, POST /repos/{owner}/{repo}/issues/{number}/labels`; `DELETE /repos/{owner}/{repo}/issues/{number}/labels/{name}` |
| Assignees | `GET /repos/{owner}/{repo}/assignees`; `GET /repos/{owner}/{repo}/assignees/{login}`; issue-assignee list/add/remove paths |
| Milestones | `GET, POST /repos/{owner}/{repo}/milestones`; `GET, PATCH, DELETE /repos/{owner}/{repo}/milestones/{number}` |
| Assignees | `GET /repos/{owner}/{repo}/assignees`; `GET /repos/{owner}/{repo}/assignees/{login}`; `GET, POST, DELETE /repos/{owner}/{repo}/issues/{number}/assignees` |
| Milestones | `GET, POST /repos/{owner}/{repo}/milestones`; `GET, PUT, PATCH, DELETE /repos/{owner}/{repo}/milestones/{number}` |

Cross-repository issue lists, organization issue lists, event/timeline APIs,
locks, dependencies, sub-issues, and suggestion APIs are not implemented.

    end
  end

  test "published CLI docs cover agent login, npm, npx, imports, and persistent Git authentication" do
  test "published CLI docs cover authentication, installation, imports, and API access" do
    assert {:ok, install} = DocsCatalog.render("install-cli")
    assert install.markdown =~ "npm install --global @openagentsinc/cli"
    assert install.markdown =~ "npx --yes @openagentsinc/cli@latest"

    assert import.markdown =~ "one-time copy"
    assert import.markdown =~ "--wait-timeout 0"
    assert import.markdown =~ "A client timeout does not cancel"

    assert {:ok, api} = DocsCatalog.render("cli-api")
    assert api.markdown =~ "openagents api"
    assert api.markdown =~ ".issues[]"
    assert api.markdown =~ "projectsV2/PROJECT_NUMBER/items"
    assert api.markdown =~ "numeric database ID"
    assert api.markdown =~ "does not provide `openagents issue`"
    assert api.markdown =~ "`openagents project` commands"
  end

  describe "the docs surface" do

1	1		`# GitHub-shaped Issues and Projects API assessment`
2	2
3		-	`Date: 2026-08-20`
	3	+	`Date: 2026-08-22`
4	4
5	5		`Status: Repository-scoped subset implemented; bounded compatibility gaps remain`
6	6

18	18
19	19		`\| Concern \| Methods and paths \|`
20	20		`\| --- \| --- \|`
21		-	\| Issues \| `GET, POST /repos/{owner}/{repo}/issues`; `GET, PATCH /repos/{owner}/{repo}/issues/{number}` \|
22		-	\| Comments \| `GET, POST /repos/{owner}/{repo}/issues/{number}/comments`; `GET, PATCH, DELETE /repos/{owner}/{repo}/issues/comments/{id}` \|
23		-	\| Labels \| `GET, POST /repos/{owner}/{repo}/labels`; `GET, PATCH, DELETE /repos/{owner}/{repo}/labels/{name}` \|
	21	+	\| Issues \| `GET, POST /repos/{owner}/{repo}/issues`; `GET, PUT, PATCH /repos/{owner}/{repo}/issues/{number}` \|
	22	+	\| Comments \| `GET, POST /repos/{owner}/{repo}/issues/{number}/comments`; `GET, PUT, PATCH, DELETE /repos/{owner}/{repo}/issues/comments/{id}` \|
	23	+	\| Labels \| `GET, POST /repos/{owner}/{repo}/labels`; `GET, PUT, PATCH, DELETE /repos/{owner}/{repo}/labels/{name}` \|
24	24		\| Issue labels \| `GET, POST /repos/{owner}/{repo}/issues/{number}/labels`; `DELETE /repos/{owner}/{repo}/issues/{number}/labels/{name}` \|
25		-	\| Assignees \| `GET /repos/{owner}/{repo}/assignees`; `GET /repos/{owner}/{repo}/assignees/{login}`; issue-assignee list/add/remove paths \|
26		-	\| Milestones \| `GET, POST /repos/{owner}/{repo}/milestones`; `GET, PATCH, DELETE /repos/{owner}/{repo}/milestones/{number}` \|
	25	+	\| Assignees \| `GET /repos/{owner}/{repo}/assignees`; `GET /repos/{owner}/{repo}/assignees/{login}`; `GET, POST, DELETE /repos/{owner}/{repo}/issues/{number}/assignees` \|
	26	+	\| Milestones \| `GET, POST /repos/{owner}/{repo}/milestones`; `GET, PUT, PATCH, DELETE /repos/{owner}/{repo}/milestones/{number}` \|
27	27
28	28		`Cross-repository issue lists, organization issue lists, event/timeline APIs,`
29	29		`locks, dependencies, sub-issues, and suggestion APIs are not implemented.`

70	70		`end`
71	71		`end`
72	72
73		-	`test "published CLI docs cover agent login, npm, npx, imports, and persistent Git authentication" do`
	73	+	`test "published CLI docs cover authentication, installation, imports, and API access" do`
74	74		`assert {:ok, install} = DocsCatalog.render("install-cli")`
75	75		`assert install.markdown =~ "npm install --global @openagentsinc/cli"`
76	76		`assert install.markdown =~ "npx --yes @openagentsinc/cli@latest"`

83	83		`assert import.markdown =~ "one-time copy"`
84	84		`assert import.markdown =~ "--wait-timeout 0"`
85	85		`assert import.markdown =~ "A client timeout does not cancel"`
	86	+
	87	+	`assert {:ok, api} = DocsCatalog.render("cli-api")`
	88	+	`assert api.markdown =~ "openagents api"`
	89	+	`assert api.markdown =~ ".issues[]"`
	90	+	`assert api.markdown =~ "projectsV2/PROJECT_NUMBER/items"`
	91	+	`assert api.markdown =~ "numeric database ID"`
	92	+	assert api.markdown =~ "does not provide `openagents issue`"
	93	+	assert api.markdown =~ "`openagents project` commands"
86	94		`end`
87	95
88	96		`describe "the docs surface" do`