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

REST steps - consider option to specify query string in examples table #412

Open
paveljandejsek opened this issue Jul 21, 2020 · 1 comment
Labels
enhancement New feature or request

Comments

@paveljandejsek
Copy link
Contributor

We should consider some option to send query string parameters in examples table, ie to simplify following use case:
/openapi/v2/transaction/{CP:ACCOUNT_NUMBER}/transactions/instalmentPlanOffers?demandedAmount=15000&transactionType=RTL&currency={CURRENCY}&transactionDate={CURRENT_DATE:{CP:TIMESHIFT_DAYS}}&iptype=EPP

@paveljandejsek paveljandejsek added the enhancement New feature or request label Jul 21, 2020
@paveljandejsek
Copy link
Contributor Author

paveljandejsek commented Jan 25, 2021

There are 2 ways I see to solve this:

  1. something like @query-parameter, @path-parameter (@query/@path, or @queryParameter/@pathParameter)? similar approach as for headers and body
  2. new column that would say what type is the parameter - similar aproach as for jaxb and abstract type implementations

So far I am in favor of the first option with something like:

When [GET] request to [TEST]/[/openapi/v2/] is sent with data:
| name                       | data                               | 
| @query.transaction         |                                    | 
| @query.{CP:ACCOUNT_NUMBER} |                                    |
| @query.transactions        |                                    |
| @query.instalmentPlanOffers|                                    |  
| @path.demandedAmount       | 15000                              | 
| @path.transactionType      | RTL                                | 
| @path.currency             | {CURRENCY}                         | 
| @path.transactionDate      | {CURRENT_DATE:{CP:TIMESHIFT_DAYS}} | 
| @path.iptype               | EPP                                | 

Thoughts? Or any other ideas?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant