Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Query parameter examples are not displayed

See original GitHub issue

Bug description

In open api it is possible to set examples how to use certain query parameters. Here is an example shown in the Swagger UI:

The open api document looks similar to this:

"name": "$filter", "in": "query", "allowReserved": true, "schema": { "type": "String" }, "examples": { "Arithmetic Operators": { "description": "Value le 333.333" } ...,

Expected behavior

It would be great if the portal would also display these examples as they are very helpful for users

Is your portal managed or self-hosted?

Managed

Issue Analytics

State:
Created 3 years ago
Comments:12 (3 by maintainers)

Top GitHub Comments

3reactions

azaslonovcommented, May 13, 2020

Hi @alanwales, yes, that makes sense. Thank you.

0reactions

pierrehodycommented, Oct 8, 2021

Hi Mike,

Cf 1483https://github.com/Azure/api-management-developer-portal/issues/1483

Regards,

Pierre

From: Mike Budzynski @.> Sent: Thursday, 7 October 2021 19:51 To: Azure/api-management-developer-portal @.> Cc: Hody Pierre @.>; Mention @.> Subject: Re: [Azure/api-management-developer-portal] Query parameter examples are not displayed (#610)

@pierrehody https://github.com/pierrehody, could you please open a new issue with clear reproduction steps? Specifically, in addition to already provided details, we need to better understand:

Are those example and examples fields preserved after an import of the API in API Management. For example, do they show up in the OpenAPI file editor in the Azure portal?
“When I try to put examples instead of example, save the yaml file and reopen it, the value fields under examples are reset to null.” - how and where do you edit the examples field? Do you do it in the OpenAPI editor in the Azure portal?

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHubhttps://github.com/Azure/api-management-developer-portal/issues/610#issuecomment-938020947, or unsubscribehttps://github.com/notifications/unsubscribe-auth/AIWKGULMIOVPN5HCZQAIK7TUFXMZVANCNFSM4M7UIDOQ. Triage notifications on the go with GitHub Mobile for iOShttps://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675 or Androidhttps://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub.

Top Results From Across the Web

Use parameters to ask for input when running a query

To specify the data type for parameters in a query: With the query open in Design view, on the Design tab, in the...

drf spectacular not showing query params in swagger ui

I have the following code. @extend_schema( parameters=[ OpenApiParameter(name='category',location=OpenApiParameter.QUERY, description=' ...

Parameter Serialization - Swagger

OpenAPI 3.0 supports arrays and objects in operation parameters (path, query, header, and cookie) and lets you specify how these parameters should be ......

Query parameter targeting - Optimize Resource Hub

Equals / does not equal ... Every character in your query parameter, from beginning to end, must be an exact match of the...

7.4 - Request Format - Google

The following examples show search requests that use the POST command for public ... The query string payload is not part of the...