search

scylladb / scylladb-cloud-doc-issues

A repo for Scylla Cloud docs issues
https://cloud.docs.scylladb.com/stable/
1 stars 1 forks source link

API Docs: representing vars in API reference Request samples #14

Closed tzach closed 6 months ago

tzach commented 6 months ago

I would like to report an issue in page like https://cloud.docs.scylladb.com/stable/api.html#tag/Cluster/operation/deleteCluster

Problem

API include an accountId var

https://api.cloud.scylladb.com/account/{accountId}/cluster/{clusterId}/delete

The var looks off in the CURL example, since '{}' is converted to '%7'

image

Here is how it looks in other reference

image

source https://www.cockroachlabs.com/docs/api/cloud/v1#get-/api/scim/v2/Groups/-id-

Suggest a fix

Use {clusterId} in the CURL example as well

annastuchlik commented 6 months ago

This is a duplicate of https://github.com/scylladb/siren-frontend/issues/4099. Fixed with https://github.com/scylladb/scylla-cloud-doc/pull/197. You can check it here: https://cloud.docs.scylladb.com/stable/api.html#tag/Account-Cluster-Network/operation/getVPCPeeringList (and other examples). Closing.