Skip to content

New endpoint to list kata #2302

Open
Open
@GeorgeWL

Description

@GeorgeWL

Use Case

I'd love to create a web app that goes "Give me Random Katas", with a little set of options.

But when I looked through the API docs, the GET endpoints for challenges seemed rather limited.

I would like to be able to do a GET request with the format of /challenges

Proposed Solution

Create a /challenges endpoint, which returns an array of Challenges, sorted by newest by default.

With some optional Param queries, with default values

Sample:
GET /challenges

[
  {challenge0},
  {challenge1},
  {challenge2}
]

some ideas for optional url params:

Param Type Default Value Description
count number 10 set how many results the array should return
rank number undefined only return results of a specific ranking, else return any
minSolutions number|undefined undefined only return results which have a minimum of minSolution, else any
collection string|undefined undefined only return solutions within a specified collection, else any
sortBy 'newest'|'ranking' 'oldest' 'stars' undefined 'newest' set which order the array should return in

┆Issue is synchronized with this Clickup by Unito

Metadata

Metadata

Assignees

No one assigned

    Labels

    area/apikind/feature-requestUse this when the request includes specific feature. Otherwise, use generic enhancement.

    Type

    No type

    Projects

    Status

    Done

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions