From 1cd5ebeeaaf30792afde74ca9e17e941dc6fcb37 Mon Sep 17 00:00:00 2001 From: Diogo Sousa Date: Tue, 25 Jul 2023 18:45:33 +0100 Subject: [PATCH] add descriptions to cpi data --- .../sdk/provider/openbb_provider/models/cpi.py | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/openbb_sdk/sdk/provider/openbb_provider/models/cpi.py b/openbb_sdk/sdk/provider/openbb_provider/models/cpi.py index bc949577aa1..999bf53fcd3 100644 --- a/openbb_sdk/sdk/provider/openbb_provider/models/cpi.py +++ b/openbb_sdk/sdk/provider/openbb_provider/models/cpi.py @@ -4,7 +4,7 @@ from typing import List, Literal, Optional from pydantic import Field, validator from openbb_provider.abstract.data import Data, QueryParams -from openbb_provider.metadata import QUERY_DESCRIPTIONS +from openbb_provider.metadata import DATA_DESCRIPTIONS, QUERY_DESCRIPTIONS CPI_COUNTRIES = Literal[ "australia", @@ -85,10 +85,14 @@ class CPIQueryParams(QueryParams): class CPIData(Data): - date: dateType - realtime_start: dateType - realtime_end: dateType - value: float + date: dateType = Field(description=DATA_DESCRIPTIONS.get("date")) + realtime_start: dateType = Field( + description="The date the data was updated." + ) # TODO: What is this? + realtime_end: dateType = Field( + description="The date the data was updated." + ) # TODO: What is this? + value: float = Field(description="The value of the data.") @validator("value", pre=True) def value_validate(cls, v: str): # pylint: disable=E0213