> ## Documentation Index
> Fetch the complete documentation index at: https://docs.fetchski-attract.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Check a document before importing it

> Runs the import’s checks without saving or fetching anything.

```php Laravel wrap theme={"dark"}
use Fetchski\AttractCmsLaravel\Facades\Attract;

$blogValidateResult = Attract::blogPosts()->validateBlogImport(markdown: 'Example markdown');
```

```json 200 wrap theme={"dark"}
{
  "valid": false,
  "errors": [
    {
      "message": "Front matter must include a \"title\"."
    }
  ]
}
```

## In your app

A controller answers a route on your app: it calls `validateBlogImport()` and returns the answer.

**1. Add the controller**

```php app/Http/Controllers/ValidateBlogImportController.php theme={"dark"}
<?php

declare(strict_types=1);

namespace App\Http\Controllers;

use Fetchski\AttractCmsLaravel\Data\BlogValidateResult;
use Fetchski\AttractCmsLaravel\Facades\Attract;

final class ValidateBlogImportController
{
    public function __invoke(): BlogValidateResult
    {
        return Attract::blogPosts()->validateBlogImport(markdown: 'Example markdown');
    }
}
```

The other values are the example’s: take yours from the request, a form or your database.

**2. Add the route**

```php routes/web.php theme={"dark"}
use App\Http\Controllers\ValidateBlogImportController;
use Illuminate\Support\Facades\Route;

Route::post('/blog/from-markdown/validate', ValidateBlogImportController::class)->middleware('auth');
```

It acts with your key’s access, so `auth` lets only your signed-in users reach it.

**3. Call it**

Your own page’s form or script sends `POST /blog/from-markdown/validate` (a form adds `@csrf`, as every web route checks it), and gets back its answer as JSON. Test it, below, calls it.

> [!TIP]
>
> To keep the call in an Action instead, this writes `app/Actions/Attract/ValidateBlogImport.php` (an invokable Action that calls `validateBlogImport()`) and its test under `tests/Feature/Actions/Attract/` (Pest when your app has it):
>
> ```bash Terminal theme={"dark"}
> php artisan make:attract-action blogPosts.validateBlogImport
> ```

## Call it from the terminal

```bash Terminal theme={"dark"}
php artisan attract:call blogPosts.validateBlogImport 'markdown=Example markdown'
```

It calls `validateBlogImport()` on your default site and prints its answer as JSON. It writes, so it asks first: add `--force` to skip the question in a script. See [Call any method from the terminal](https://docs.fetchski-attract.com/call-command.md) for every argument type.

Findings are the answer: a document with problems still returns 200 with `valid: false`.

**Publishing:** `publish=true` publishes only when the caller may (a key needs `content:blog:publish`); otherwise the post is saved as a draft. An MDX import is always a draft.

> [accordion] Required parameters
>
> Named arguments, e.g. `validateBlogImport(markdown: …)`; leave out the optional ones.
>
> **markdown** `string` *required*
>
> **Required.** The whole document, exactly as the import would take it.

> [accordion] Optional parameters
>
> **generateImages** `?bool`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. The same as the body’s `generateImages`.
>
> **format** `Enums\\Format|string|null`
>
> **Optional.** Leave it out and the site uses `"md"`. How to read `markdown`: plain Markdown (`md`) or MDX (`mdx`). One of `md`, `mdx`.
>
> **filenames** `array\<int, string\>|Collection\<int, string\>|null`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. The image filenames the real import will post, so references to them count as found. At most 10 items.

> [accordion] Returns
>
> A `BlogValidateResult` (`Fetchski\AttractCmsLaravel\Data\BlogValidateResult`). The findings. Read its properties (`$blogValidateResult->valid`): each says whether the site always sends it.
>
> **valid** `bool`
>
> **Always sent.**
>
> **errors** `Collection\<int, BlogValidateResultErrorsItem\>`
>
> **Always sent.** A list of `BlogValidateResultErrorsItem`.
>
> **BlogValidateResultErrorsItem (Fetchski\AttractCmsLaravel\Data\BlogValidateResultErrorsItem)**
>
> **message** `string`
>
> **Always sent.** What is wrong and how to fix it.
>
> **line** `?int`
>
> **Sometimes sent:** `null` when the site leaves it out. The body line, when known.
>
> **tag** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. The MDX component, when one is at fault.

> [accordion] Errors
>
> Nothing to catch: the SDK retries what is safe, and Laravel logs and renders the rest (see [Errors and testing](https://docs.fetchski-attract.com/laravel/errors.md)).
>
> **ValidationFailed** `400`
>
> The request is not valid; the message says which part and how to fix it.
>
> **Retried first:** No. **Read:** `errors()` (field → messages), `siteMessage()`.
>
> **AuthenticationFailed** `401`
>
> The API key is missing, malformed, unknown, disabled, expired or archived, or a request its signing mode requires to be signed is not.
>
> **Retried first:** No. **Read:** `siteMessage()`, `errorName()`, `data()`.
>
> **Forbidden** `403`
>
> The API key lacks the scope this route needs (the message names it) or is used from outside its allowlist; or, on a route that answers 403 to everyone it refuses, the caller may not use it.
>
> **Retried first:** No. **Read:** `siteMessage()`, `errorName()`, `data()`.
>
> **RateLimited** `429`
>
> The key used up its per-minute limit. Still, after the client’s own waits and retries.
>
> **Retried first:** Yes: the client waits `Retry-After` (1 s when absent; over 60 s it gives up at once) and retries, up to `retries` times (2 by default). **Read:** `retryAfter()` (seconds, or null), `siteMessage()`.
>
> **SiteError** `5xx`
>
> The site failed (or something in front of it did). Its logs say why.
>
> **Retried first:** No: a write may have landed. **Read:** `siteMessage()`, `errorName()`, `data()`.
>
> **SiteUnreachable** `no answer`
>
> No answer: DNS, a refused connection, TLS, or the timeout (15 s per attempt by default).
>
> **Retried first:** Only when nothing reached the site (`neverConnected()`); never after a timeout, when it may have landed. **Read:** `reason()`, `neverConnected()`.
>
> **RequestNotSent** `not sent`
>
> The client refused to send it (e.g. a path segment of `..`); the site never saw it.
>
> **Retried first:** No. **Read:** `reason()` (what to change).
>
> **SiteRequestFailed** `any other`
>
> Any other status, or a success whose JSON doesn’t match this SDK version’s types (update the SDK).
>
> **Retried first:** No. **Read:** `reason()`, `status()`.
>
> **UnknownSite** `setup`
>
> `Attract::site('acme')` named a slug that isn’t under `sites` in `config/fetchski-attract.php`.
>
> **Retried first:** No: nothing was sent. **Read:** `getMessage()`, `$e->slug`.
>
> **SiteConfigurationError** `setup`
>
> The site’s config entry is wrong: no `url`, a malformed `api_key`, a key filed under another slug, or no default site.
>
> **Retried first:** No: nothing was sent. **Read:** `getMessage()` (what to fix).

## Behavior

* **Access:** an API key with `content:blog:write`, or `content:blog:all`, or `content:all`, or `admin:all`, or a signed-in user holding the `blog:import-markdown` permission. Other callers get 403.
* **Rate limit:** the key’s own writes-per-minute limit, set when the key is created (default 120), and 30 imports and validations a minute per caller: whichever runs out first answers 429 with `Retry-After`. The client waits and retries for you; you see `RateLimited` only if that runs out.
* **Retries:** a write is sent again only after a 429 (refused before it acted) or when it never reached the site. After a timeout or a 5xx it may have landed: check before you send it again.
* **Timeout:** 15 s per attempt by default; raise `timeout` in `config/fetchski-attract.php` for longer.

## Test it

It calls the route above with the SDK faked: the fake answers every call with a valid example, so nothing leaves your machine and no config or key is needed. Save it as `tests/Feature/ValidateBlogImportTest.php`, then run your tests:

```php tests/Feature/ValidateBlogImportTest.php theme={"dark"}
<?php

declare(strict_types=1);

namespace Tests\Feature;

use App\Models\User;
use Fetchski\AttractCmsLaravel\Facades\Attract;
use Illuminate\Foundation\Testing\RefreshDatabase;
use Tests\TestCase;

final class ValidateBlogImportTest extends TestCase
{
    use RefreshDatabase;

    public function test_validate_blog_import(): void
    {
        Attract::fake();

        $this->actingAs(User::factory()->create())
            ->postJson('/blog/from-markdown/validate')
            ->assertOk();

        Attract::assertCalled('blogPosts.validateBlogImport');
    }
}
```

```bash Terminal theme={"dark"}
php artisan test
```

**Answer with your own values:** fake `blogPosts.validateBlogImport` with `BlogValidateResult::factory()->make([...])`, the fields you give over a valid example.

```php tests/Feature/ValidateBlogImportAnswerTest.php theme={"dark"}
<?php

declare(strict_types=1);

namespace Tests\Feature;

use Fetchski\AttractCmsLaravel\Data\BlogValidateResult;
use Fetchski\AttractCmsLaravel\Facades\Attract;
use Tests\TestCase;

final class ValidateBlogImportAnswerTest extends TestCase
{
    public function test_validate_blog_import_answers_your_values(): void
    {
        Attract::fake([
            'blogPosts.validateBlogImport' => BlogValidateResult::factory()->make(['valid' => false]),
        ]);

        $blogValidateResult = Attract::blogPosts()->validateBlogImport(markdown: 'Example markdown');

        $this->assertSame(false, $blogValidateResult->valid);
    }
}
```

## Related

> [card] [List a blog post’s locales](https://docs.fetchski-attract.com/laravel/reference/blog-posts/get-blog-locales.md)
>
> `Attract::blogPosts()->getBlogLocales()`

> [card] [Get the Markdown template](https://docs.fetchski-attract.com/laravel/reference/blog-posts/get-blog-markdown-template.md)
>
> `Attract::blogPosts()->getBlogMarkdownTemplate()`

> [card] [Get the MDX template](https://docs.fetchski-attract.com/laravel/reference/blog-posts/get-blog-mdx-template.md)
>
> `Attract::blogPosts()->getBlogMdxTemplate()`

> [card] [List blog posts](https://docs.fetchski-attract.com/laravel/reference/blog-posts/list-blogs.md)
>
> `Attract::blogPosts()->listBlogs()`

> [card] [Create a blog post](https://docs.fetchski-attract.com/laravel/reference/blog-posts/create-blog.md)
>
> `Attract::blogPosts()->createBlog()`

> [card] [Get a blog post](https://docs.fetchski-attract.com/laravel/reference/blog-posts/get-blog.md)
>
> `Attract::blogPosts()->getBlog()`

> [card] [POST /@apostrophecms/blog/from-markdown/validate](https://docs.fetchski-attract.com/api-reference/blog-posts/check-a-document-before-importing-it.md)
>
> The endpoint this calls, in the API reference: the HTTP request and answer, and every rule the site checks.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.