Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Show named example description #564

Open
gui1207 opened this issue Mar 9, 2018 · 8 comments
Open

Show named example description #564

gui1207 opened this issue Mar 9, 2018 · 8 comments

Comments

@gui1207
Copy link

gui1207 commented Mar 9, 2018

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

@jarrodek
Copy link
Contributor

jarrodek commented Mar 9, 2018

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

@jarrodek
Copy link
Contributor

This was fixed in APIC v5

@sgleaton
Copy link

sgleaton commented Dec 12, 2019 via email

@jarrodek
Copy link
Contributor

Reopening as the description is not yet supported.

@jarrodek jarrodek reopened this Dec 23, 2019
@jsaliba-epam
Copy link

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

@jarrodek jarrodek removed their assignment Aug 4, 2021
@jarrodek
Copy link
Contributor

jarrodek commented Aug 4, 2021

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

@twoplustwoone
Copy link
Contributor

I'll log an internal ticket for this enhancement

@twoplustwoone twoplustwoone self-assigned this Aug 4, 2021
@twoplustwoone
Copy link
Contributor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants