Skip to content
Speccy

Rename or move a file inside the bundle. Creates a version (REQ-005).

POST
/docs/{docId}/files/rename
curl --request POST \
  --url https://example.com/api/v1/docs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/files/rename \
  --header 'Content-Type: application/json' \
  --data '{ "from": "example", "to": "example", "base_version": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
docId
required
string format: uuid

The ID of one spec doc.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
from
required
string
to
required
string
base_version
required
string format: uuid
Examplegenerated
{
  "from": "example",
  "to": "example",
  "base_version": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Responses

Section titled “ Responses ”

200

Section titled “200”

The version that the change created.

Media typeapplication/json
object
version
required
object
id
required
string format: uuid
number
required
integer format: int64
created_by
required
string
message
required
string
created_at
required
string format: date-time
changed
required

False when the write left the bundle unchanged, so no version was created.

boolean
Examplegenerated
{
  "version": {
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "number": 1,
    "created_by": "example",
    "message": "example",
    "created_at": "2026-04-15T12:00:00Z"
  },
  "changed": true
}

default

Section titled “default”

An error.

Media typeapplication/problem+json

RFC 9457 problem details with a stable code.

object
type
required
string
title
required
string
status
required
integer
detail
string
instance
string
code
required

A stable machine-readable error code.

string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "code": "example"
}