Skip to content
Speccy

The markdown files under the source that the scan passed over, with a guessed doc type each (REQ-133).

GET
/github/sources/{sourceId}/skipped
curl --request GET \
  --url https://example.com/api/v1/github/sources/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/skipped

Parameters

Section titled “ Parameters ”

Path Parameters

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

Responses

Section titled “ Responses ”

200

Section titled “200”

The skipped docs, in path order, at most 200.

Media typeapplication/json
object
items
required
Array<object>
object
path
required

The file’s path in the repo.

string
guess

The doc type Speccy reads from the headings. Absent when it is not sure.

string
adopted
required

The doc type a person already accepted for this path. Empty when none.

string
total
required

How many files the scan passed over. More than the list holds means the source covers too much.

integer
Examplegenerated
{
  "items": [
    {
      "path": "example",
      "guess": "example",
      "adopted": "example"
    }
  ],
  "total": 1
}

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"
}