The usage of taplint
is
stilts <stilts-flags> taplint stages=TMV|TME|TMS|TMC|CPV|CAP|AVV|QGE|QPO|QAS|UWS|MDQ|OBS|UPL|EXA[ ...] maxtable=<int-value> format=text|json report=[EWISF]+ maxrepeat=<int-value> truncate=<int-value> debug=true|false syncurl=<url-value> asyncurl=<url-value> tablesurl=<url-value> capabilitiesurl=<url-value> availabilityurl=<url-value> examplesurl=<url-value> [tapurl=]<url-value>If you don't have the
stilts
script installed,
write "java -jar stilts.jar
" instead of
"stilts
" - see Section 3.
The available <stilts-flags>
are listed
in Section 2.1.
For programmatic invocation, the Task class for this
command is uk.ac.starlink.ttools.task.TapLint
.
Parameter values are assigned on the command line as explained in Section 2.3. They are as follows:
asyncurl = <url-value>
(URL)<tapurl>/async
but you can set this parameter to some other location
if required.
If left blank, the default value is used.
availabilityurl = <url-value>
(URL)<tapurl>/availability
but you can set this parameter to some other location
if required.
If left blank, the default value is used.
capabilitiesurl = <url-value>
(URL)<tapurl>/capabilities
but you can set this parameter to some other location
if required.
If left blank, the default value is used.
debug = true|false
(Boolean)[Default: false
]
examplesurl = <url-value>
(URL)<tapurl>/examples
but you can set this parameter to some other location
if required.
If left blank, the default value is used.
format = text|json
(OutputReporter)text
, json
.
Note not all of the other parameters may be applicable to all output formats.
[Default: text
]
maxrepeat = <int-value>
(Integer)[Default: 9
]
maxtable = <int-value>
(Integer)MDQ
.
If the value is left blank (the default),
or if it is larger than the number of tables actually
present in the service, it will have no effect.
report = [EWISF]+
(String)E
, W
, I
, S
, F
with the following meanings:
E
: Error in operation or standard compliance of the service.W
: Warning that service behaviour is questionable, or contravenes a standard recommendation,
but is not in actual violation of the standard.I
: Information about progress, for instance details of queries made.S
: Summary of previous successful/unsuccessful reports.F
: Failure of the validator to perform some testing. The cause is either some error
internal to the validator, or some error or missing functionality in the service which
has already been reported.[Default: EWISF
]
stages = TMV|TME|TMS|TMC|CPV|CAP|AVV|QGE|QPO|QAS|UWS|MDQ|OBS|UPL|EXA[ ...]
(String[])TMV
: Validate table metadata against XML schema (on)TME
: Check content of tables metadata from /tables (on)TMS
: Check content of tables metadata from TAP_SCHEMA (on)TMC
: Compare table metadata from /tables and TAP_SCHEMA (on)CPV
: Validate capabilities against XML schema (on)CAP
: Check content of TAPRegExt capabilities record (on)AVV
: Validate availability against XML schema (on)QGE
: Make ADQL queries in sync GET mode (on)QPO
: Make ADQL queries in sync POST mode (on)QAS
: Make ADQL queries in async mode (on)UWS
: Test asynchronous UWS/TAP behaviour (on)MDQ
: Check table query result columns against declared metadata (on)OBS
: Test implementation of ObsCore Data Model (on)UPL
: Make queries with table uploads (on)EXA
: Check content of examples document (on)Note that removing some stages may affect the operation of others; for instance table metadata is acquired from the metadata stages, and avoiding those will mean that later stages that use the table metadata to pose queries will not be able to do so with knowledge of the database schema.
[Default: TMV TME TMS TMC CPV CAP AVV QGE QPO QAS UWS MDQ OBS UPL EXA
]
syncurl = <url-value>
(URL)<tapurl>/sync
but you can set this parameter to some other location
if required.
If left blank, the default value is used.
tablesurl = <url-value>
(URL)<tapurl>/tables
but you can set this parameter to some other location
if required.
If left blank, the default value is used.
tapurl = <url-value>
(URL)The default values of the various endpoints
(sync and async query submission, tables metadata,
service-provided examples etc)
use this URL as a parent
and append standard sub-paths.
However, other parameters (syncurl
, asyncurl
, ...)
are provided so that the different endpoints
can be set individually if required.
truncate = <int-value>
(Integer)[Default: 640
]