feature: fix openapi schema (ran-isenberg#800)

 --------- Co-authored-by: Ran Isenberg <ran.isenberg@ranthebuilder.cloud>

Author: ran-isenberg

docs/swagger/openapi.json

@@ -76,7 +76,6 @@
  },
  "item_count": {
  "type": "integer",
- "exclusiveMinimum": 0.0,
  "title": "Item Count",
  "description": "Amount of items in order"
  },
@@ -107,7 +106,6 @@
  },
  "order_item_count": {
  "type": "integer",
- "exclusiveMinimum": 0.0,
  "title": "Order Item Count",
  "description": "Amount of items in order"
  }
@@ -171,23 +169,16 @@
  "description": "Error type"
  },
  "msg": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
+ "type": "string",
  "title": "Msg",
- "description": "Error message"
+ "description": "Error message",
+ "default": ""
  }
  },
  "type": "object",
  "required": [
  "loc",
- "type",
- "msg"
+ "type"
  ],
  "title": "PydanticError"
  }

package-lock.json

@@ -1,5 +1,5 @@
 {
  "dependencies": {
- "aws-cdk": "2.125.0"
+ "aws-cdk": "2.126.0"
  }
 }

package.json

@@ -1,8 +1,17 @@
 from typing import Annotated
 
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, Field, field_validator
 
 
 class CreateOrderRequest(BaseModel):
  customer_name: Annotated[str, Field(min_length=1, max_length=20, description='Customer name')]
- order_item_count: Annotated[int, Field(gt=0, description='Amount of items in order')]
+ order_item_count: Annotated[int, Field(strict=True, description='Amount of items in order')]
+
+ @field_validator('order_item_count')
+ @classmethod
+ def check_order_item_count(cls, v):
+ # we don't use Field(gt=0) because pydantic exports it incorrectly to openAPI doc
+ # see https://github.com/tiangolo/fastapi/issues/240
+ if v <= 0:
+ raise ValueError('order_item_count must be larger than 0')
+ return v

poetry.lock

@@ -1,7 +1,7 @@
 from typing import Annotated
 from uuid import UUID
 
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, Field, field_validator
 from pydantic.functional_validators import AfterValidator
 
 
@@ -36,5 +36,14 @@ def validate_product_id(product_id: str) -> str:
 
 class Order(BaseModel):
  name: Annotated[str, Field(min_length=1, max_length=20, description='Customer name')]
- item_count: Annotated[int, Field(gt=0, description='Amount of items in order')]
+ item_count: Annotated[int, Field(strict=True, description='Amount of items in order')]
  id: OrderId
+
+ @field_validator('item_count')
+ @classmethod
+ def check_item_count(cls, v):
+ # we don't use Field(gt=0) because pydantic exports it incorrectly to openAPI doc
+ # see https://github.com/tiangolo/fastapi/issues/240
+ if v <= 0:
+ raise ValueError('item_count must be larger than 0')
+ return v

service/models/input.py

@@ -1,4 +1,4 @@
-from typing import Annotated, List, Optional, Union
+from typing import Annotated, List, Union
 
 from pydantic import BaseModel, Field
 
@@ -19,7 +19,7 @@ class InternalServerErrorOutput(BaseModel):
 class PydanticError(BaseModel):
  loc: Annotated[List[Union[str, int]], Field(description='Error location')]
  type: Annotated[str, Field(description='Error type')]
- msg: Annotated[Optional[str], Field(description='Error message')]
+ msg: Annotated[str, Field(description='Error message')] = ''
 
 
 class InvalidRestApiRequest(BaseModel):

service/models/order.py

@@ -36,7 +36,17 @@ def test_missing_mandatory_fields():
 def test_invalid_order_number():
  # Given: An invalid negative order_item_count
  customer_name = 'a'
- order_item_count = -1
+ order_item_count = 0
+
+ # When & Then: CreateOrderRequest is initialized, expect a ValidationError
+ with pytest.raises(ValidationError):
+ CreateOrderRequest(customer_name=customer_name, order_item_count=order_item_count)
+
+
+def test_invalid_order_number_float():
+ # Given: An invalid float number order_item_count
+ customer_name = 'a'
+ order_item_count = 3.14
 
  # When & Then: CreateOrderRequest is initialized, expect a ValidationError
  with pytest.raises(ValidationError):

service/models/output.py

@@ -1,13 +1,13 @@
 import uuid
-from datetime import datetime
+from datetime import datetime, timezone
 
 import pytest
 from aws_lambda_powertools.utilities.parser import ValidationError
 
 from service.dal.models.db import OrderEntry
 
 order_id = str(uuid.uuid4())
-created_at = int(datetime.utcnow().timestamp())
+created_at = int(datetime.now(timezone.utc).timestamp())
 
 
 def test_invalid_items_type():