microsoftdocs / odata-docs Goto Github PK

https://github.com/MicrosoftDocs/OData-docs/blob/master/Odata-docs/webapi/first-odata-api.md

All of the links starting with https://docs.microsoft.com/en-us/odata/client/ are showing a 404 error.

For example, https://docs.microsoft.com/en-us/odata/client/getting-started.

I am querying an endpoint this way

 https://apiEnpoint?$filter=Time ge 2023-01-22T23:00:00.0000000Z and Time le 2023-01-29T03:44:47.4260000Z

It works fine on 8.0.0-preview3 but not on 8.0.12.

1. What am I doing wrong?
2. Can you guys please provide a better getting-started documentation for querying with dates?

Thank you.

OData should be listed here along with the other Microsoft products: https://docs.microsoft.com/en-us/documentation/
@mikepizzo might be worth looking into. :)

currently under OData Client documents, there is no public document talking about how to handle exceptions, what exceptions to expect etc.

Suggest to add an public document for this.

On the page https://docs.microsoft.com/en-us/odata/webapi/first-odata-api (md file: https://github.com/MicrosoftDocs/OData-docs/blob/main/Odata-docs/webapi/first-odata-api.md), The section titled Register OData has these lines of code:

    // requires using Microsoft.AspNet.OData.Extensions;
    services.AddOData();

The using statement looks like it should be Microsoft.AspNetCore.OData.Extensions instead, and there is no extension method for IServiceCollection called AddOData().

I'm running a newly-created .NET 6 web API following the Todo example linked in the doc page, and I installed Microsoft.AspNetCore.OData version 8.0.11.

in Use HttpClient in OData Client, it talked about how to use HttpClient in OData Client, and includes lots of sample code to make that work. With the addtion to ODataClient extensions (https://github.com/OData/Extensions/), there is new way to use HttpClient in ODataClient, very similar to IHttpClientFactory experience and would work out of box.

The issues is to add public document for that out of box usage and link this to that page.
@xuzhg FYI.

Microsoft has been working to remove potentially oppressive terminology from their processes. Please follow the directions here to update the branch: https://github.com/github/renaming. Thanks!

Move dotnet/AspNetCore.Docs#12150 to this repo. Decide what is worth keeping.
@Rick-Anderson will do the migration.

Internal review URL
OData Expand

All code samples in the OData Client docs appear to use auto-generated proxy classes for the TripPin service. I was wondering why there are no examples showing how to use the barebones OData client library directly to interact with an existing OData service without using a tool or extension to pre-generate code. Is this not a valid or intended use case?

In 4.3.6 of the URL Conventions for OData it seems to say we should be able to do something like https://host/service/Orders/1/Items/2 to GET/PUT/POST/DELETE the item with ID 2 tied to Orders with ID 1.

https://docs.oasis-open.org/odata/odata/v4.01/os/part2-url-conventions/odata-v4.01-os-part2-url-conventions.html#sec_KeyasSegmentConvention

It seems this was possible in prior OData versions but I don't see it in the OData 8 docs. Is this something possible to do?

The problem

The OData Client docs are not self-contained: the first page someone sees is the "Basic CRUD operations" section, which begins with a code snippet that makes a query to the trip pin service using a generated proxy class. If this is a new user who wants to learn how to use the OData client, at this point they would be confused: What is DefaultContainer and where does it come from? Which namespaces do I import? What is context.People? How do you even install the library? How were the proxy clients generated? How would I adapt the code for my own service? etc.

The docs seem to assume that the user has prior experience with the Odata client library, code generation tools and TripPin service. Or it's assumed that the reader can find this information elsewhere, but in that case, there are no links provided either.

Proposed solution

I propose adding a "Getting started" section that introduces the OData client library and takes the user through installing the library and/or the connected service code generator and how to use it, and a basic overview of the classes generated and how to use them. This section should contain enough background information for the user to follow the remainder of the docs.

interesting enough that the documentation result do show the same behaviour? Is this a bug, no one have concern the result format change just because of using $select

https://github.com/MicrosoftDocs/OData-docs/blob/master/Odata-docs/webapi/first-odata-api.md#select

The link in the article is not working

Working link: https://docs.microsoft.com/en-us/dotnet/api/overview/odata-dotnet/

Please review Sample: Build web APIs with OData support using ASP.NET Core and let me know if you'd like me to migrate that tutorial to this repo.

Outline of proposed work

• Create AspnetCore folder in OData-docs/Odata-docs/webapi/
• Move the sample/tutorial to the AspnetCore folder.
• Add ASP.NET Core 3.0 version.
• Add tutorial to the TOC

Does your repo support importing snippets? If not, would you like me to enable that?
Does your repo support versions? If not, would you like me to enable that.

::: moniker range=">= aspnetcore-3.0"
//  3.0 version here
::: moniker-end

::: moniker range="< aspnetcore-3.0"
// 2.2 version here
::: moniker-end

In this page, https://docs.microsoft.com/en-us/odata/webapi/nested-paths-routing, the link presented in the article points to a 404.

The correct link should probably be this one:

• https://docs.microsoft.com/en-us/odata/webapi/automatic-nested-paths-with-enable-nested-paths