Skip to content

[4.x] Add the Projects (v2) API package - #74

Open
Hackwar wants to merge 1 commit into
joomla-framework:4.x-devfrom
Hackwar:4.x-github-projects
Open

Hackwar wants to merge 1 commit into
joomla-framework:4.x-devfrom
Hackwar:4.x-github-projects

Conversation

@Hackwar

@Hackwar Hackwar commented Nov 12, 2026

Copy link
Copy Markdown
Contributor

Summary of Changes

Part of bringing joomla/github up to the current GitHub REST API (phases 1–3 of the modernisation plan). Purely additive: no existing method changes signature or behaviour.

Adds $github->projects for GitHub's REST API for Projects (v2) — no GraphQL needed: project lookups on the top-level class, plus projects->drafts, projects->fields, projects->items and projects->views, each with ForOrg / ForUser variants (26 operations).

Notes for review

  • Paths follow the spec exactly: some user-scoped endpoints use the numeric {user_id}, others {username}.
  • Fields::addForOrg() takes the whole field definition, because its body variants share no required field.
  • Lists are cursor-paginated (before/after in $filters); $page has no effect, as documented.
  • The classic Projects (v1) API was removed by GitHub and is not included.

How it was built

Generated from GitHub's official OpenAPI description (github/rest-api-description, api.github.com). Every non-deprecated operation of the category is covered; /enterprises/* endpoints are left out, as the library targets github.com.

Conventions shared by all package PRs: path parameters first, then required body fields, then array $options (optional body fields), array $filters (optional query parameters) and $page, $limit for paginated endpoints; free-form path segments are rawurlencode()d; create-or-update operations are called createOrUpdate…; 204 responses return nothing, 302 downloads return the Location URL, "check" endpoints return a boolean.

Testing Instructions

vendor/bin/phpunit: every new method has a success test (HTTP verb, exact URL and query, exact JSON body, return value) and a failure test. phpcs and phpstan report no errors.

52 new tests.

Documentation Changes Required

Adds docs/projects.md. The @property-read line in Github.php and the link from docs/index.md are added together for all new packages in #67, to keep these PRs from conflicting with each other.

🤖 Generated with Claude Code

Adds Joomla\Github\Package\Projects ($github->projects) with the sub-packages
Projects\Drafts, Projects\Fields, Projects\Items and Projects\Views, covering
all 26 operations of the GitHub REST projects category (projectsV2 endpoints of
organisations and users).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant