Mark a markdown file as not a spec, so Speccy stops offering to adopt it (REQ-133).
POST
/dismissed-docs
const url = 'https://example.com/api/v1/dismissed-docs';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"path":"example","source_id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/v1/dismissed-docs \ --header 'Content-Type: application/json' \ --data '{ "path": "example", "source_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
path
required
The file’s path, in the repo for a source, or in the served folder.
string
source_id
The source the file belongs to. Absent for a file of the served folder.
string format: uuid
Examplegenerated
{ "path": "example", "source_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}Responses
Section titled “ Responses ”Marked.
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"}