Documentation

I love OData and the AspNetCore implementation is so powerful. I'd like to recommend the use of this project to enterprise clients but the lack of documentation makes this an almost impossible learning curve (despite the fact that OData is actually quite simple).

I recently went through this course on Pluralsight and wanted to put together a check-list of things that should be documented somewhere.

I would love to help out with PRs on some of these if you guys are open to having someone help out. Even just as PRs to the docs folder would be helpful for people searching for documentation. If the documentation for some of these things exists somewhere already (i.e., in a blog post), I think some amount of effort should be made to:

1. Move that documentation out of a blog post to here in order to keep it centralized
2. Ensure it's updated to reflect v8

Documentation Needs

• Routing Overview (#377)
• Attribute-based Routing
• Convention-based Routing
• Defining an Entity Data Model (EDM)
• Defining Create/Read/Update/Delete methods for an entity set
• Working with properties and raw property values
• Working with navigation properties
• Querying data (should cover EnableQueryAttribute, ODataQueryOptions, and global query options)
• Working with containment navigation
• Working with Functions
• Working with Actions
• Working with Singletons
• Working with Derived Types
• Working with Open Types
• Working with Batch Processing
• Configuring OpenApi/Swagger
• Other OData Learning - I think we should assume people that come here are familiar with how OData works but if they are not we should direct them to some basic documentation on how OData works. I feel like this is already done well enough elsewhere we shouldn't need to re-document it here.
• Setting up authentication/authorization information in your Edm
• Use of the /$odata service for route troubleshooting
• Use of the /$query middleware

Related Requests

#332
#23
#63
#66