OpenAPI components for common DALI parameters #58
Conversation
|
see TAP PR #8 for how these are used to by another spec. |
| specify comma-separated name,location pair for a temporary table to be | ||
| uploaded and used in the request | ||
| schema: | ||
| type: string |
There was a problem hiding this comment.
pattern: might also be useful here to enforce some simple regex for the comma separation.
There was a problem hiding this comment.
OK, minimal pattern added (I did not try to handle the complexity of the location part of that param). The openapi linter I use thought it was OK, but swagger doesn't render anything so it's a little hard to verify and my regex-fu doesn't extend to ECMA-script so I hope those predefined character classes are standard.
There was a problem hiding this comment.
I did a quick check with regex101.com and it seems okay to me. \w covers [a-zA-Z0-9_], but not - as a character, if that's acceptable.
I agree with not tackling the location path.
There was a problem hiding this comment.
I think \w is roughly correct for valid table names... although it does not capture the fact that the name must start with an letter. I should fix that.
That regex101.com site is great - thnx for that pointer!
add simplistic {table name},{location} regex pattern for upload param
|
I have also added very minimal reference from the document to the openapi component files, but have not tried to address the parts of the text that conflict: the case-insensitive parameter name bit. That's one of the outstanding questions we have to discuss/decide (at the interop). |
|
converted to draft pending discussion of how to progress on case-insensitive -> OpenAPI-compliant |
These are small openapi components that can be included in another spec like TAP using the OpenAPI $ref mechanism.
Currently, this just describes the common query parameters in DALI. Even then, it includes only the ones that have a functional impact on current standards, so not: the old VERSION, unused REQUEST, and probably removable RUNID.