Adding API documentation for SI
Open
Nobody has claimed this yet.
API-M-4.0.0
CEXP
Component/ProductAPIs
help wanted
Priority/High
Severity/Major
Type/Improvement
- Dominant language
- CSS
- Stars
- 99
- Forks
- 708
- Avg merge
- 1d 7h
- Merged PRs (30d)
- 22
Description
API docs similar to [1] should be generated for the internal REST API of the Streaming Integrator.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the linked Service Catalog API documentation to identify the expected structure and level of detail. Then locate the Streaming Integrator internal REST API sources and determine the complete endpoint scope; the work is done when equivalent API documentation has been generated for those endpoints.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100