TryGhost / TryGhost/SDK

TypeScript support for the admin api client

Open
#446 7 comments 7 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Hacktoberfest
Dominant language
JavaScript
Stars
134
Forks
87
Avg merge
12m
Merged PRs (30d)
25

Description

I saw that there are community-provided types for the content API, but couldn't find the equivalent for the admin API.

It would be great if TypeScript types could be provided for the Admin API client. More and more apps are being developed using TypeScript, as it makes for a much nicer developer experience. Is this something already on the product roadmap?

Contributor guide

Open the contributing guide

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.

Research direction

Start by locating the Admin API client and compare its public surface with the community-provided types for the Content API. Determine the intended Admin API type coverage and how it should be maintained; done means the client has documented TypeScript support that matches its exposed API.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, typescript
Domain
api
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.