streamaserver/streama

API Documentation

Open

#239 geöffnet am 12. Jan. 2017

Auf GitHub ansehen
 (4 Kommentare) (3 Reaktionen) (0 zugewiesene Personen)JavaScript (9.565 Stars) (977 Forks)batch import
EnhancementHelp wanted

Beschreibung

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

Contributor Guide

Tech Stack
Keine
Domain
apidocumentation
Issue Type
documentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
under 1 hour
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
Keine
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60
Research-Richtung
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.