streamaserver/streama

API Documentation

Open

#239 opened on Jan 12, 2017

View on GitHub
 (4 comments) (3 reactions) (0 assignees)JavaScript (9,565 stars) (977 forks)batch import
EnhancementHelp wanted

Description

Is there any kind of documentation for the API? Anything in doc, blueprint, swagger, etc would be greatly appreciated. :)

Contributor guide

Tech stack
None
Domain
apidocumentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Examine the repository's documentation files and the project website at https://docs.streama project.com/ to see if API documentation exists. Check the comments in the issue for any pointers or answers provided by other community members. If no documentation exists, consider creating a basic overview of the API endpoints based on the codebase, focusing on common use cases.
API Documentation · streamaserver/streama#239 | Good First Issue