docs icon indicating copy to clipboard operation
docs copied to clipboard

[Site Bug] Issue with the page: /docs/api/latest/api-reference

Open moodgorning opened this issue 1 month ago • 1 comments

The API endpoint specification for forking services seems to be incorrect. If I copy the provided example for the request body, I receive an error indicating that an invalid JSON is being supplied. I.e. running this:

  curl -X POST "https://console.cloud.timescale.com/public/api/v1/projects/${TIMESCALE_PROJECT_ID}/services/mram5rg6x5/forkService" \
  -H "Authorization: Basic $(echo -n "${TIMESCALE_API_ACCESS_KEY}:${TIMESCALE_API_SECRET_KEY}" | base64)" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "fork-test2",
    "region_code": "eu-central-1",
    "cpu_millis": 1000,
    "memory_gbs": 4
}' 2>&1

produces

{"code":"INVALID_REQUEST","message":"Invalid JSON in request body"}

this however works but it does not specify the fork service size:

source .env && curl -X POST "https://console.cloud.timescale.com/public/api/v1/projects/${TIMESCALE_PROJECT_ID}/services/mram5rg6x5/forkService" \
  -H "Authorization: Basic $(echo -n "${TIMESCALE_API_ACCESS_KEY}:${TIMESCALE_API_SECRET_KEY}" | base64)" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "test-fork-api",
    "fork_strategy": "NOW"
  }' 2>&1

It seems like some undocumented changes were made to the API

[Provide as much detail as you can]

What do the docs say now?

Create a new, independent service by taking a snapshot of an existing one.

Request Body:

{ "name": "fork-test2", "region_code": "eu-central-1", "cpu_millis": 1000, "memory_gbs": 4 }

What should the docs say?

not clear with respect to the instance size spec, but the above given example does not work

Page affected

https://www.tigerdata.com/docs/api/latest/api-reference#fork-a-service

moodgorning avatar Nov 29 '25 03:11 moodgorning