OData / OData/odataorg.github.io

OData Question - relating to searching using PII/PHI data

Open
#387 0 comments 0 reactions 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

OData Gurus,
I've been a consumer of OData for some time now. But I'm jumping into developing an OData API, but one question I have is the use of PII/PHI data in the query string. I would like to be able to do the same functionality with $filter,$select, $expand, etc on the GET /{resource} against the POST /{resource}/.search

By moving from GET to POST, it removes it from the middleware processes that may log the Query String.

Here is a curl command that gives an example of the concept.

curl -X POST "http://localhost:5292/api/v1/memberservice/members/.search" -H "Content-Type: application/x-www-form-urlencoded" -d "$filter=SSN eq '123456789'&$select=ID,FirstName,LastName" -v

My Questions:
Does the OData team have recommendations on approach to accomplishing this? Ie. Should use content-type of {?}, Should use endpoint named /{resource}/$query, etc
Does the Dotnet Core CSharp library support this out of the box? If so, is there documentation on how to set it up — this is where I'm today and having trouble!
I have the GET /{resource} endpoint working! But trying to convert it to the POST seems harder than I'd expect.

Any help anyone can provide, I would greatly appreciate it.

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 the working GET /{resource} endpoint and the .NET Core C# library documentation mentioned in the issue. Determine whether POST-based OData queries are supported and what endpoint and content type are documented. Done means providing a settled recommendation and setup guidance for the requested filtering, selection, and expansion behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
api, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.