alpacahq / bkdocs Goto Github PK

We are generating code to produce and parse messages from SSE, but it seems like Trade Events are missing:

https://alpaca.markets/docs/broker/api-references/events/#trade-updates

This should be boolean

Was this intentional? When using the openapi generator in go, this turns into a struct field without a name (immediate syntax error)

The AccountStatus.EDITED status described in the docs is missing from the spec at https://github.com/alpacahq/bkdocs/blob/master/assets/openapi.yaml#L154.

I believe this endpoint is missing from the yaml:
https://alpaca.markets/docs/broker/api-references/trading/portfolio-history/

When calling GET /v1/calendar it's not behave as explained in documentation:

1. Array of Calendar objects is returned instead of "The calendar object" as written in documentation
2. Holidays\weekends skipped in the response, i.e. query which will include the weekend won't return weekend dates as Calendar objects. Expected and more logical behavior would be to return the Calendar object with empty open and close fields or add explicit checkbox is_market_open. It will be nice if the fact that API skip days would be added to documentation.
3. If API queried with start and end dates of the filter set on weekend, for example start=2021-01-08 end=2021-01-09 the result will contain only one record which will be the next day when markets will be open. This behavior is not explained at all, it's unclear if it's intended or not.

On this page https://alpaca.markets/docs/broker/integration/ there is a link for Going Live which points to https://alpaca.markets/docs/integration/#going-live and it currently 404s

In this file https://github.com/alpacahq/bkdocs/blob/master/content/integration/_index.md

To go live, we will onboard you for the business integration. For more details
of this step, please refer to [Going Live](/docs/integration/#going-live)

Endpoint: POST /v1/accounts/{account_id}/documents/upload

Issue:
The endpoint accepts an array of models.DocumentUpload, and this document_upload needs to be removed from the doc.

Reference:

Looks like AccountStatusEvent doesn't have an event id:

https://github.com/alpacahq/bkdocs/blob/master/assets/openapi.yaml#L1818-L1838

Whereas the docs indicate it should:

https://alpaca.markets/docs/broker/api-references/events/#response

When using the OpenAPI yaml, a nullable field is expected to not exist if it is null. If instead it is "fieldName": null, the generated code (for example, in Go) will treat it like this: {"value": null, "exists:" true}, which is an odd and unexpected outcome.

But the parameter list says it's string