Get methods doesn't show <example> documentation in Azure Api Management developer portal

dcanamares 21 Reputation points
2020-08-27T11:16:26.5+00:00

I have an API with Swashbuckle 5.5.1, and GET methods doesn't show documentation properly at Azure Api Managment developer portal, but the documentation is showed correctly at swagger portal. For example.This code only shows documentation at Swagger portal:

/// <summary>
/// The total amount of the invoices.
/// </summary>
/// <example>10.59</example>
public decimal? Amount { get; set; }

/// <summary>
/// The status of the invoices.
/// </summary>
/// <example>1</example>
public AffiliateInvoiceStatusModel Status { get; set; }

/// <summary>
/// The invoice type of the invoices.
/// </summary>
/// <example>2</example>
public InvoiceTypeModel InvoiceType { get; set; }

Capture of documentation at Swagger
Wi5qL.png

Capture of documentation at Azure Api Management developer portal
a53Gc.png

Is there any way to show documentation for GET methods? It is necessary some type of configuration at developer portal, it's seems to ignore some values at swagger.json.

POST, PUT or DELETE methods documentation is showed correctly.

Azure API Management
Azure API Management
An Azure service that provides a hybrid, multi-cloud management platform for APIs.
1,084 questions
{count} votes

Accepted answer
  1. ChaitanyaNaykodi-MSFT 10,031 Reputation points Microsoft Employee
    2020-08-28T20:38:20.077+00:00

    Hello @dcanamares , I have received an update from the Product group. The functionality requested is currently not supported, the product group is working on improving the support for OpenAPIv3. The ETA is about end of September.

    Please let me know if you have any additional questions.


0 additional answers

Sort by: Most helpful