polygon-io / client-go

The official Go client library for the Polygon REST and WebSocket API.
MIT License
127 stars 36 forks source link

Client update needed to match REST spec changes #400

Closed client-library-maintainer[bot] closed 5 months ago

client-library-maintainer[bot] commented 5 months ago

A diff between this client library's spec and our hosted spec was found. The client may need an update to match any changes in our API. See the diff below:

--- https://raw.githubusercontent.com/polygon-io/client-go/master/.polygon/rest.json
+++ https://api.polygon.io/openapi
@@ -7007,7 +7007,7 @@
         "operationId": "EMA",
         "parameters": [
           {
-            "description": "The ticker symbol for which to get exponential moving average (EMA) data.",
+            "description": "Specify a case-sensitive ticker symbol for which to get exponential moving average (EMA) data. For example, AAPL represents Apple Inc.",
             "example": "AAPL",
             "in": "path",
             "name": "stockTicker",
@@ -8757,7 +8757,7 @@
         "operationId": "MACD",
         "parameters": [
           {
-            "description": "The ticker symbol for which to get MACD data.",
+            "description": "Specify a case-sensitive ticker symbol for which to get moving average convergence/divergence (MACD) data. For example, AAPL represents Apple Inc.",
             "example": "AAPL",
             "in": "path",
             "name": "stockTicker",
@@ -10375,7 +10375,7 @@
         "operationId": "RSI",
         "parameters": [
           {
-            "description": "The ticker symbol for which to get relative strength index (RSI) data.",
+            "description": "Specify a case-sensitive ticker symbol for which to get relative strength index (RSI) data. For example, AAPL represents Apple Inc.",
             "example": "AAPL",
             "in": "path",
             "name": "stockTicker",
@@ -12015,7 +12015,7 @@
         "operationId": "SMA",
         "parameters": [
           {
-            "description": "The ticker symbol for which to get simple moving average (SMA) data.",
+            "description": "Specify a case-sensitive ticker symbol for which to get simple moving average (SMA) data. For example, AAPL represents Apple Inc.",
             "example": "AAPL",
             "in": "path",
             "name": "stockTicker",
@@ -24822,7 +24822,7 @@
                             "type": "string"
                           },
                           "mic": {
-                            "description": "The Market Identifer Code of this exchange (see ISO 10383).",
+                            "description": "The Market Identifier Code of this exchange (see ISO 10383).",
                             "example": "XASE",
                             "type": "string"
                           },
@@ -25536,7 +25536,7 @@
         "operationId": "ListStockSplits",
         "parameters": [
           {
-            "description": "Return the stock splits that contain this ticker.",
+            "description": "Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc.",
             "in": "query",
             "name": "ticker",
             "schema": {
@@ -25570,7 +25570,7 @@
             }
           },
           {
-            "description": "Search by ticker.",
+            "description": "Range by ticker.",
             "in": "query",
             "name": "ticker.gte",
             "schema": {
@@ -25578,7 +25578,7 @@
             }
           },
           {
-            "description": "Search by ticker.",
+            "description": "Range by ticker.",
             "in": "query",
             "name": "ticker.gt",
             "schema": {
@@ -25586,7 +25586,7 @@
             }
           },
           {
-            "description": "Search by ticker.",
+            "description": "Range by ticker.",
             "in": "query",
             "name": "ticker.lte",
             "schema": {
@@ -25594,7 +25594,7 @@
             }
           },
           {
-            "description": "Search by ticker.",
+            "description": "Range by ticker.",
             "in": "query",
             "name": "ticker.lt",
             "schema": {
@@ -25602,7 +25602,7 @@
             }
           },
           {
-            "description": "Search by execution_date.",
+            "description": "Range by execution_date.",
             "in": "query",
             "name": "execution_date.gte",
             "schema": {
@@ -25611,7 +25611,7 @@
             }
           },
           {
-            "description": "Search by execution_date.",
+            "description": "Range by execution_date.",
             "in": "query",
             "name": "execution_date.gt",
             "schema": {
@@ -25620,7 +25620,7 @@
             }
           },
           {
-            "description": "Search by execution_date.",
+            "description": "Range by execution_date.",
             "in": "query",
             "name": "execution_date.lte",
             "schema": {
@@ -25629,7 +25629,7 @@
             }
           },
           {
-            "description": "Search by execution_date.",
+            "description": "Range by execution_date.",
             "in": "query",
             "name": "execution_date.lt",
             "schema": {