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

Adding Descriptions to Nodes for Documentation Purposes #6

Closed
wants to merge 3 commits into from

Conversation

thestillheron
Copy link

My team and I are using a deep analysis of our Structr definitions to automatically generate documentation for our API.

I've been wanting to add a "description" property to the Structr nodes for a while, so that we can provide some semantic documentation as well, in a similar way.

This is also handy because we can use it to provide more meaningful error messages if a value in the client's payload isn't right for some reason.

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

Successfully merging this pull request may close these issues.

None yet

1 participant