How to add a Swagger summary to ServiceStack.GetAccessToken

[Sukram]

I’am trying to add a swagger summary to the ServiceStack.GetAccessToken Service with:

GetRouteAttributes(Type.GetType("ServiceStack.GetAccessToken,ServiceStack.Client"))
  .Each(r => {
    r.Summary = "Refresh an expired token with refreshToken endpoint to get a new JSON Webokens(JWT)";
  });

but nothing happens? How can I do that?

Probably there is no RouteAttribute defined for GetAccessToken? Because with:

.AddAttributes(new RouteAttribute("/access-token") { 
    Summary = "Refresh an expired token with refreshToken endpoint to get a new JSON Web Tokens(JWT)" 
});

I will get the rout twice…

[mythz]

Please don’t try to re-register or otherwise interfere with the registration of internal services, they’re not overridable. Any customizations should be done using the filters in OpenApiFeature which I’ve provided an example of in one of your earlier questions:

How to exclude HTTP methods from Swagger, Metadata and OpenAPI

The HTTP methods are limited by your Route definition, e.g: [Route("/myservice", "GET POST")] But this isn’t possible to annotate for built-in Services which are unspecified and default to allow “ANY” method. So you’ll basically need to modify the Open API schema by removing the HTTP methods you don’t want on selected paths, e.g: Plugins.Add(new OpenApiFeature { ApiDeclarationFilter = api => { foreach (var path in new[] {api.Paths["/auth"], api.Paths["/auth/{provider}"]}) …

e.g.

Plugins.Add(new OpenApiFeature
{
    ApiDeclarationFilter = api =>
    {
        api.Paths["/access-token"].Get.Summary = "My GetAccessToken Summary";
    },
});

[Sukram]

Yes but I have already added a “/access-token” description and summary for my OpenAPI Schema but we also use the ServiceStack Swagger UI which uses OpenAPI 1.2 (“swaggerVersion”:“1.2”) means the SStack Swagger UI will get the meta information by the /resources enpoint and I need also the summary in the Swagger UI?

Or is there a new ServiceStack.Api.Swagger Plugin package which uses OpenAPI 2.0?

[mythz]

The Swagger UI Plugin that implements Open API 2.0 is OpenApiFeature.

SwaggerApiFeature implements Swagger 1.2. It also has filters available but follows a different schema following the Swagger 1.2 spec.

[Sukram]

Ok thanks, now I have removed the ServiceStack SwaggerApiFeature from my project …I’m now using the official swagger-ui from https://github.com/swagger-api/swagger-ui that implements Open API 2.0.

[mythz]

The Open API Feature implements Open API 2.0 and embeds a version of Swagger UI which it uses to render the UI at /swagger-ui.

[Sukram]

oh, I see!..Thank you…