Skip to content

Conversation

@justinpolygon
Copy link
Collaborator

@justinpolygon justinpolygon commented Nov 20, 2025

Description

Sync with latest 2025-11-19 openapi spec. Also scrubbed references of Polygon. There are many line changes here since when you update the spec is moves lots of stuff around. So, most of these are not even changes.

Related Issue

https://linear.app/massive-com/issue/DVX-1134/republish-client-js-library

How Has This Been Tested?

Built the package and tested with Docker.

Copy link
Contributor

@penelopus penelopus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@justinpolygon — since there are some renamed objects in this PR (namely, websocket interfaces), this seems to be a breaking change and would require a bump to v10, rather than a minor version update to v9.1

also a couple of other comments herein

Comment on lines +34 to +35
// Skip paths starting with /v1/reference/
if (path.startsWith('/v1/reference/')) continue;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
// Skip paths starting with /v1/reference/
if (path.startsWith('/v1/reference/')) continue;

@justinpolygon — why is this exclusion necessary?

in today's api, there are 4 endpoints w/ this pattern (/v1/reference/sec/filings...), and each currently include the x-polygon-draft flag (which is captured by the preceding rule)

what happens when the x-polygon-draft flag is removed from those v1 endpoints?

i recommend removing this exception

Copy link
Collaborator Author

@justinpolygon justinpolygon Nov 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @penelopus, in the spec https://api.polygon.io/openapi there are a handful of internal endpoints for sec filings etc hanging off /v1/reference. So, It was just to exclude those from the library. No one has access to them so doesn't make sense to generate functions/examples since no one can use them.

I'll test it. Maybe we don't need both. I'll check back shortly.

"stock api",
"options api",
"forex api",
"crypto api"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this should also include "futures api" to reflect recent updates

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll get that added. Good catch.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants