Remove @ts-expect-error on custom properties API once octokit types are updated

Open
#485 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
45/100
Issue type
Refactor
Clarity
Mostly clear
Activity status
Quiet
Tech stack
typescript
Domain
api, backend

Research direction

Start by checking the upstream Octokit discussion linked in the issue to confirm that custom-properties endpoint types are available. Then inspect the three suppressed calls in src/server/repos/controller.ts, remove the @ts-expect-error comments, and verify that the TypeScript checks pass without them.

Written by the indexing model from the issue text.

Description

Context

In src/server/repos/controller.ts, octokit.rest.repos.getCustomPropertiesValues() and octokit.rest.orgs.getAllCustomProperties() / octokit.rest.orgs.createOrUpdateCustomProperty() are currently suppressed with @ts-expect-error because @octokit/plugin-rest-endpoint-methods (bundled in octokit v5) does not yet include type definitions for these endpoints. (introduced in PR #484

The endpoints exist in the GitHub API and work correctly at runtime — the suppression is purely
a types gap.

What needs to happen

Once the octokit upstream types are updated to include the custom properties endpoints, remove
the @ts-expect-error comments in src/server/repos/controller.ts.

Upstream tracking

https://github.com/octokit/octokit.js/discussions/2050

Dominant language
TypeScript
Stars
203
Forks
42
Avg merge
1h 15m
Merged PRs (30d)
8

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from github-community-projects/private-mirrors

All issues in github-community-projects/private-mirrors

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.