Feature - add operation filters for Shared Access Key and Certificate authentications in OpenAPI docs

[stijnmoreels]

Making our two authentication mechanisms available on operation level in the OpenAPI docs by providing two custom implemented IOperationFilter instances.

Closes #170
Closes #169

[arcus-automation]

A new preview package for Arcus.WebApi.All is available on MyGet.

You can pull it locally via the CLI:

PM> Install-Package Arcus.WebApi.All -Version 20200714.0.0-PR-172 -Source https://www.myget.org/F/arcus/api/v3/index.json

[arcus-automation]

A new preview package for Arcus.WebApi.All is available on MyGet.

You can pull it locally via the CLI:

PM> Install-Package Arcus.WebApi.All -Version 20200720.0.0-PR-172 -Source https://www.myget.org/F/arcus/api/v3/index.json

[arcus-automation]

A new preview package for Arcus.WebApi.All is available on MyGet.

You can pull it locally via the CLI:

PM> Install-Package Arcus.WebApi.All -Version 20200727.0.0-PR-172 -Source https://www.myget.org/F/arcus/api/v3/index.json

[tomkerkhove]

LGTM - Just adding a concern with respect to the config side of things for the security definition name.

For example:

swaggerGenerationOptions.OperationFilter<CustomSecurityRequirementsOperationFilter<SharedAccessKeyAuthenticationAttribute>>(ApiKeySecurityDefinitionId);


swaggerGenerationOptions.AddSecurityDefinition(ApiKeySecurityDefinitionId, new OpenApiSecurityScheme
{
    Name = "X-API-Key",
    Type = SecuritySchemeType.ApiKey,
    In = ParameterLocation.Header
});

[tomkerkhove]

Are we assuming people use sharedaccesskey & X-API-Key or is this configurable?

[stijnmoreels]

Made it configurabe.

[tomkerkhove]

Same here, are we assuming certificate or is it configurable? What happens if I use a different name?

[stijnmoreels]

Made it configurable.

[tomkerkhove]

This is hardcoded but must match what was defined as a security requirement, we should make this configurable

[stijnmoreels]

Made it configurable. Thanks!

[tomkerkhove]

This is hardcoded but must match what was defined as a security requirement, we should make this configurable

[stijnmoreels]

Made it configurable. Thanks!

[stijnmoreels]

LGTM - Just adding a concern with respect to the config side of things for the security definition name.

For example:

swaggerGenerationOptions.OperationFilter<CustomSecurityRequirementsOperationFilter<SharedAccessKeyAuthenticationAttribute>>(ApiKeySecurityDefinitionId);


swaggerGenerationOptions.AddSecurityDefinition(ApiKeySecurityDefinitionId, new OpenApiSecurityScheme
{
    Name = "X-API-Key",
    Type = SecuritySchemeType.ApiKey,
    In = ParameterLocation.Header
});

Hmm, that isn't the case with the OAuth operation filter we have. Is it bc we don't have these shared access key and certificate operation filters by default in the security scheme?

[tomkerkhove]

I think we should go that route because you can assign any name to the security scheme depending of what you want. We can make it optional and use those as defaults, but allow them to specify something else if they want to maybe?

[stijnmoreels]

I think we should go that route because you can assign any name to the security scheme depending of what you want. We can make it optional and use those as defaults, but allow them to specify something else if they want to maybe?

Yes, that seems appropriate.

[arcus-automation]

A new preview package for Arcus.WebApi.All is available on MyGet.

You can pull it locally via the CLI:

PM> Install-Package Arcus.WebApi.All -Version 20200827.0.0-PR-172 -Source https://www.myget.org/F/arcus/api/v3/index.json