Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Please add API documentation for the project

Open
  • Is something wrong?
#88 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
openapi, postman, typescript
Domain
api, documentation

Research direction

Start with the existing doc/swagger directory and the Postman file to identify the API exposed by the Generic Client Layer. Document the Search and Select request formats and the other exposed requests, with enough detail for a client UI or server to use them without relying on Postman; done means the API is described in doc/swagger.

Written by the indexing model from the issue text.

Description

documentation

I could not find any document that describes how a client UI/ server can use the GCL. i.e. what is the format of the Search request, Select request etc. There is postman file, but tedious if all you want is to understand the API.
Please add doc/swagger documentation for the API exposed by Generic Client Layer

Dominant language
TypeScript
Stars
4
Forks
3
No merged PRs in 30d

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

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 beckn/generic-client-layer

All issues in beckn/generic-client-layer

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.