Skip to content
This repository has been archived by the owner on Nov 8, 2024. It is now read-only.

Explode modifier not supported? #553

Closed
SMillerDev opened this issue Jun 12, 2018 · 4 comments
Closed

Explode modifier not supported? #553

SMillerDev opened this issue Jun 12, 2018 · 4 comments
Labels

Comments

@SMillerDev
Copy link
Contributor

I'm trying to use the explode modifier with drafter: https://tools.ietf.org/html/rfc6570#section-2.4.2
but I can't get it to work. The API Blueprint spec mentions that RFC6570 is supported though.

Error message:

warning: (8) parameter 'filter' is not found within the URI template '/flights{?filter*}' for 'Flight list'

Code:

### Flight list [GET /flights{?filter*}]

Get a filtered list of flights

+ Parameters
    + filter (required) - Provide one of these values as a parameter to filter
        + arrival : `false` (optional) - Whether the flight is an arrival or departure
        + terminal : `A` (optional) - The terminal for the flight
        + gate : `5` (optional) - Gate information
@kylef kylef added the bug label Jun 12, 2018
@kylef
Copy link
Member

kylef commented Jun 12, 2018

The URI Template support is a bit lacking at the moment. I'd like to schedule looking into URI Template support near-term. There are various related problems, linking in #500, #456, apiaryio/api-blueprint#252 and apiaryio/snowcrash#357.

Right now we're focussed on getting Drafter 4 changes finished and rolled out across Apiary and I think this can be fixed shortly afterwards once we got 4.0 out.

@SMillerDev
Copy link
Contributor Author

I know it's open source and whatnot but I'm gonna try asking for a schedule either way 😉 .
What timeline should I think of for 4.0? Weeks? Months? Before 2030?

@kylef
Copy link
Member

kylef commented Jun 12, 2018

Weeks I hope, #552 should be on of the last PRs (pending any problems we discover during testing). Once that's ready and merged we can being rolling out which will be a delicate and slow process as there are some significant changes to the parse result and we need to be careful rolling out to Apiary and be sure we are not introducing regressions or performance problems.

@kylef
Copy link
Member

kylef commented Mar 23, 2020

As of Drafter 5.0.0-rc.1, full support for URI Template has been added, including level 3/4 and the explode modifier.

The included document will now parse without warnings, and show something along the lines of the following in ApiaryUI:

Screenshot 2020-03-23 at 09 35 02

@kylef kylef closed this as completed Mar 23, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

No branches or pull requests

2 participants