- adds support for raw URLs in request builders

[baywet]

fixes #410

Generation diff

microsoft/kiota-samples#225

Todo

• replicate in dotnet
• replicate in java
• replicate in go
• replicate in ruby
• update unit tests
• bump abstractions versions

[baywet]

Todo doc comment new method request info

[nikithauc]

Can you please give some examples of isRawUrl will be used? I checked the generated files the meaning of isRawURL is 'not clear.

[andrueastman]

Is there value in adding the query parameter in the event that the value is absent/null? (I think this applies to all the languages)

[baywet]

I thought this explanation was the best 🤣

[andrueastman]

🤣 🤣 🤣
If we can, we should probably remember to upvote that answer

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
2 Code Smells

80.9% Coverage
0.0% Duplication

[baywet]

@nikithauc

The generated code for the fluent API will generate new RequestBuilder(currentPath, httpCore, false).
Somebody using the request builder with a raw URL (next link, delta link, ...) will end up writing new RequestBuilder(rawURl, httpCore) where the default value of the parameter is true.

That parameter is assigned to a property on the request builder which is then is passed to the requestInfo.setUri method (generate request method).

This parameter is used in the setUri method to know whether we should:

1. Append the current path and the segment to use as a URI
2. Parse the current path (which is the complete URL in this case) to get the query parameters into the dedicated dictionary, and use the rest as the uri.

Basically of of that is done to avoid appending a path segment when not needed and avoid "loosing" any query parameter that might already be present.
I hope this clarifies things?

[nikithauc]

I got the purpose of doing this.

I asked for examples on how the code is used because: isRawURL and the documentation Whether the current path is a raw URL is confusing. The naming does not state the purpose at the first glance on the code. isRawURL expects the user to know that the implementation details currentPath gets appended.

Can you please provide a code snippet when isRawURL is true and isRawURL is false?

Please provide simple code snippets of the request builders with the new changes in the PR description as it gives more clarity.

[baywet]

const page1 = await client.me.messages.get(); //raw url is false
const page2 = await (new MessagesRequestBuilder(page1.nextLink, httpCore)).get(); //is raw url is true

Would it be better if the description was changed to Whether the current path is a fully qualified URL. When true, any query parameter passed will be kept for the request and the current path of the request builder won't be appended. ?

[nikithauc]

I would think of a different name instead of isRawURL param.

[baywet]

Suggestions are welcome but what do you think of "IsFullyQualifiedUrl"?