Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

specification format #8

Open
ppwfx opened this issue Jun 6, 2018 · 2 comments
Open

specification format #8

ppwfx opened this issue Jun 6, 2018 · 2 comments

Comments

@ppwfx
Copy link
Member

ppwfx commented Jun 6, 2018

Im asking myself in what format the specification should be delivered.

Will it be something like a rfc?
https://tools.ietf.org/html/rfc7033

Could it be something like swagger?
Would be quite nice, as it allows to generate all the sdks
https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/api/openapi.yaml

@yookoala
Copy link

yookoala commented Jun 6, 2018

I think it makes more sense to have a format like RFC or W3C document like, again, ActivityPub. Swagger is great at describing RESTful API endpoints. But it does not describe the underlying logistics or workflow, which are essential for a protocol specification.

@bill-auger
Copy link
Member

the mailing list is now fully functional - a thread has been started on the mailing list to continue the discussion in this issue - for those who are subscribed to the mailing list, check your email for the thread titled "specification format"; and reply to it to continue the discussion begun on this issue

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants