Support for scientific notation
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 35/100
- Issue type
- Bug
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- python
- Domain
- backend-api-design
Research direction
Start with the supplied OpenAPI 3.0.3 schema and its maximum: 1e2 value, comparing it with the equivalent maximum: 100 case. Trace how the validator handles the scientific-notation value, then verify that the reported schema validates without weakening the numeric constraint checks.
Written by the indexing model from the issue text.
Description
This schema with scientific notation maximum: 1e2
openapi: 3.0.3
info:
title: scientific notation
description: ...
version: 1.0.0
paths:
/pet:
put:
tags:
- pet
summary: ...
description: ...
operationId: updatePet
requestBody:
description: ...
content:
application/json:
schema:
$ref: '#/components/schemas/Pet'
responses:
'200':
description: Successful operation
components:
schemas:
Pet:
type: object
properties:
id:
type: integer
format: int64
maximum: 1e2
example: 10
results in this unexpected failure
# Validation Error
{'description': '...', 'content': {'application/json': {'schema': {'type': 'object', 'properties': {'id': {'type': 'integer', 'format': 'int64', 'maximum': '1e2', 'example': 10}}}}}} is not valid under any of the given schemas
Failed validating 'oneOf' in schema['properties']['paths']['patternProperties']['^\\/']['patternProperties']['^(get|put|post|delete|options|head|patch|trace)$']['properties']['requestBody']:
{'oneOf': [{'$ref': '#/definitions/RequestBody'},
{'$ref': '#/definitions/Reference'}]}
On instance['paths']['/pet']['put']['requestBody']:
{'content': {'application/json': {'schema': {'properties': {'id': {'example': 10,
'format': 'int64',
'maximum': '1e2',
'type': 'integer'}},
'type': 'object'}}},
'description': '...'}
# Due to one of those errors
## {'type': 'object', 'properties': {'id': {'type': 'integer', 'format': 'int64', 'maximum': '1e2', 'example': 10}}} is not valid under any of the given schemas
Failed validating 'oneOf' in schema[0]['properties']['content']['additionalProperties']['properties']['schema']:
{'oneOf': [{'$ref': '#/definitions/Schema'},
{'$ref': '#/definitions/Reference'}]}
On instance['content']['application/json']['schema']:
{'properties': {'id': {'example': 10,
'format': 'int64',
'maximum': '1e2',
'type': 'integer'}},
'type': 'object'}
## '$ref' is a required property
Failed validating 'required' in schema[1]:
{'patternProperties': {'^\\$ref$': {'format': 'uri-reference',
'type': 'string'}},
'required': ['$ref'],
'type': 'object'}
On instance:
{'content': {'application/json': {'schema': {'properties': {'id': {'example': 10,
'format': 'int64',
'maximum': '1e2',
'type': 'integer'}},
'type': 'object'}}},
'description': '...'}
...
If I change maximum: 1e2 to maximum: 100, it validates without error.
- Dominant language
- Python
- Stars
- 126
- Forks
- 36
- PR merge metrics
- No merged PRs in 30d
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Similar issues
-
Add: hunch Open
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
AbdelStark/awesome-typesafe#104 ·
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
DiamondLightSource/dodal#2211 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
openml/openml-python#1749 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
sipyourdrink-ltd/bernstein#6191 ·