Closed
Description
Good day! I use OpenAPI 3.0.0 schema and it stopped working with properties that have writeOnly and default at the same time.
A simple code snippet:
import json
from openapi_spec_validator import validate_spec
data = json.loads('''{
"openapi": "3.0.0",
"info": {
"version": "1.0.0",
"title": ""
},
"servers": [],
"paths": {
"/pets": {
"post": {
"summary": "Create a pet",
"tags": [],
"responses": {
"201": {
"description": "Null response"
}
}
}
}
},
"components": {
"schemas": {
"Pet": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"write_only": {
"type": "string",
"writeOnly": true,
"default": "hello"
}
}
}
}
}
}''')
validate_spec(data)
The error:
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
File "/usr/local/lib/python3.10/site-packages/openapi_spec_validator/shortcuts.py", line 19, in validate_spec
return validator.validate(spec, base_uri=base_uri, spec_url=spec_url)
File "/usr/local/lib/python3.10/site-packages/openapi_spec_validator/validation/proxies.py", line 34, in validate
raise err
openapi_spec_validator.validation.exceptions.OpenAPIValidationError: Tried to read write-only property with hello
Failed validating 'writeOnly' in schema:
{'default': 'hello', 'type': 'string', 'writeOnly': True}
On instance:
'hello'
As I understood the root cause is here python-openapi/openapi-schema-validator#85
As a workaround, I made a custom validator that uses OAS30WriteValidator:
from functools import partial
from jsonschema.validators import Draft4Validator
from openapi_spec_validator.schemas import schema_v30
from lazy_object_proxy import Proxy
from openapi_spec_validator.validation.validators import SpecValidator
from openapi_schema_validator import oas30_format_checker
from jsonschema_spec.handlers import default_handlers
from openapi_schema_validator.validators import OAS30WriteValidator
get_openapi_v30_schema_validator = partial(Draft4Validator, schema_v30)
openapi_v30_schema_validator = Proxy(get_openapi_v30_schema_validator)
get_openapi_v30_spec_validator = partial(
SpecValidator,
openapi_v30_schema_validator,
OAS30WriteValidator,
oas30_format_checker,
resolver_handlers=default_handlers,
)
openapi_v30_spec_validator = Proxy(get_openapi_v30_spec_validator)
validate_spec(data, validator=openapi_v30_spec_validator)
Shouldn't it be replaced in openapi-spec-validator?