OData / OData/odataorg.github.io

Create separate specification for OData Query Options

Open
#111 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
73
Forks
106
PR merge metrics
No merged PRs in 30d

Description

I've seen this pop up from time to time, but especially with GraphQL's popularity of late, the need for a way to expand resources beyond their original shape and size to accommodate more use-cases in various clients, is becoming ever more apparent.

Developers are starting to understand that it's impossible to design a resource in a way that effectively can serve multiple widely different needs, which make them search for a query language of some sort to tweak the shape of the resources.

While GraphQL and Falcor are two ways of doing this, I'm personally a fan of OData Query Options as a standardized way to query, filter, and expand resources, to name a few of OData's abilities.

However, I believe it to be a hampering "feature" for these Query Options to reside within the much larger protocol of OData, which is so big and complex that no one can be expected to implement all of it just to be able to use the $expand keyword in the URLs of their API.

So, I propose that chapter 5 of the OData specification be extracted from the OData protocol and created as its own, independent specification that can be implemented isolated from the greater OData protocol. I think it would benefit the web community greatly to see more interoperable OData query implementations.

LinqToQuerystring proves that there's a will and a way to use OData Query Options in isolation, so I hope you will consider this for a future revision of OData.

Thanks!

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 by reviewing chapter 5 of the OData specification and the linked OData Query Options reference. The issue names no repository files or tests, so first determine how specifications are maintained in this repository. Done would be a separately maintainable specification for the query options described in the proposal.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.