Skip to content

Commit 7f7ef5d

Browse files
hydrosquallhydrosquall
committed
fix: remove unsupported sections
1 parent a906ce0 commit 7f7ef5d

2 files changed

Lines changed: 181 additions & 158 deletions

File tree

‎openapi/openapi.yaml‎

Lines changed: 78 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -38,108 +38,119 @@ security:
3838
# ============================================================================
3939
# PATHS - API Endpoints
4040
# ============================================================================
41-
paths:
41+
# NOTE: Path references are commented out until their corresponding path files
42+
# are created. Each PR that adds a path file should uncomment its section.
43+
paths: {}
4244
# --------------------------------------------------------------------------
4345
# End-of-Day Endpoints (2 endpoints)
46+
# TODO: Uncomment when ./paths/end-of-day.yaml is created
4447
# --------------------------------------------------------------------------
45-
/tiingo/daily/{ticker}/prices:
46-
$ref: "./paths/end-of-day.yaml#/daily-prices"
47-
48-
/tiingo/daily/{ticker}:
49-
$ref: "./paths/end-of-day.yaml#/daily-meta"
48+
# /tiingo/daily/{ticker}/prices:
49+
# $ref: "./paths/end-of-day.yaml#/daily-prices"
50+
#
51+
# /tiingo/daily/{ticker}:
52+
# $ref: "./paths/end-of-day.yaml#/daily-meta"
5053

5154
# --------------------------------------------------------------------------
5255
# News Endpoints (3 endpoints)
56+
# TODO: Uncomment when ./paths/news.yaml is created
5357
# --------------------------------------------------------------------------
54-
/tiingo/news:
55-
$ref: "./paths/news.yaml#/news"
56-
57-
/tiingo/news/bulk_download:
58-
$ref: "./paths/news.yaml#/bulk-list"
59-
60-
/tiingo/news/bulk_download/{id}:
61-
$ref: "./paths/news.yaml#/bulk-download"
58+
# /tiingo/news:
59+
# $ref: "./paths/news.yaml#/news"
60+
#
61+
# /tiingo/news/bulk_download:
62+
# $ref: "./paths/news.yaml#/bulk-list"
63+
#
64+
# /tiingo/news/bulk_download/{id}:
65+
# $ref: "./paths/news.yaml#/bulk-download"
6266

6367
# --------------------------------------------------------------------------
6468
# Crypto Endpoints (3 endpoints)
69+
# TODO: Uncomment when ./paths/crypto.yaml is created
6570
# --------------------------------------------------------------------------
66-
/tiingo/crypto/prices:
67-
$ref: "./paths/crypto.yaml#/crypto-prices"
68-
69-
/tiingo/crypto:
70-
$ref: "./paths/crypto.yaml#/crypto-meta"
71-
72-
/tiingo/crypto/top:
73-
$ref: "./paths/crypto.yaml#/crypto-top"
71+
# /tiingo/crypto/prices:
72+
# $ref: "./paths/crypto.yaml#/crypto-prices"
73+
#
74+
# /tiingo/crypto:
75+
# $ref: "./paths/crypto.yaml#/crypto-meta"
76+
#
77+
# /tiingo/crypto/top:
78+
# $ref: "./paths/crypto.yaml#/crypto-top"
7479

7580
# --------------------------------------------------------------------------
7681
# Forex Endpoints (3 endpoints)
82+
# TODO: Uncomment when ./paths/forex.yaml is created
7783
# --------------------------------------------------------------------------
78-
/tiingo/fx/{ticker}:
79-
$ref: "./paths/forex.yaml#/forex-single"
80-
81-
/tiingo/fx/top:
82-
$ref: "./paths/forex.yaml#/forex-top"
83-
84-
/tiingo/fx/{ticker}/prices:
85-
$ref: "./paths/forex.yaml#/forex-prices"
84+
# /tiingo/fx/{ticker}:
85+
# $ref: "./paths/forex.yaml#/forex-single"
86+
#
87+
# /tiingo/fx/top:
88+
# $ref: "./paths/forex.yaml#/forex-top"
89+
#
90+
# /tiingo/fx/{ticker}/prices:
91+
# $ref: "./paths/forex.yaml#/forex-prices"
8692

8793
# --------------------------------------------------------------------------
8894
# IEX Endpoints (3 endpoints)
95+
# TODO: Uncomment when ./paths/iex.yaml is created
8996
# --------------------------------------------------------------------------
90-
/iex:
91-
$ref: "./paths/iex.yaml#/iex-all"
92-
93-
/iex/{ticker}:
94-
$ref: "./paths/iex.yaml#/iex-single"
95-
96-
/iex/{ticker}/prices:
97-
$ref: "./paths/iex.yaml#/iex-prices"
97+
# /iex:
98+
# $ref: "./paths/iex.yaml#/iex-all"
99+
#
100+
# /iex/{ticker}:
101+
# $ref: "./paths/iex.yaml#/iex-single"
102+
#
103+
# /iex/{ticker}/prices:
104+
# $ref: "./paths/iex.yaml#/iex-prices"
98105

99106
# --------------------------------------------------------------------------
100107
# Fundamentals Endpoints (4 endpoints)
108+
# TODO: Uncomment when ./paths/fundamentals.yaml is created
101109
# --------------------------------------------------------------------------
102-
/tiingo/fundamentals/definitions:
103-
$ref: "./paths/fundamentals.yaml#/definitions"
104-
105-
/tiingo/fundamentals/{ticker}/statements:
106-
$ref: "./paths/fundamentals.yaml#/statements"
107-
108-
/tiingo/fundamentals/{ticker}/daily:
109-
$ref: "./paths/fundamentals.yaml#/daily"
110-
111-
/tiingo/fundamentals/meta:
112-
$ref: "./paths/fundamentals.yaml#/meta"
110+
# /tiingo/fundamentals/definitions:
111+
# $ref: "./paths/fundamentals.yaml#/definitions"
112+
#
113+
# /tiingo/fundamentals/{ticker}/statements:
114+
# $ref: "./paths/fundamentals.yaml#/statements"
115+
#
116+
# /tiingo/fundamentals/{ticker}/daily:
117+
# $ref: "./paths/fundamentals.yaml#/daily"
118+
#
119+
# /tiingo/fundamentals/meta:
120+
# $ref: "./paths/fundamentals.yaml#/meta"
113121

114122
# --------------------------------------------------------------------------
115123
# Funds Endpoints (2 endpoints)
124+
# TODO: Uncomment when ./paths/funds.yaml is created
116125
# --------------------------------------------------------------------------
117-
/tiingo/funds/{ticker}:
118-
$ref: "./paths/funds.yaml#/fund-overview"
119-
120-
/tiingo/funds/{ticker}/metrics:
121-
$ref: "./paths/funds.yaml#/fund-metrics"
126+
# /tiingo/funds/{ticker}:
127+
# $ref: "./paths/funds.yaml#/fund-overview"
128+
#
129+
# /tiingo/funds/{ticker}/metrics:
130+
# $ref: "./paths/funds.yaml#/fund-metrics"
122131

123132
# --------------------------------------------------------------------------
124133
# Dividends/Distributions Endpoints (3 endpoints)
134+
# TODO: Uncomment when ./paths/dividends.yaml is created
125135
# --------------------------------------------------------------------------
126-
/tiingo/corporate-actions/distributions:
127-
$ref: "./paths/dividends.yaml#/distributions-batch"
128-
129-
/tiingo/corporate-actions/{ticker}/distributions:
130-
$ref: "./paths/dividends.yaml#/distributions-ticker"
131-
132-
/tiingo/corporate-actions/{ticker}/distribution-yield:
133-
$ref: "./paths/dividends.yaml#/distribution-yield"
136+
# /tiingo/corporate-actions/distributions:
137+
# $ref: "./paths/dividends.yaml#/distributions-batch"
138+
#
139+
# /tiingo/corporate-actions/{ticker}/distributions:
140+
# $ref: "./paths/dividends.yaml#/distributions-ticker"
141+
#
142+
# /tiingo/corporate-actions/{ticker}/distribution-yield:
143+
# $ref: "./paths/dividends.yaml#/distribution-yield"
134144

135145
# --------------------------------------------------------------------------
136146
# Splits Endpoints (2 endpoints)
147+
# TODO: Uncomment when ./paths/splits.yaml is created
137148
# --------------------------------------------------------------------------
138-
/tiingo/corporate-actions/splits:
139-
$ref: "./paths/splits.yaml#/splits-batch"
140-
141-
/tiingo/corporate-actions/{ticker}/splits:
142-
$ref: "./paths/splits.yaml#/splits-ticker"
149+
# /tiingo/corporate-actions/splits:
150+
# $ref: "./paths/splits.yaml#/splits-batch"
151+
#
152+
# /tiingo/corporate-actions/{ticker}/splits:
153+
# $ref: "./paths/splits.yaml#/splits-ticker"
143154

144155
# ============================================================================
145156
# COMPONENTS - Reusable definitions

0 commit comments

Comments
 (0)