microsoft / microsoft/OpenAPI.NET.OData

Missing Consistency Level header parameters for paths that have path parameters appearing as last segment immediately after a navigation property

Open
#556 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C#
Stars
240
Forks
70
Avg merge
7h 59m
Merged PRs (30d)
13

Description

For example, this path /servicePrincipals/{servicePrincipal-id}/appRoleAssignments contains consistency level header parameter as shown in the image below while this one /servicePrincipals/{servicePrincipal-id}/appRoleAssignments/{appRoleAssignment-id} is missing.
image
Annotations have also been added to include the header and it seems like the last segment if it is a path parameter after a navigation property is not recognized.
image

Contributor guide

Open the contributing guide

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

Reproduce the generated OpenAPI output for the two servicePrincipals/appRoleAssignments paths and inspect how annotations identify the consistency-level header. Trace the handling of a path parameter immediately after a navigation property. Done means the header is present on the parameterized final-segment path as well as the collection path, with regression coverage for both examples.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp, openapi
Domain
api, tooling
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.