René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"validation(openapi-3.1.0) - nullable enums?","articleBody":"I have in an external projects some problems with the openapi-spec-validator.\r\n\r\nIn our project, we happen to generate an property that either has a value from an `enum`, or can be `null.`\r\n\r\nSee: https://github.com/python-openapi/openapi-spec-validator/compare/master...kazie:openapi-spec-validator:test/test-with-enum-string-or-null-property\r\n\r\nI would believe this is valid OpenAPI specification for a field, but the validation fails, as from this project fork when running test:\r\n\r\n```python\r\nopenapi_spec_validator/shortcuts.py:48: in validate\r\n    return v.validate()\r\n        base_uri   = 'file:///home/kazie/src/github/openapi-spec-validator/tests/integration/data/v3.1/petstore.yaml'\r\n        cls        = \u003cclass 'openapi_spec_validator.validation.validators.OpenAPIV31SpecValidator'\u003e\r\n        sp         = SchemaPath('')\r\n        spec       = {'components': {'pathItems': {'PetPath': {'get': {'operationId': 'showPetById', 'parameters': [{...}], 'responses': {'...r'}}, 'summary': 'Create a pet', 'tags': ['pets']}}, '/pets/{petId}': {'$ref': '#/components/pathItems/PetPath'}}, ...}\r\n        v          = \u003copenapi_spec_validator.validation.validators.OpenAPIV31SpecValidator object at 0x782454500440\u003e\r\n_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ \r\n\r\nself = \u003copenapi_spec_validator.validation.validators.OpenAPIV31SpecValidator object at 0x782454500440\u003e\r\n\r\n    def validate(self) -\u003e None:\r\n        for err in self.iter_errors():\r\n\u003e           raise err\r\nE           openapi_spec_validator.validation.exceptions.OpenAPIValidationError: None is not one of ['ALIVE', 'DEAD']\r\nE           \r\nE           Failed validating 'enum' in schema:\r\nE               {'default': None,\r\nE                'description': 'The status of the pet. `null` if current status can '\r\nE                               'not be confirmed.',\r\nE                'enum': ['ALIVE', 'DEAD'],\r\nE                'example': 'ALIVE',\r\nE                'type': ['string', 'null']}\r\nE           \r\nE           On instance:\r\nE               None\r\n\r\nerr        = \u003cOpenAPIValidationError: \"None is not one of ['ALIVE', 'DEAD']\"\u003e\r\nself       = \u003copenapi_spec_validator.validation.validators.OpenAPIV31SpecValidator object at 0x782454500440\u003e\r\n\r\nopenapi_spec_validator/validation/validators.py:71: OpenAPIValidationError\r\n```\r\n\r\nIt is true that `None` is not in the enum `[ ALIVE, DEAD ]`, but it is in the type array as `['string', 'null']` \r\n\r\n---\r\n\r\nSo, do you believe that my specification is just invalid, or do we have a bug on our hands in the validation here? :sweat_smile: \r\n\r\nI came to this when migrating from `OpenAPI 3.0.3` where we migrate from having `nullable: true` into these type arrays.","author":{"url":"https://github.com/kazie","@type":"Person","name":"kazie"},"datePublished":"2024-11-19T16:10:37.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":0},"url":"https://github.com/378/openapi-spec-validator/issues/378"}