TryGhost / TryGhost/gctools

Add check to validate API urls

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

Nobody has claimed this yet.

enhancement
Dominant language
JavaScript
Stars
51
Forks
17
Avg merge
12h 21m
Merged PRs (30d)
38

Description

The Ghost Admin API client needs the base URL for a site. If a path like example.ghost.io/ghost/api/admin is added, the tools fail.

A validation step should be added in both the interactive prompt and CLI to ensure a supplied URL is valid before continuing.

Contributor guide

No contributing guide indexed for this repository

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

Locate the interactive prompt and CLI entry points that accept the Ghost Admin API base URL, then trace how the supplied value is passed before a request runs. Add validation before either flow continues, and verify that a complete site URL is accepted while a path such as example.ghost.io/ghost/api/admin is rejected.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
api, cli
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.