The markdown files the local scan passed over because they name no type (REQ-001). Empty in hosted mode.

GET

/skipped

curl --request GET \
  --url https://example.com/api/v1/skipped

Responses

200

The skipped files, with the profile Speccy guesses for each.

Media typeapplication/json

object

items

required

Array<object>

object

path

required

The file, relative to the served folder.

string

profile

The profile Speccy guesses from the headings. Absent when none fits.

string

Example^generated

{
  "items": [
    {
      "path": "example",
      "profile": "example"
    }
  ]
}

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

Example^generated

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