jentic-openapi-validator-spectral 1.0.0a10__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- jentic/apitools/openapi/validator/backends/spectral/__init__.py +226 -0
- jentic/apitools/openapi/validator/backends/spectral/py.typed +0 -0
- jentic/apitools/openapi/validator/backends/spectral/rulesets/spectral.yaml +3 -0
- jentic_openapi_validator_spectral-1.0.0a10.dist-info/METADATA +284 -0
- jentic_openapi_validator_spectral-1.0.0a10.dist-info/RECORD +9 -0
- jentic_openapi_validator_spectral-1.0.0a10.dist-info/WHEEL +4 -0
- jentic_openapi_validator_spectral-1.0.0a10.dist-info/entry_points.txt +3 -0
- jentic_openapi_validator_spectral-1.0.0a10.dist-info/licenses/LICENSE +202 -0
- jentic_openapi_validator_spectral-1.0.0a10.dist-info/licenses/NOTICE +4 -0
|
@@ -0,0 +1,226 @@
|
|
|
1
|
+
import json
|
|
2
|
+
import shlex
|
|
3
|
+
import tempfile
|
|
4
|
+
from collections.abc import Sequence
|
|
5
|
+
from importlib.resources import as_file, files
|
|
6
|
+
from pathlib import Path
|
|
7
|
+
from typing import Literal
|
|
8
|
+
from urllib.parse import urlparse
|
|
9
|
+
from urllib.request import url2pathname
|
|
10
|
+
|
|
11
|
+
from lsprotocol.types import DiagnosticSeverity, Position, Range
|
|
12
|
+
|
|
13
|
+
from jentic.apitools.openapi.common.path_security import validate_path
|
|
14
|
+
from jentic.apitools.openapi.common.subproc import (
|
|
15
|
+
SubprocessExecutionError,
|
|
16
|
+
SubprocessExecutionResult,
|
|
17
|
+
run_subprocess,
|
|
18
|
+
)
|
|
19
|
+
from jentic.apitools.openapi.common.uri import is_path
|
|
20
|
+
from jentic.apitools.openapi.validator.backends.base import BaseValidatorBackend
|
|
21
|
+
from jentic.apitools.openapi.validator.core import JenticDiagnostic, ValidationResult
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
__all__ = ["SpectralValidatorBackend"]
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
rulesets_files_dir = files("jentic.apitools.openapi.validator.backends.spectral.rulesets")
|
|
28
|
+
ruleset_file = rulesets_files_dir.joinpath("spectral.yaml")
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
class SpectralValidatorBackend(BaseValidatorBackend):
|
|
32
|
+
def __init__(
|
|
33
|
+
self,
|
|
34
|
+
spectral_path: str = "npx --yes @stoplight/spectral-cli@^6.15.0",
|
|
35
|
+
ruleset_path: str | None = None,
|
|
36
|
+
timeout: float = 600.0,
|
|
37
|
+
allowed_base_dir: str | Path | None = None,
|
|
38
|
+
):
|
|
39
|
+
"""
|
|
40
|
+
Initialize the SpectralValidatorBackend.
|
|
41
|
+
|
|
42
|
+
Args:
|
|
43
|
+
spectral_path: Path to the spectral CLI executable (default: "npx --yes @stoplight/spectral-cli@^6.15.0").
|
|
44
|
+
Uses shell-safe parsing to handle quoted arguments properly.
|
|
45
|
+
ruleset_path: Path to a custom ruleset file. If None, uses bundled default ruleset.
|
|
46
|
+
timeout: Maximum time in seconds to wait for Spectral CLI execution (default: 600.0)
|
|
47
|
+
allowed_base_dir: Optional base directory for path security validation.
|
|
48
|
+
When set, all document and ruleset paths will be validated to ensure they
|
|
49
|
+
are within this directory. This provides defense against path traversal attacks
|
|
50
|
+
and is recommended for web services or when processing untrusted input.
|
|
51
|
+
If None (default), only file extension validation is performed (no base directory
|
|
52
|
+
containment check). Extension validation ensures only .yaml, .yml, and .json files
|
|
53
|
+
are processed.
|
|
54
|
+
"""
|
|
55
|
+
self.spectral_path = spectral_path
|
|
56
|
+
self.ruleset_path = ruleset_path if isinstance(ruleset_path, str) else None
|
|
57
|
+
self.timeout = timeout
|
|
58
|
+
self.allowed_base_dir = allowed_base_dir
|
|
59
|
+
|
|
60
|
+
@staticmethod
|
|
61
|
+
def accepts() -> Sequence[Literal["uri", "dict"]]:
|
|
62
|
+
"""Return the document formats this validator can accept.
|
|
63
|
+
|
|
64
|
+
Returns:
|
|
65
|
+
Sequence of supported document format identifiers:
|
|
66
|
+
- "uri": File path or URI pointing to OpenAPI Document
|
|
67
|
+
- "dict": Python dictionary containing OpenAPI Document data
|
|
68
|
+
"""
|
|
69
|
+
return ["uri", "dict"]
|
|
70
|
+
|
|
71
|
+
def validate(
|
|
72
|
+
self, document: str | dict, *, base_url: str | None = None, target: str | None = None
|
|
73
|
+
) -> ValidationResult:
|
|
74
|
+
"""
|
|
75
|
+
Validate an OpenAPI document using Spectral.
|
|
76
|
+
|
|
77
|
+
Args:
|
|
78
|
+
document: Path to the OpenAPI document file to validate, or dict containing the document
|
|
79
|
+
base_url: Optional base URL for resolving relative references (currently unused)
|
|
80
|
+
target: Optional target identifier for validation context (currently unused)
|
|
81
|
+
|
|
82
|
+
Returns:
|
|
83
|
+
ValidationResult containing any validation issues found
|
|
84
|
+
|
|
85
|
+
Raises:
|
|
86
|
+
FileNotFoundError: If a custom ruleset file doesn't exist
|
|
87
|
+
RuntimeError: If Spectral execution fails
|
|
88
|
+
SubprocessExecutionError: If Spectral execution times out or fails to start
|
|
89
|
+
TypeError: If a document type is not supported
|
|
90
|
+
PathTraversalError: Document or ruleset path attempts to escape allowed_base_dir (only when allowed_base_dir is set)
|
|
91
|
+
InvalidExtensionError: Document or ruleset path has disallowed file extension (always checked for filesystem paths)
|
|
92
|
+
"""
|
|
93
|
+
if isinstance(document, str):
|
|
94
|
+
return self._validate_uri(document, base_url=base_url, target=target)
|
|
95
|
+
elif isinstance(document, dict):
|
|
96
|
+
return self._validate_dict(document, base_url=base_url, target=target)
|
|
97
|
+
else:
|
|
98
|
+
raise TypeError(f"Unsupported document type: {type(document)!r}")
|
|
99
|
+
|
|
100
|
+
def _validate_uri(
|
|
101
|
+
self, document: str, *, base_url: str | None = None, target: str | None = None
|
|
102
|
+
) -> ValidationResult:
|
|
103
|
+
"""
|
|
104
|
+
Validate an OpenAPI document using Spectral.
|
|
105
|
+
|
|
106
|
+
Args:
|
|
107
|
+
document: Path to the OpenAPI document file to validate, or dict containing the document
|
|
108
|
+
|
|
109
|
+
Returns:
|
|
110
|
+
ValidationResult containing any validation issues found
|
|
111
|
+
"""
|
|
112
|
+
result: SubprocessExecutionResult | None = None
|
|
113
|
+
|
|
114
|
+
try:
|
|
115
|
+
parsed_doc_url = urlparse(document)
|
|
116
|
+
doc_path = (
|
|
117
|
+
url2pathname(parsed_doc_url.path) if parsed_doc_url.scheme == "file" else document
|
|
118
|
+
)
|
|
119
|
+
|
|
120
|
+
# Validate document path if it's a filesystem path (skip non-path URIs like HTTP(S))
|
|
121
|
+
validated_doc_path = (
|
|
122
|
+
validate_path(
|
|
123
|
+
doc_path,
|
|
124
|
+
allowed_base=self.allowed_base_dir,
|
|
125
|
+
allowed_extensions=(".yaml", ".yml", ".json"),
|
|
126
|
+
)
|
|
127
|
+
if is_path(doc_path)
|
|
128
|
+
else doc_path
|
|
129
|
+
)
|
|
130
|
+
|
|
131
|
+
# Validate ruleset path if it's a filesystem path (skip non-path URIs)
|
|
132
|
+
validated_ruleset_path = (
|
|
133
|
+
validate_path(
|
|
134
|
+
self.ruleset_path,
|
|
135
|
+
allowed_base=self.allowed_base_dir,
|
|
136
|
+
allowed_extensions=(".yaml", ".yml"),
|
|
137
|
+
)
|
|
138
|
+
if self.ruleset_path is not None and is_path(self.ruleset_path)
|
|
139
|
+
else self.ruleset_path
|
|
140
|
+
)
|
|
141
|
+
|
|
142
|
+
with as_file(ruleset_file) as default_ruleset_path:
|
|
143
|
+
# Build spectral command
|
|
144
|
+
cmd = [
|
|
145
|
+
*shlex.split(self.spectral_path),
|
|
146
|
+
"lint",
|
|
147
|
+
"-r",
|
|
148
|
+
validated_ruleset_path or default_ruleset_path,
|
|
149
|
+
"-f",
|
|
150
|
+
"json",
|
|
151
|
+
validated_doc_path,
|
|
152
|
+
]
|
|
153
|
+
result = run_subprocess(cmd, timeout=self.timeout)
|
|
154
|
+
|
|
155
|
+
except SubprocessExecutionError as e:
|
|
156
|
+
# only timeout and OS errors, as run_subprocess has a default `fail_on_error = False`
|
|
157
|
+
raise e
|
|
158
|
+
|
|
159
|
+
if result is None:
|
|
160
|
+
raise RuntimeError("Spectral validation failed - no result returned")
|
|
161
|
+
|
|
162
|
+
if result.returncode not in (0, 1) or (result.stderr and not result.stdout):
|
|
163
|
+
# According to Spectral docs, return code 2 might indicate lint errors found,
|
|
164
|
+
# 0 means no issues, but let's not assume this; we'll parse output.
|
|
165
|
+
# If returncode is something else, spectral encountered an execution error.
|
|
166
|
+
err = result.stderr.strip() or result.stdout.strip()
|
|
167
|
+
msg = err or f"Spectral exited with code {result.returncode}"
|
|
168
|
+
raise RuntimeError(msg)
|
|
169
|
+
|
|
170
|
+
output = result.stdout.replace("No results with a severity of 'error' found!", "")
|
|
171
|
+
|
|
172
|
+
try:
|
|
173
|
+
issues: list[dict] = json.loads(output)
|
|
174
|
+
except json.JSONDecodeError:
|
|
175
|
+
# If an output isn't JSON (maybe spectral old version or error format), handle gracefully
|
|
176
|
+
return ValidationResult(diagnostics=[])
|
|
177
|
+
|
|
178
|
+
diagnostics: list[JenticDiagnostic] = []
|
|
179
|
+
for issue in issues:
|
|
180
|
+
# Spectral JSON has fields like code, message, severity, path, range, etc.
|
|
181
|
+
try:
|
|
182
|
+
severity_code = issue.get(
|
|
183
|
+
"severity", DiagnosticSeverity.Error
|
|
184
|
+
) # e.g. "error" or numeric 0=error,1=warn...
|
|
185
|
+
severity = DiagnosticSeverity(severity_code + 1)
|
|
186
|
+
except (ValueError, TypeError):
|
|
187
|
+
severity = DiagnosticSeverity.Error
|
|
188
|
+
|
|
189
|
+
msg_text = issue.get("message", "")
|
|
190
|
+
# location: combine file and jsonpath if available
|
|
191
|
+
loc = f"path: {'.'.join(str(p) for p in issue['path'])}" if issue.get("path") else ""
|
|
192
|
+
range_info = issue.get("range", {})
|
|
193
|
+
start_line = range_info.get("start", {}).get("line", 0)
|
|
194
|
+
start_char = range_info.get("start", {}).get("character", 0)
|
|
195
|
+
end_line = range_info.get("end", {}).get("line", start_line)
|
|
196
|
+
end_char = range_info.get("end", {}).get("character", start_char)
|
|
197
|
+
# TODO(francesco@jentic.com): add jsonpath and other details to message if needed
|
|
198
|
+
diagnostic = JenticDiagnostic(
|
|
199
|
+
range=Range(
|
|
200
|
+
start=Position(line=start_line, character=start_char),
|
|
201
|
+
end=Position(line=end_line, character=end_char),
|
|
202
|
+
),
|
|
203
|
+
message=msg_text + " [" + loc + "]",
|
|
204
|
+
severity=severity,
|
|
205
|
+
code=issue.get("code"),
|
|
206
|
+
source="spectral-validator",
|
|
207
|
+
)
|
|
208
|
+
diagnostic.set_target(target)
|
|
209
|
+
diagnostic.set_path(issue.get("path"))
|
|
210
|
+
diagnostics.append(diagnostic)
|
|
211
|
+
|
|
212
|
+
return ValidationResult(diagnostics=diagnostics)
|
|
213
|
+
|
|
214
|
+
def _validate_dict(
|
|
215
|
+
self, document: dict, *, base_url: str | None = None, target: str | None = None
|
|
216
|
+
) -> ValidationResult:
|
|
217
|
+
"""Validate a dict document by creating a temporary file and using _validate_uri."""
|
|
218
|
+
with tempfile.NamedTemporaryFile(
|
|
219
|
+
mode="w", suffix=".json", delete=True, encoding="utf-8"
|
|
220
|
+
) as temp_file:
|
|
221
|
+
json.dump(document, temp_file)
|
|
222
|
+
temp_file.flush() # Ensure content is written to disk
|
|
223
|
+
|
|
224
|
+
return self._validate_uri(
|
|
225
|
+
Path(temp_file.name).as_uri(), base_url=base_url, target=target
|
|
226
|
+
)
|
|
File without changes
|
|
@@ -0,0 +1,284 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: jentic-openapi-validator-spectral
|
|
3
|
+
Version: 1.0.0a10
|
|
4
|
+
Summary: Jentic OpenAPI Spectral Validator Backend
|
|
5
|
+
Author: Jentic
|
|
6
|
+
Author-email: Jentic <hello@jentic.com>
|
|
7
|
+
License-Expression: Apache-2.0
|
|
8
|
+
License-File: LICENSE
|
|
9
|
+
License-File: NOTICE
|
|
10
|
+
Requires-Dist: jentic-openapi-common~=1.0.0a10
|
|
11
|
+
Requires-Dist: jentic-openapi-validator~=1.0.0a10
|
|
12
|
+
Requires-Dist: lsprotocol~=2025.0.0
|
|
13
|
+
Requires-Python: >=3.11
|
|
14
|
+
Project-URL: Homepage, https://github.com/jentic/jentic-openapi-tools
|
|
15
|
+
Description-Content-Type: text/markdown
|
|
16
|
+
|
|
17
|
+
# jentic-openapi-validator-spectral
|
|
18
|
+
|
|
19
|
+
A [Spectral](https://github.com/stoplightio/spectral) validator backend for the Jentic OpenAPI Tools ecosystem. This package provides OpenAPI document validation using Stoplight's Spectral CLI with comprehensive error reporting and flexible configuration options.
|
|
20
|
+
|
|
21
|
+
## Features
|
|
22
|
+
|
|
23
|
+
- **Multiple input formats**: Validate OpenAPI documents from file URIs or Python dictionaries
|
|
24
|
+
- **Custom rulesets**: Use built-in rules or provide your own Spectral ruleset
|
|
25
|
+
- **Configurable timeouts**: Control execution time limits for different use cases
|
|
26
|
+
- **Rich diagnostics**: Detailed validation results with line/column information
|
|
27
|
+
- **Type-safe API**: Full typing support with Literal types and comprehensive docstrings
|
|
28
|
+
|
|
29
|
+
## Installation
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
pip install jentic-openapi-validator-spectral
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
**Prerequisites:**
|
|
36
|
+
- Node.js and npm (for Spectral CLI)
|
|
37
|
+
- Python 3.11+
|
|
38
|
+
|
|
39
|
+
The Spectral CLI will be automatically downloaded via npx on first use, or you can install it globally:
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
npm install -g @stoplight/spectral-cli
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
## Quick Start
|
|
46
|
+
|
|
47
|
+
### Basic Usage
|
|
48
|
+
|
|
49
|
+
```python
|
|
50
|
+
from jentic.apitools.openapi.validator.backends.spectral import SpectralValidatorBackend
|
|
51
|
+
|
|
52
|
+
# Create validator with defaults
|
|
53
|
+
validator = SpectralValidatorBackend()
|
|
54
|
+
|
|
55
|
+
# Validate from file URI
|
|
56
|
+
result = validator.validate("file:///path/to/openapi.yaml")
|
|
57
|
+
print(f"Valid: {result.valid}")
|
|
58
|
+
|
|
59
|
+
# Check for validation issues
|
|
60
|
+
if not result.valid:
|
|
61
|
+
for diagnostic in result.diagnostics:
|
|
62
|
+
print(f"Error: {diagnostic.message}")
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
### Validate Dictionary Documents
|
|
66
|
+
|
|
67
|
+
```python
|
|
68
|
+
# Validate from dictionary
|
|
69
|
+
openapi_doc = {
|
|
70
|
+
"openapi": "3.0.0",
|
|
71
|
+
"info": {"title": "My API", "version": "1.0.0"},
|
|
72
|
+
"paths": {}
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
result = validator.validate(openapi_doc)
|
|
76
|
+
print(f"Document is valid: {result.valid}")
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
## Configuration Options
|
|
80
|
+
|
|
81
|
+
### Custom Spectral CLI Path
|
|
82
|
+
|
|
83
|
+
```python
|
|
84
|
+
# Use local Spectral installation
|
|
85
|
+
validator = SpectralValidatorBackend(spectral_path="/usr/local/bin/spectral")
|
|
86
|
+
|
|
87
|
+
# Use specific version via npx
|
|
88
|
+
validator = SpectralValidatorBackend(spectral_path="npx --yes @stoplight/spectral-cli@^6.15.0")
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
### Custom Rulesets
|
|
92
|
+
|
|
93
|
+
```python
|
|
94
|
+
# Use custom ruleset file
|
|
95
|
+
validator = SpectralValidatorBackend(ruleset_path="/path/to/custom-rules.yaml")
|
|
96
|
+
|
|
97
|
+
# The validator automatically falls back to bundled rulesets if no custom path is provided
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
### Timeout Configuration
|
|
101
|
+
|
|
102
|
+
```python
|
|
103
|
+
# Short timeout for CI/CD (10 seconds)
|
|
104
|
+
validator = SpectralValidatorBackend(timeout=10.0)
|
|
105
|
+
|
|
106
|
+
# Extended timeout for large documents (2 minutes)
|
|
107
|
+
validator = SpectralValidatorBackend(timeout=120.0)
|
|
108
|
+
|
|
109
|
+
# Combined configuration (45 seconds)
|
|
110
|
+
validator = SpectralValidatorBackend(
|
|
111
|
+
spectral_path="/usr/local/bin/spectral",
|
|
112
|
+
ruleset_path="/path/to/strict-rules.yaml",
|
|
113
|
+
timeout=45.0
|
|
114
|
+
)
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
### Path Security
|
|
118
|
+
|
|
119
|
+
Use `allowed_base_dir` to restrict file access when processing untrusted input or running as a web service:
|
|
120
|
+
|
|
121
|
+
```python
|
|
122
|
+
from jentic.apitools.openapi.common.path_security import (
|
|
123
|
+
PathTraversalError,
|
|
124
|
+
InvalidExtensionError,
|
|
125
|
+
)
|
|
126
|
+
|
|
127
|
+
# Restrict file access to /var/app/documents directory
|
|
128
|
+
validator = SpectralValidatorBackend(
|
|
129
|
+
allowed_base_dir="/var/app/documents"
|
|
130
|
+
)
|
|
131
|
+
|
|
132
|
+
# Valid paths within allowed directory work normally
|
|
133
|
+
result = validator.validate("/var/app/documents/specs/openapi.yaml")
|
|
134
|
+
|
|
135
|
+
# Path traversal attempts are blocked
|
|
136
|
+
try:
|
|
137
|
+
result = validator.validate("/var/app/documents/../../etc/passwd")
|
|
138
|
+
except PathTraversalError as e:
|
|
139
|
+
print(f"Security violation: {e}")
|
|
140
|
+
|
|
141
|
+
# Invalid file extensions are rejected
|
|
142
|
+
try:
|
|
143
|
+
result = validator.validate("/var/app/documents/malicious.exe")
|
|
144
|
+
except InvalidExtensionError as e:
|
|
145
|
+
print(f"Invalid file type: {e}")
|
|
146
|
+
|
|
147
|
+
# HTTP(S) URLs bypass path validation (as expected)
|
|
148
|
+
result = validator.validate("https://example.com/openapi.yaml")
|
|
149
|
+
|
|
150
|
+
# Combined security configuration for web services
|
|
151
|
+
validator = SpectralValidatorBackend(
|
|
152
|
+
allowed_base_dir="/var/app/uploads",
|
|
153
|
+
ruleset_path="/var/app/config/custom-rules.yaml", # Also validated
|
|
154
|
+
timeout=600.0
|
|
155
|
+
)
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
**Security Benefits:**
|
|
159
|
+
- Prevents path traversal attacks (`../../etc/passwd`)
|
|
160
|
+
- Restricts access to allowed directories only (when `allowed_base_dir` is set)
|
|
161
|
+
- Validates file extensions (`.yaml`, `.yml`, `.json`) - **always enforced**, even when `allowed_base_dir=None`
|
|
162
|
+
- Checks symlinks don't escape boundaries (when `allowed_base_dir` is set)
|
|
163
|
+
- Validates both document and ruleset paths
|
|
164
|
+
|
|
165
|
+
**Note:** File extension validation (`.yaml`, `.yml`, `.json`) is always performed for filesystem paths, regardless of whether `allowed_base_dir` is set. When `allowed_base_dir=None`, only the base directory containment check is skipped.
|
|
166
|
+
|
|
167
|
+
## Advanced Usage
|
|
168
|
+
|
|
169
|
+
### Error Handling
|
|
170
|
+
|
|
171
|
+
```python
|
|
172
|
+
from jentic.apitools.openapi.common.subproc import SubprocessExecutionError
|
|
173
|
+
|
|
174
|
+
try:
|
|
175
|
+
result = validator.validate("file:///path/to/openapi.yaml")
|
|
176
|
+
|
|
177
|
+
if result.valid:
|
|
178
|
+
print("✅ Document is valid")
|
|
179
|
+
else:
|
|
180
|
+
print("❌ Validation failed:")
|
|
181
|
+
for diagnostic in result.diagnostics:
|
|
182
|
+
severity = diagnostic.severity.name
|
|
183
|
+
line = diagnostic.range.start.line + 1
|
|
184
|
+
print(f" {severity}: {diagnostic.message} (line {line})")
|
|
185
|
+
|
|
186
|
+
except FileNotFoundError as e:
|
|
187
|
+
print(f"Ruleset file not found: {e}")
|
|
188
|
+
except SubprocessExecutionError as e:
|
|
189
|
+
print(f"Spectral execution failed: {e}")
|
|
190
|
+
except TypeError as e:
|
|
191
|
+
print(f"Invalid document type: {e}")
|
|
192
|
+
```
|
|
193
|
+
|
|
194
|
+
### Supported Document Formats
|
|
195
|
+
|
|
196
|
+
```python
|
|
197
|
+
# Check what formats the validator supports
|
|
198
|
+
formats = validator.accepts()
|
|
199
|
+
print(formats) # ['uri', 'dict']
|
|
200
|
+
|
|
201
|
+
# Validate different input types
|
|
202
|
+
if "uri" in validator.accepts():
|
|
203
|
+
result = validator.validate("file:///path/to/spec.yaml")
|
|
204
|
+
|
|
205
|
+
if "dict" in validator.accepts():
|
|
206
|
+
result = validator.validate({"openapi": "3.0.0", ...})
|
|
207
|
+
```
|
|
208
|
+
|
|
209
|
+
## Custom Rulesets
|
|
210
|
+
|
|
211
|
+
Create a custom Spectral ruleset file:
|
|
212
|
+
|
|
213
|
+
```yaml
|
|
214
|
+
# custom-rules.yaml
|
|
215
|
+
extends: ["spectral:oas"]
|
|
216
|
+
|
|
217
|
+
rules:
|
|
218
|
+
info-contact: error
|
|
219
|
+
info-description: error
|
|
220
|
+
operation-description: error
|
|
221
|
+
operation-summary: warn
|
|
222
|
+
path-params: error
|
|
223
|
+
|
|
224
|
+
# Custom rule
|
|
225
|
+
no-empty-paths:
|
|
226
|
+
description: "Paths object should not be empty"
|
|
227
|
+
given: "$.paths"
|
|
228
|
+
then:
|
|
229
|
+
function: truthy
|
|
230
|
+
severity: error
|
|
231
|
+
```
|
|
232
|
+
|
|
233
|
+
Use it with the validator:
|
|
234
|
+
|
|
235
|
+
```python
|
|
236
|
+
validator = SpectralValidatorBackend(ruleset_path="./custom-rules.yaml")
|
|
237
|
+
result = validator.validate("file:///path/to/openapi.yaml")
|
|
238
|
+
```
|
|
239
|
+
|
|
240
|
+
## Testing
|
|
241
|
+
|
|
242
|
+
### Integration Tests
|
|
243
|
+
|
|
244
|
+
The integration tests require Spectral CLI to be available. They will be automatically skipped if Spectral is not installed.
|
|
245
|
+
|
|
246
|
+
**Run the integration test:**
|
|
247
|
+
|
|
248
|
+
```bash
|
|
249
|
+
uv run --package jentic-openapi-validator-spectral pytest packages/jentic-openapi-validator-spectral -v
|
|
250
|
+
```
|
|
251
|
+
|
|
252
|
+
## API Reference
|
|
253
|
+
|
|
254
|
+
### SpectralValidator
|
|
255
|
+
|
|
256
|
+
```python
|
|
257
|
+
class SpectralValidatorBackend(BaseValidatorBackend):
|
|
258
|
+
def __init__(
|
|
259
|
+
self,
|
|
260
|
+
spectral_path: str = "npx --yes @stoplight/spectral-cli@^6.15.0",
|
|
261
|
+
ruleset_path: str | None = None,
|
|
262
|
+
timeout: float = 600.0,
|
|
263
|
+
allowed_base_dir: str | Path | None = None,
|
|
264
|
+
) -> None
|
|
265
|
+
```
|
|
266
|
+
|
|
267
|
+
**Parameters:**
|
|
268
|
+
- `spectral_path`: Path to Spectral CLI executable
|
|
269
|
+
- `ruleset_path`: Path to a custom ruleset file (optional)
|
|
270
|
+
- `timeout`: Maximum execution time in seconds
|
|
271
|
+
- `allowed_base_dir`: Optional base directory for path security validation. When set, all document and ruleset paths are validated to be within this directory, providing defense against path traversal attacks. When `None` (default), only file extension validation is performed (no base directory containment check). Recommended for web services or untrusted input (optional)
|
|
272
|
+
|
|
273
|
+
**Methods:**
|
|
274
|
+
|
|
275
|
+
- `accepts() -> list[Literal["uri", "dict"]]`: Returns supported document format identifiers
|
|
276
|
+
- `validate(document: str | dict) -> ValidationResult`: Validates an OpenAPI document
|
|
277
|
+
|
|
278
|
+
**Exceptions:**
|
|
279
|
+
- `FileNotFoundError`: Custom ruleset file doesn't exist
|
|
280
|
+
- `RuntimeError`: Spectral execution fails
|
|
281
|
+
- `SubprocessExecutionError`: Spectral times out or fails to start
|
|
282
|
+
- `TypeError`: Unsupported document type
|
|
283
|
+
- `PathTraversalError`: Document or ruleset path attempts to escape allowed_base_dir (only when `allowed_base_dir` is set)
|
|
284
|
+
- `InvalidExtensionError`: Document or ruleset path has disallowed file extension (always checked for filesystem paths)
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
jentic/apitools/openapi/validator/backends/spectral/__init__.py,sha256=NJu1BW8xEDEtRg6-zLOn8RORffK0siDcmmHrg655oyc,9944
|
|
2
|
+
jentic/apitools/openapi/validator/backends/spectral/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
3
|
+
jentic/apitools/openapi/validator/backends/spectral/rulesets/spectral.yaml,sha256=0Xpn8s3gmnFSyJuoHG6DOF-DUTi_MSICU7w2NmVx1EI,50
|
|
4
|
+
jentic_openapi_validator_spectral-1.0.0a10.dist-info/licenses/LICENSE,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
|
|
5
|
+
jentic_openapi_validator_spectral-1.0.0a10.dist-info/licenses/NOTICE,sha256=pAOGW-rGw9KNc2cuuLWZkfx0GSTV4TicbgBKZSLPMIs,168
|
|
6
|
+
jentic_openapi_validator_spectral-1.0.0a10.dist-info/WHEEL,sha256=eh7sammvW2TypMMMGKgsM83HyA_3qQ5Lgg3ynoecH3M,79
|
|
7
|
+
jentic_openapi_validator_spectral-1.0.0a10.dist-info/entry_points.txt,sha256=wX6fY9EUdVYGKuiUy_f1G7qDixRSmXjJu7x61kD-Kr4,134
|
|
8
|
+
jentic_openapi_validator_spectral-1.0.0a10.dist-info/METADATA,sha256=N5RVroVXom54DszgmmGsP4l2dSmeTPq81vpnpfDmUU0,8730
|
|
9
|
+
jentic_openapi_validator_spectral-1.0.0a10.dist-info/RECORD,,
|
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|