mirror of
https://github.com/hydrosquall/tiingo-python.git
synced 2026-01-14 16:54:46 +01:00
feat: add CI check for valid API spec + remove unsupported sections
This commit is contained in:
Cameron Yick
@@ -2,6 +2,9 @@
|
||||
# This file provides a centralized index of all schema components across the Tiingo API
|
||||
# organized by endpoint category. Each schema is defined with a YAML anchor and references
|
||||
# the actual schema definition from its respective file.
|
||||
#
|
||||
# NOTE: Schema references are commented out until their corresponding schema files are created.
|
||||
# Each PR that adds a schema file should uncomment its section.
|
||||
|
||||
# ========================================================================
|
||||
# COMMON SCHEMAS - Shared across all endpoints
|
||||
@@ -27,142 +30,151 @@ ErrorResponse: &ErrorResponse
|
||||
# END-OF-DAY STOCK PRICE SCHEMAS
|
||||
# Reference: https://www.tiingo.com/documentation/end-of-day
|
||||
# File: ./eod-schemas.yaml
|
||||
# TODO: Uncomment when ./eod-schemas.yaml is created
|
||||
# ========================================================================
|
||||
|
||||
PriceData: &PriceData
|
||||
$ref: './eod-schemas.yaml#/PriceData'
|
||||
|
||||
TickerMetadata: &TickerMetadata
|
||||
$ref: './eod-schemas.yaml#/TickerMetadata'
|
||||
# PriceData: &PriceData
|
||||
# $ref: './eod-schemas.yaml#/PriceData'
|
||||
#
|
||||
# TickerMetadata: &TickerMetadata
|
||||
# $ref: './eod-schemas.yaml#/TickerMetadata'
|
||||
|
||||
# ========================================================================
|
||||
# NEWS API SCHEMAS
|
||||
# File: ./news-schemas.yaml
|
||||
# TODO: Uncomment when ./news-schemas.yaml is created
|
||||
# ========================================================================
|
||||
|
||||
NewsArticle: &NewsArticle
|
||||
$ref: './news-schemas.yaml#/NewsArticle'
|
||||
|
||||
BulkDownloadFile: &BulkDownloadFile
|
||||
$ref: './news-schemas.yaml#/BulkDownloadFile'
|
||||
# NewsArticle: &NewsArticle
|
||||
# $ref: './news-schemas.yaml#/NewsArticle'
|
||||
#
|
||||
# BulkDownloadFile: &BulkDownloadFile
|
||||
# $ref: './news-schemas.yaml#/BulkDownloadFile'
|
||||
|
||||
# ========================================================================
|
||||
# CRYPTOCURRENCY API SCHEMAS
|
||||
# File: ./crypto-schemas.yaml
|
||||
# TODO: Uncomment when ./crypto-schemas.yaml is created
|
||||
# ========================================================================
|
||||
|
||||
CryptoCurrency: &CryptoCurrency
|
||||
$ref: './crypto-schemas.yaml#/CryptoCurrency'
|
||||
|
||||
CryptoTicker: &CryptoTicker
|
||||
$ref: './crypto-schemas.yaml#/CryptoTicker'
|
||||
|
||||
ResampleFreq: &ResampleFreq
|
||||
$ref: './crypto-schemas.yaml#/ResampleFreq'
|
||||
|
||||
PriceDataItem: &PriceDataItem
|
||||
$ref: './crypto-schemas.yaml#/PriceDataItem'
|
||||
|
||||
ExchangeDataItem: &ExchangeDataItem
|
||||
$ref: './crypto-schemas.yaml#/ExchangeDataItem'
|
||||
|
||||
CryptoPrice: &CryptoPrice
|
||||
$ref: './crypto-schemas.yaml#/CryptoPrice'
|
||||
|
||||
CryptoMetadata: &CryptoMetadata
|
||||
$ref: './crypto-schemas.yaml#/CryptoMetadata'
|
||||
|
||||
TopOfBookData: &TopOfBookData
|
||||
$ref: './crypto-schemas.yaml#/TopOfBookData'
|
||||
|
||||
TopOfBookExchangeData: &TopOfBookExchangeData
|
||||
$ref: './crypto-schemas.yaml#/TopOfBookExchangeData'
|
||||
|
||||
CryptoTopOfBook: &CryptoTopOfBook
|
||||
$ref: './crypto-schemas.yaml#/CryptoTopOfBook'
|
||||
# CryptoCurrency: &CryptoCurrency
|
||||
# $ref: './crypto-schemas.yaml#/CryptoCurrency'
|
||||
#
|
||||
# CryptoTicker: &CryptoTicker
|
||||
# $ref: './crypto-schemas.yaml#/CryptoTicker'
|
||||
#
|
||||
# ResampleFreq: &ResampleFreq
|
||||
# $ref: './crypto-schemas.yaml#/ResampleFreq'
|
||||
#
|
||||
# PriceDataItem: &PriceDataItem
|
||||
# $ref: './crypto-schemas.yaml#/PriceDataItem'
|
||||
#
|
||||
# ExchangeDataItem: &ExchangeDataItem
|
||||
# $ref: './crypto-schemas.yaml#/ExchangeDataItem'
|
||||
#
|
||||
# CryptoPrice: &CryptoPrice
|
||||
# $ref: './crypto-schemas.yaml#/CryptoPrice'
|
||||
#
|
||||
# CryptoMetadata: &CryptoMetadata
|
||||
# $ref: './crypto-schemas.yaml#/CryptoMetadata'
|
||||
#
|
||||
# TopOfBookData: &TopOfBookData
|
||||
# $ref: './crypto-schemas.yaml#/TopOfBookData'
|
||||
#
|
||||
# TopOfBookExchangeData: &TopOfBookExchangeData
|
||||
# $ref: './crypto-schemas.yaml#/TopOfBookExchangeData'
|
||||
#
|
||||
# CryptoTopOfBook: &CryptoTopOfBook
|
||||
# $ref: './crypto-schemas.yaml#/CryptoTopOfBook'
|
||||
|
||||
# ========================================================================
|
||||
# FOREX API SCHEMAS
|
||||
# File: ./forex-schemas.yaml
|
||||
# TODO: Uncomment when ./forex-schemas.yaml is created
|
||||
# ========================================================================
|
||||
|
||||
ForexTopOfBook: &ForexTopOfBook
|
||||
$ref: './forex-schemas.yaml#/ForexTopOfBook'
|
||||
|
||||
ForexPrice: &ForexPrice
|
||||
$ref: './forex-schemas.yaml#/ForexPrice'
|
||||
# ForexTopOfBook: &ForexTopOfBook
|
||||
# $ref: './forex-schemas.yaml#/ForexTopOfBook'
|
||||
#
|
||||
# ForexPrice: &ForexPrice
|
||||
# $ref: './forex-schemas.yaml#/ForexPrice'
|
||||
|
||||
# ========================================================================
|
||||
# IEX EXCHANGE API SCHEMAS
|
||||
# Reference: https://api.tiingo.com/documentation/iex
|
||||
# File: ./iex-schemas.yaml
|
||||
# TODO: Uncomment when ./iex-schemas.yaml is created
|
||||
# ========================================================================
|
||||
|
||||
IEXTopOfBook: &IEXTopOfBook
|
||||
$ref: './iex-schemas.yaml#/IEXTopOfBook'
|
||||
|
||||
IEXPrice: &IEXPrice
|
||||
$ref: './iex-schemas.yaml#/IEXPrice'
|
||||
# IEXTopOfBook: &IEXTopOfBook
|
||||
# $ref: './iex-schemas.yaml#/IEXTopOfBook'
|
||||
#
|
||||
# IEXPrice: &IEXPrice
|
||||
# $ref: './iex-schemas.yaml#/IEXPrice'
|
||||
|
||||
# ========================================================================
|
||||
# FUNDAMENTALS API SCHEMAS
|
||||
# File: ./fundamentals-schemas.yaml
|
||||
# TODO: Uncomment when ./fundamentals-schemas.yaml is created
|
||||
# ========================================================================
|
||||
|
||||
FundamentalDefinition: &FundamentalDefinition
|
||||
$ref: './fundamentals-schemas.yaml#/FundamentalDefinition'
|
||||
|
||||
DataPoint: &DataPoint
|
||||
$ref: './fundamentals-schemas.yaml#/DataPoint'
|
||||
|
||||
StatementData: &StatementData
|
||||
$ref: './fundamentals-schemas.yaml#/StatementData'
|
||||
|
||||
FinancialStatement: &FinancialStatement
|
||||
$ref: './fundamentals-schemas.yaml#/FinancialStatement'
|
||||
|
||||
DailyMetric: &DailyMetric
|
||||
$ref: './fundamentals-schemas.yaml#/DailyMetric'
|
||||
|
||||
FundamentalMeta: &FundamentalMeta
|
||||
$ref: './fundamentals-schemas.yaml#/FundamentalMeta'
|
||||
# FundamentalDefinition: &FundamentalDefinition
|
||||
# $ref: './fundamentals-schemas.yaml#/FundamentalDefinition'
|
||||
#
|
||||
# DataPoint: &DataPoint
|
||||
# $ref: './fundamentals-schemas.yaml#/DataPoint'
|
||||
#
|
||||
# StatementData: &StatementData
|
||||
# $ref: './fundamentals-schemas.yaml#/StatementData'
|
||||
#
|
||||
# FinancialStatement: &FinancialStatement
|
||||
# $ref: './fundamentals-schemas.yaml#/FinancialStatement'
|
||||
#
|
||||
# DailyMetric: &DailyMetric
|
||||
# $ref: './fundamentals-schemas.yaml#/DailyMetric'
|
||||
#
|
||||
# FundamentalMeta: &FundamentalMeta
|
||||
# $ref: './fundamentals-schemas.yaml#/FundamentalMeta'
|
||||
|
||||
# ========================================================================
|
||||
# MUTUAL FUNDS AND ETF SCHEMAS
|
||||
# Reference: /docs/api_extracted/mutual-fund-etf-fees.md
|
||||
# File: ./funds-schemas.yaml
|
||||
# TODO: Uncomment when ./funds-schemas.yaml is created
|
||||
# ========================================================================
|
||||
|
||||
OtherShareClass: &OtherShareClass
|
||||
$ref: './funds-schemas.yaml#/OtherShareClass'
|
||||
|
||||
FundOverview: &FundOverview
|
||||
$ref: './funds-schemas.yaml#/FundOverview'
|
||||
|
||||
CustomFee: &CustomFee
|
||||
$ref: './funds-schemas.yaml#/CustomFee'
|
||||
|
||||
FundMetrics: &FundMetrics
|
||||
$ref: './funds-schemas.yaml#/FundMetrics'
|
||||
# OtherShareClass: &OtherShareClass
|
||||
# $ref: './funds-schemas.yaml#/OtherShareClass'
|
||||
#
|
||||
# FundOverview: &FundOverview
|
||||
# $ref: './funds-schemas.yaml#/FundOverview'
|
||||
#
|
||||
# CustomFee: &CustomFee
|
||||
# $ref: './funds-schemas.yaml#/CustomFee'
|
||||
#
|
||||
# FundMetrics: &FundMetrics
|
||||
# $ref: './funds-schemas.yaml#/FundMetrics'
|
||||
|
||||
# ========================================================================
|
||||
# DIVIDENDS AND DISTRIBUTIONS SCHEMAS
|
||||
# File: ./dividends-schemas.yaml
|
||||
# TODO: Uncomment when ./dividends-schemas.yaml is created
|
||||
# ========================================================================
|
||||
|
||||
Distribution: &Distribution
|
||||
$ref: './dividends-schemas.yaml#/Distribution'
|
||||
|
||||
DistributionYield: &DistributionYield
|
||||
$ref: './dividends-schemas.yaml#/DistributionYield'
|
||||
# Distribution: &Distribution
|
||||
# $ref: './dividends-schemas.yaml#/Distribution'
|
||||
#
|
||||
# DistributionYield: &DistributionYield
|
||||
# $ref: './dividends-schemas.yaml#/DistributionYield'
|
||||
|
||||
# ========================================================================
|
||||
# STOCK SPLITS SCHEMAS
|
||||
# File: ./splits-schemas.yaml
|
||||
# TODO: Uncomment when ./splits-schemas.yaml is created
|
||||
# ========================================================================
|
||||
|
||||
Split: &Split
|
||||
$ref: './splits-schemas.yaml#/Split'
|
||||
|
||||
SplitArray: &SplitArray
|
||||
$ref: './splits-schemas.yaml#/SplitArray'
|
||||
# Split: &Split
|
||||
# $ref: './splits-schemas.yaml#/Split'
|
||||
#
|
||||
# SplitArray: &SplitArray
|
||||
# $ref: './splits-schemas.yaml#/SplitArray'
|
||||
|
||||
Reference in New Issue
Block a user