Kong / Kong/developer.konghq.com

Status API needs a better description

Open
#1,666 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug-bash internal product:gateway
Dominant language
Ruby
Stars
28
Forks
121
Avg merge
1d 4h
Merged PRs (30d)
313

Description

This is confusing needs a better description maybe a differentiation frmo the Admin API stuff and explanation of the ports.

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 Status API documentation and compare it with the Admin API documentation. Clarify how the two differ and explain the relevant ports; the work is done when the Status API description is no longer confusing.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.