URL built by the SDK doesn't match with the URL expected by the service

[zengin]

Original HTTP snippet from the docs

GET https://graph.microsoft.com/v1.0/identityGovernance/accessReviews/definitions/filterByCurrentUser(on='reviewer')

C# Snippet:

GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var filterByCurrentUser = await graphClient.IdentityGovernance.AccessReviews.Definitions
	.FilterByCurrentUser(AccessReviewScheduleDefinitionFilterByCurrentUserOptions.Reviewer)
	.Request()
	.GetAsync();

When executed, the URL becomes:

https://graph.microsoft.com/v1.0/identityGovernance/accessReviews/definitions/microsoft.graph.filterByCurrentUser(on=Reviewer)

And the service returns the following error:

{
    "error": {
        "code": "BadRequest",
        "message": "The parameter 'on=Reviewer' is not in scope.",
        "innerError": {
            "date": "2021-10-22T00:33:40",
            "request-id": "d6262272-9b0e-455e-a081-726be78e7b60",
            "client-request-id": "2f0a0d8a-626f-f9ec-f543-98f36c191681"
        }
    }
}

Following two changes don't make a difference:

• Fully qualified function name microsoft.graph.filterByCurrentUser vs filterByCurrentUser
• PascalCase vs camelCase i.e. Reviewer vs reviewer.

Service works fine if the quotes are present.

@andrueastman @MIchaelMainer, I haven't had a chance to dig into the OData spec for this. Do you know whether

1. the URL we generate should be allowed by the spec and service needs to be fixed or
2. should we fix our URL builder in the SDK?

cc: @darrelmiller @baywet

[zengin]

Here is another example where quoted function parameter value works but SDK doesn't put the quotes in the URL:
https://docs.microsoft.com/en-us/graph/api/outlookuser-supportedtimezones?view=graph-rest-1.0&amp%3Btabs=csharp&tabs=http#request-2

succeeds:

https://graph.microsoft.com/v1.0/me/outlook/microsoft.graph.supportedTimeZones(timeZoneStandard='Iana')

fails:

https://graph.microsoft.com/v1.0/me/outlook/microsoft.graph.supportedTimeZones(timeZoneStandard=Iana)

[andrueastman]

Thanks for raising this @zengin,
I'm not sure if this is allowed by the spec. If it isn't, it looks like we will need to update this to allow extra types.

[baywet]

reviewing from the kiota checklist.

I'm not sure which one is faulty here: the conversion process doesn't add the quotes either for the filterByCurrentUser method, which results in not having them in the url template

However, when the parameter is a string, it does add them (e.g. allowedCalendarSharingRoles). I believe the issue is actually on the service side here, because the on parameter is a complex type, the service should NOT expect quotes, but it seems to be expecting them.

[zengin]

@baywet, on parameter is an enum type, not a complex type.

<Function Name="filterByCurrentUser" IsBound="true">
  <Parameter Name="bindingParameter" Type="Collection(graph.accessReviewScheduleDefinition)"/>
  <Parameter Name="on" Type="graph.accessReviewScheduleDefinitionFilterByCurrentUserOptions" Nullable="false"/>
  <ReturnType Type="Collection(graph.accessReviewScheduleDefinition)"/>
</Function>

<EnumType Name="accessReviewScheduleDefinitionFilterByCurrentUserOptions">
  <Member Name="reviewer" Value="1"/>
  <Member Name="unknownFutureValue" Value="2"/>
</EnumType>

And according to the spec, it seems that we need quotes around the type name but not the namespace:
http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part2-url-conventions.html#sec_PrimitiveLiterals

ColorEnumValue eq Sales.Pattern'Yellow',
ColorEnumValue eq 'Yellow',

Similarly timeZoneStandard is also an EnumType.

@andrueastman mentioned a piece of code from the Core library to put the quotes around, but @baywet pointed to a full URL template within kiota generated code. I know that the latter was Go, but I am wondering where this issue should be fixed once kiota becomes the generator for C#?

[baywet]

Effectively the C# SDK will have a very similar "shape" to the Go SDK once it switches to Kiota (url templates and all).
Assuming the template is correct (no defect in the conversion process), and the service is doing what it's supposed to do (implementation matches odata spec) it should work.
As it stands now, it looks like the template is missing the quotes, and the service is doing the right thing. So it's probably an issue with the conversion process.
If you agree, let's crate an issue in the odata/openapi repo.

[zengin]

agreed, opened an issue here: microsoft/OpenAPI.NET.OData#140

[andrueastman]

Closing this one for now.
microsoft/OpenAPI.NET.OData#140 has been resolved and the correct url template with single quotes is propagated to the SDK.

Ref shown below.

msgraph-sdk-dotnet/src/Microsoft.Graph/Generated/IdentityGovernance/AccessReviews/Definitions/FilterByCurrentUserWithOn/FilterByCurrentUserWithOnRequestBuilder.cs

Line 27 in de95783

UrlTemplate = "{+baseurl}/identityGovernance/accessReviews/definitions/microsoft.graph.filterByCurrentUser(on='{on}')";