Samva
DashboardAPI
Api referenceNewsletterIssues

Check a newsletter issue (Preview)

Preview · Available to selected organizations. Compiles the issue in its layout at the requested revision and returns diagnostics and declared fixtures. Requires newsletters and email.

POST
/v1/newsletters/{id}/issues/check

Compiles the issue in its layout at the requested revision and returns diagnostics and declared fixtures. Requires newsletters and email.

Authorization

apiKey
headerx-api-key<token>

Path Parameters

id*string
Match^nl_[0-9a-hjkmnp-tv-z]{16,24}$

Header Parameters

idempotency-key?|null

Request Body

application/json
  1. body
path*string
Match^(?!.*\\)(?!.*(?:^|\/)\.{1,2}(?:\/|$))(?!.*(?:^|\/)\.git(?:\/|$))(?!.*\p{Cc})issues\/(?:[^/]+\/)*[^/]+\.md$
Lengthlength <= 1024
expectedRevision*string
Length1 <= length <= 1024

Response Body

Success

application/json
  1. response
projectId*TemplateProjectId
Match^tproj_[0-9a-hjkmnp-tv-z]{16,24}$
revision*string
entryPath*|
declaration*|null
issue?
diagnostics*array<>
incompatibilities*array<>
Example Request
import { createClient } from "samva";const samva = createClient({ apiKey: process.env.SAMVA_API_KEY! });const result = await samva.newsletters.issues.check({  "id": "example",  "path": "example",  "expectedRevision": "example"});
Example Response
{  "projectId": "string",  "revision": "string",  "entryPath": "string",  "declaration": {    "codeDigest": "string",    "templateId": "string",    "input": {      "schema": {        "property1": "string",        "property2": "string"      },      "schemaDigest": "string",      "contractDigest": "string"    },    "fixtures": [      "string"    ]  },  "issue": {    "path": "string",    "frontmatter": {      "title": "string",      "date": "string",      "slug": "string",      "topic": "string",      "preheader": "string",      "seo": {        "title": "string",        "description": "string",        "image": "string"      },      "gate": {        "leadIn": 0      }    }  },  "diagnostics": [    {      "code": "string",      "severity": "error",      "message": "string",      "origins": [        {          "fileName": "string",          "lineNumber": 1,          "columnNumber": 1        }      ],      "clients": [        "string"      ],      "notes": "string",      "provenance": "string",      "fixtures": [        "string"      ],      "occurrences": [        [          {            "fileName": "string",            "lineNumber": 1,            "columnNumber": 1          }        ]      ],      "compatibility": {        "assessment": "risk",        "title": "string"      }    }  ],  "incompatibilities": [    {      "code": "string",      "severity": "error",      "message": "string",      "origins": [        {          "fileName": "string",          "lineNumber": 1,          "columnNumber": 1        }      ],      "clients": [        "string"      ],      "notes": "string",      "provenance": "string",      "fixtures": [        "string"      ],      "occurrences": [        [          {            "fileName": "string",            "lineNumber": 1,            "columnNumber": 1          }        ]      ],      "compatibility": {        "assessment": "risk",        "title": "string"      }    }  ]}