microtechcloudsolutions / microtechcloudsolutions/sms-gateway

swagger api documentation

Open
#7 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

good first issue help wanted
Dominant language
JavaScript
Stars
5
Forks
1
PR merge metrics
No merged PRs in 30d

Description

Document Service APIs.
The writer will use swagger so as to standardize the documentation across services

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

Start by locating the Service API entry points and checking how Swagger is used across the services. Document the service APIs in Swagger so the documentation is standardized across services; completion means the relevant APIs are covered.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
api, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
32/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.