beckn / beckn/generic-client-layer

Please add API documentation for the project

Open
#88 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
TypeScript
Stars
4
Forks
3
PR merge metrics
No merged PRs in 30d

Description

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

Contributor guide

No contributing guide indexed for this repository

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.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.