GunSpec

Docs

Resource class for the documentation endpoints. Instantiated internally by the GunSpec client and exposed as client.docs.

Authentifizierung erforderlichExplorer+

Every guide the documentation renders, with the headings each is divided into: what is documented, and the ids and anchors to read it by.

listGuides(): Promise<APIResponse<DocsGuides>>
GET/v1/docs/guides

  • stringHeadererforderlich

    Ihr API-Schlüssel. Authorization: Bearer <key> wird ebenfalls akzeptiert.

  • object

    The response payload.

  • integer

    How many guides there are.

  • object[]

    Every guide, in the order the documentation lists them.

  • string

    The guide's id, passed to the read endpoint.

  • string

    The page's title.

  • string

    The page a reader would open.

  • string

    The opening prose: what the page is about.

  • integer

    The whole page in Markdown, so a caller can tell what reading it costs.

  • object[]

    Every heading on the page, in order.

  • 400VALIDATION_ERRORValidation error
  • 401UNAUTHORIZEDAPI key required
  • 403FORBIDDENValid key, not permitted
  • 429RATE_LIMITEDRate limit exceeded
  • 500INTERNAL_ERRORUnexpected server error

Not yet in the Python SDK.

Mindeststufe
Explorer+
Monatskontingent
200/mo
Anfragerate
10/min
Tageslimit
50

Die Werte gelten für die Mindeststufe dieses Endpunkts. Höhere Stufen erhöhen alle Limits.