Comments (3)
I would be interested in helping, and documentation feels like my speed. Would there be a good place for a newbie to start?
from peertube.
Hi @teusday, glad to hear that.
The goal of these documentations is to help newcommers so IMHO it would be difficult for you to begin with this part.
But I think that documenting the REST API would be feasible. The REST API routes are defined in the controllers/routes directory. The validators middlewares are used to check the user parameters validity of these routes.
I suggest to use http://apidocjs.com because I like the idea that the documentation is in the same place than the code (to don't forget to update it).
from peertube.
API REST documentation is done, see https://github.com/Chocobozzz/PeerTube#api-rest-documentation
It is not perfect but it's a good place to start thanks to the work of @DimitriGilbert. If you interesting in helping to improve the api documentation, I created a special section in the CONTRIBUTING guide.
from peertube.
Related Issues (20)
- Playing video on remote instance is sometime broken ("Safe mode validation error": AP regression?) HOT 5
- Error log when a plugin retrieves settings
- Plugins: missing argument for filter:activity-pub.activity.context.build.result
- filter for scheduled videos in the video library
- Plugins issue after migrating to new server HOT 2
- cannot make a documentation fix HOT 3
- Cannot update GeoIP database for cities HOT 1
- Instance is getting slow upon failed geoip db update HOT 2
- Slow query to select videos HOT 4
- Admin Portal Opt-Out of Username Case Sensitivity HOT 2
- Add field for "origin"
- SQL error upon updating actor HOT 2
- Slow query upon listing playlists HOT 2
- Add a button to translate comments
- Seeding HOT 1
- Provide a federation link HOT 4
- number of views HOT 1
- Slow query upon updating user video history HOT 3
- Add scheduler to delete old notifications HOT 6
- Explicitly don't cache HTML files
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from peertube.