OData / OData/WebApi

Streams: Please provide basic documentation under https://docs.microsoft.com/en-us/odata/

Open
#1,925 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs
Dominant language
C#
Stars
864
Forks
467
PR merge metrics
No merged PRs in 30d

Description

Once upon a time, https://docs.microsoft.com/en-us/odata/ was different and it had information about streams and other advanced ideas.

Then it got reworked.

Today the term"stream" does not show up at all in the table of contents and an hour of searching provides zero starting information about how to implement stream properties in odata these days.

This is definitely a lack. I just spent a good time of the day trying to find documentation - which is not made easy because of older API's using different approaches, which makes google a little hard.

So, please add stream documentation back to the documentation page.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the current OData documentation at the linked Microsoft Docs URL and look for the appropriate location for stream-property guidance. Done means the documentation explains basic stream implementation and stream-related content is discoverable from the table of contents; no repository file or test is identified in the issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.