List Deployments and List Workspaces API examples are wrong

[chobberoni]

Issue Type

Inaccurate, misleading, or out-of-date information

Links to Affected Docs

• List Deployments: https://docs.astronomer.io/api/platform-api-reference/deployment/list-deployments
• https://docs.astronomer.io/api/platform-api-reference/workspace/list-workspaces

The Issue or Context

• The List Deployments API to list multiple deployments.
  • Same for List Workspaces
• It works fine for a single deployment, but sending multiple deployment IDs in a list does not work
• The code builder example also returns the wrong curl command

Fix or Proposed Change

curl --location 'https://api.astronomer.io/platform/v1beta1/organizations/cknaqyipv05731evsry6cj4n0/deployments?deploymentIds=clxiokiiq0xhc01o2aw5b4z4i&deploymentIds=clxirnzdv0xx001o2lopjotz9' \
--header 'Authorization: Bearer YOUR_TOKEN_HERE'

Note: this does not match the API standard template we provided in our docs. This is a different formatting.

Additional Notes

Slack Thread: https://astronomer.slack.com/archives/C01UA03TPV1/p1719853949848309

Required Reviewers

Alex Liotta, Frank Ye

[aliotta]

really this is the same for any string[] query param we have in the api. So maybe we need to have a high level description of how to use string[]'s?