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

File formats for RADL specification #1

Open
jonathanrobie opened this issue May 9, 2016 · 0 comments
Open

File formats for RADL specification #1

jonathanrobie opened this issue May 9, 2016 · 0 comments

Comments

@jonathanrobie
Copy link
Member

jonathanrobie commented May 9, 2016

We would like to simplify the file formats to make them easier for web clients to read. One idea initially proposed by Satyapal Reddy: extend the OpenAPI format to add missing information. We could do this using Open API vendor extensions. A JSON format is really useful for this kind of machine-readable representation.

We also need to support user-written documentation that might contain tables and other complex formatting, e.g. the documention we provide for authentication. For this, HTML, XML, and Markdown are better choices.

For the final documentation provided to the end user, we will use HTML5.

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

1 participant