Check a document before importing it

use Fetchski\AttractCmsLaravel\Facades\Attract;

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

{
  "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.

Add the controller

app/Http/Controllers/ValidateBlogImportController.php

<?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.

Add the route

routes/web.php

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.

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.

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):

Terminal

php artisan make:attract-action blogPosts.validateBlogImport

Call it from the terminal

Terminal

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 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.

Required parameters

Named arguments, e.g. validateBlogImport(markdown: …); leave out the optional ones.

string

required

Required. The whole document, exactly as the import would take it.

Optional parameters

?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.

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.

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.

Returns

A BlogValidateResult (Fetchski\AttractCmsLaravel\Data\BlogValidateResult). The findings. Read its properties ($blogValidateResult->valid): each says whether the site always sends it.

bool

Always sent.

Collection<int, BlogValidateResultErrorsItem>

Always sent. A list of BlogValidateResultErrorsItem.

Show BlogValidateResultErrorsItem (Fetchski\AttractCmsLaravel\Data\BlogValidateResultErrorsItem)

string

Always sent. What is wrong and how to fix it.

?int

Sometimes sent: null when the site leaves it out. The body line, when known.

?string

Sometimes sent: null when the site leaves it out. The MDX component, when one is at fault.

Errors

Nothing to catch: the SDK retries what is safe, and Laravel logs and renders the rest (see Errors and testing).

400

The request is not valid; the message says which part and how to fix it.Retried first: No. Read: errors() (field → messages), siteMessage().

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().

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().

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().

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().

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().

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).

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().

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.

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:

tests/Feature/ValidateBlogImportTest.php

<?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');
    }
}

Terminal

php artisan test

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

tests/Feature/ValidateBlogImportAnswerTest.php

<?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);
    }
}

List a blog post’s locales

Attract::blogPosts()->getBlogLocales()

Get the Markdown template

Attract::blogPosts()->getBlogMarkdownTemplate()

Get the MDX template

Attract::blogPosts()->getBlogMdxTemplate()

List blog posts

Attract::blogPosts()->listBlogs()

Create a blog post

Attract::blogPosts()->createBlog()

Get a blog post

Attract::blogPosts()->getBlog()

POST /@apostrophecms/blog/from-markdown/validate

The endpoint this calls, in the API reference: the HTTP request and answer, and every rule the site checks.

Get started

Using the SDK

Going further

Pages & Site

Content

Media

Forms

Ads & Conversions

Analytics

Check a document before importing it

In your app

Call it from the terminal

Behavior

Test it

List a blog post’s locales

Get the Markdown template

Get the MDX template

List blog posts

Create a blog post

Get a blog post

POST /@apostrophecms/blog/from-markdown/validate

In your app

Call it from the terminal

Behavior

Test it

Related

List a blog post’s locales

Get the Markdown template

Get the MDX template

List blog posts

Create a blog post

Get a blog post

POST /@apostrophecms/blog/from-markdown/validate