materials-consortia/OPTIMADE validator

Validate your OPTIMADE server using the optimade-python-tools validator

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
all versioned pathsWhether to test the optional versioned URLs: /vMAJOR.MINOR; /vMAJOR.MINOR.PATCH If `false`, only the mandatory /vMAJOR URL will be tested. nofalse
validate unversioned pathWhether to validate the input URL as a full OPTIMADE implementation without appending any version. This action assumes that the `path` parameter will contain an unversioned URL. As it is not mandatory to run a full OPTIMADE implementation from the unversioned URL, by default, this action will not perform any validation of this URL, beyond checking the `/versions` endpoint. nofalse
as typeValidate the request URL with the provided type, rather than scanning the entire implementation. Example values: 'structures', 'reference'. For a full list of values see `optimade-python-tools`. no
domainDomain for the OPTIMADE URL (defaults to the GH Actions runner host).nogh_actions_host
fail fastWhether or not to exit and return a non-zero error code on first failure.nofalse
indexWhether or not this is an index meta-database.nofalse
create outputUse `-j/--json` option for `optimade-validator`. This will overwrite the `verbosity` input parameter, since it will be set to `-1` when using the `-j/--json` option. nofalse
pathPath to append to the domain to reach the OPTIMADE unversioned base URL - MUST start with `/`. The path MUST NOT include the versioned part of the base URL. Rather, it MUST point to the unversioned base URL of your OPTIMADE implementation. no/
portPort for the OPTIMADE URL.no
protocolProtocol for the OPTIMADE URL.nohttp
skip optionalWhether or not to skip tests for optional features.nofalse
minimalWhether or not to reduce the validation to a minimal test set that only checks responses and not filters.nofalse
validator versionFull version of an OPTIMADE Python tools release to PyPI, e.g., '0.6.0' or '0.3.4', which hosts the `optimade-validator`. It can also be a branch, tag, or git commit to use from the GitHub repository, e.g., 'master', 'v0.6.0' or '5a5e903'. See https://pip.pypa.io/en/latest/reference/pip_install/#git for more information of what is allowed here. Finally, it may also be 'latest' (default), which is understood to be the latest official release of the `optimade` package on PyPI. Note, for the latest development version, choose 'master'. yeslatest
verbosityThe verbosity of the outputno1
namedescription
resultsJSON object with results overview from `optimade-validator`. This is equivalent to passing `-j/--json` to `optimade-validator`. NOTE: This is only set if `create output` is set to `True`.