SkywardApps / popcorn

Popcorn is a .Net Middleware for your RESTful API that allows your consumers to request exactly as much or as little as they need, with no effort from you.
https://skywardapps.github.io/popcorn/
MIT License
59 stars 19 forks source link

[InternalOnly] Documentation #37

Closed alexbarbato closed 6 years ago

alexbarbato commented 6 years ago

Possible Solution

In PR #35 / Issue #34 we added the InternalOnly attribute. We also want to include a tutorial on how this feature can be used, as well as maybe adding a bit of inline documentation.

Possible Implementation

  1. Add a tutorial on how to use the InternalOnly attribute
  2. Add an example to the example project
  3. We may also want to update the usage of InternalOnlyViolationException to include the name of the method/class/property that was marked InternalOnly in the message returned with the exception
96andrei commented 6 years ago

I'll take a look at this later today.

alexbarbato commented 6 years ago

Awesome! Thanks man