Documentation

[forfront]

Short summary (3-5 sentences) describing the issue.

It is not clear how you could perform the following:

1. Exclude some Controllers and or Actions from the generated output.
   Typically a developer might want to create an attribute that is used to identify which controllers and actions are to be ignored from the generated output. An example might be a controller/action that is role permissioned specifically for internal use and therefore has no use for a 3rd party consumer.
2. If you have a WebAPI that has both attribute routing and OData requests, only the OData requests appear to be picked up. Our API exposes reads to all data over OData, but writes as specific coded endpoints as this avoids the need for consumers to make multiple requests to perform a single business function that touches many entities.
3. Does it support versioning? (with this turned on, I received validation errors, with this off, it works)

Errors when using:

NuGet: Microsoft.Web.Http.Versioning

        var oDataRoute = config.MapVersionedODataRoute(
            routeName: "odata",
            routePrefix: null,
            model: EdmModelBuilder.GetEdmModel(),
            apiVersion: ApiVersion.Default,
            pathHandler: new DefaultODataPathHandler(),
            routingConventions: conventions,
            batchHandler: new DefaultODataBatchHandler(GlobalConfiguration.DefaultServer));

4. Is there a way to associate a description with a controller action exposed in the yaml/json?
   i.e. could this be defined as an attribute, or if multiple languages are supported an attribute that reads from a resource file
5. How can you extend the documentation to cater for an endpoint that imports a file and includes some action parameters for example.
6. How do you implement the ability for the user to specify an API token which grants them permission to test out REST API calls?
   e.g. Our API expects an Authorization header like the following:
   Authorization: Token [guid]

Assemblies affected

Which assemblies and versions are known to be affected?

Microsoft.OpenApi v1.1.3
Microsoft.OpenApi.OData v1.0.0-beta8
Microsoft.OData.Edm v7.6.0
Microsoft.OData.Core v7.6.0
Microsoft.AspNet.OData v6.0.0
Microsoft.AspNet.OData.Versioning v2.1.0
Microsoft.AspNet.WebApi v5.2.7
Microsoft.AspNet.WebApi.Client v5.2.7

Steps to reproduce

The simplest set of steps to reproduce the issue. If possible, reference a commit that demonstrates the issue.

Documentation and usage examples lacking

Expected result

What would happen if there wasn't a bug.

Actual result

What is actually happening.

Additional detail

*Optional, details of the root cause if known.

[irvinesunday]

@forfront my apologies for the long overdue response here. Not really sure if this issue is still valid due to the long lapse of time, however, the issues you have described don't seem to be related to the functionality of this specific library, Microsoft.OpenApi.OData. Did you have any specific issue with your converted CSDL to OpenAPI document?

[irvinesunday]

@forfront closing this issue. Feel free to re-open if you feel the need to