This field can be added at the endpoint level in the swagger specification.
x-inputOrder extension field
The x-inputOrder extension field can be used to control the order of parameters in the dynamic Excel functions generated by the APIX Excel Plugin. The order of parameters in the generated functions is determined based on the following criteria, in order of precedence (from high to low):
|
Criteria
|
Ordering
|
|---|---|
|
Value of |
For example: |
|
Value of |
In ascending numerical order (lower values come first). Parameters with missing, null, or non-integer values are ordered after all parameters with integer values, with equal priority. For example x |
| The order of the parameter in the OpenAPI document | Parameters defined first in the OpenAPI document show up first in the generated Excel function. |
Although it is not mandatory to supply a value to the x-inputOrder an extension field, it can be helpful when it is not possible to control the order of the parameters in the OpenAPI document. This becomes important in the context of publishing a new API version or updating an existing one since existing spreadsheets will likely break if the order of the parameters changes.
Comments
0 comments
Please sign in to leave a comment.