api-console icon indicating copy to clipboard operation
api-console copied to clipboard

Show named example description

Open gui1207 opened this issue 6 years ago • 8 comments

Hi, this another feature request.

The idea is show the RAML Named Example displayName and description element into the api console examples tab, e.g:

I've describe multiple raml named examples to an resource like this:

responses:
      200:
        body:
          application/json:
            type: airShoppingResponse
            examples:
              one-way: !include examples/airShopping/get-ow-200.raml
              round-trip: !include examples/airShopping/get-rt-200.raml

get-ow-200.raml snippet:

#%RAML 1.0 NamedExample
displayName: One Way
description: One way airShopping response example.
value: {json-content}

Defining the examples like this the console should read the displayName and description attributes and show something like this:

screen shot 2018-03-09 at 16 42 15

And when we have more than one example the console should show the json content collapsed. Today when you have multiple examples is difficult to realize the another examples while you're scrolling the page.

screen shot 2018-03-09 at 16 54 45

gui1207 avatar Mar 09 '18 20:03 gui1207

Thank you for the feature request. I am working right now on this components so I will definitely take it into account.

jarrodek avatar Mar 09 '18 20:03 jarrodek

This was fixed in APIC v5

jarrodek avatar Dec 12 '19 21:12 jarrodek

One email would have been plenty, not the 20 you sent.

On Thu, Dec 12, 2019, 3:45 PM Paweł Psztyć [email protected] wrote:

Closed #564 https://github.com/mulesoft/api-console/issues/564.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/mulesoft/api-console/issues/564?email_source=notifications&email_token=AG2H4CNVNGGRFTRDLK7FMHDQYKWH3A5CNFSM4EUTHHCKYY3PNVWWK3TUL52HS4DFWZEXG43VMVCXMZLOORHG65DJMZUWGYLUNFXW5KTDN5WW2ZLOORPWSZGOVOQX3MY#event-2879487411, or unsubscribe https://github.com/notifications/unsubscribe-auth/AG2H4CIEPDHQKSGPCO5IMOLQYKWH3ANCNFSM4EUTHHCA .

sgleaton avatar Dec 12 '19 22:12 sgleaton

Reopening as the description is not yet supported.

jarrodek avatar Dec 23 '19 05:12 jarrodek

@jarrodek Any idea if/when this is going to be implemented?

jsaliba-epam avatar Jul 28 '21 08:07 jsaliba-epam

@TwoPlusTwoOne apparently I cannot assign tickets anymore. Can you take a look into this?

jarrodek avatar Aug 04 '21 19:08 jarrodek

I'll log an internal ticket for this enhancement

twoplustwoone avatar Aug 04 '21 21:08 twoplustwoone

We've released #706 v6.6.0 with this added. @gui1207 please confirm that the use case has been covered

twoplustwoone avatar Aug 09 '21 17:08 twoplustwoone