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

Document our AST shape and API #1103

Open
char0n opened this issue Jan 24, 2022 · 0 comments
Open

Document our AST shape and API #1103

char0n opened this issue Jan 24, 2022 · 0 comments
Labels
ApiDOM documentation Improvements or additions to documentation enhancement New feature or request

Comments

@char0n
Copy link
Member

char0n commented Jan 24, 2022

Full AST documentation needs to provided. Before we have one, please read below:


Our AST is based on minim which is an implementation of the Refract Specification. We take it's types and extend them. Before we have proper AST documentation, the minim documentation is a good place to look at to understand our AST.

For example OpenAPI Info Object is represented as an extensions to minim Object Element with additional getters and setters.

@char0n char0n added documentation Improvements or additions to documentation enhancement New feature or request ApiDOM labels Jan 24, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ApiDOM documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant