Delete an FAQ category

import app from '@adonisjs/core/services/app'
import { SiteClient } from '@fetchski/attract-cms-sdk'

const site = await app.container.make(SiteClient)
await site.faqCategories().deleteFaqCategory({ id: 'clx8m2k4p0000a1b2c3d4e5f6' })

In your app

import { inject } from '@adonisjs/core'
import type { HttpContext } from '@adonisjs/core/http'
import { SiteClient } from '@fetchski/attract-cms-sdk'

@inject()
export default class DeleteFaqCategoryController {
  constructor(protected site: SiteClient) {}

  async handle({ params, response }: HttpContext) {
    await this.site.faqCategories().deleteFaqCategory({ id: params.id })
    return response.noContent()
  }
}

import router from '@adonisjs/core/services/router'

const DeleteFaqCategoryController = () => import('#controllers/delete_faq_category_controller')

router.delete('/faq-category/:id', [DeleteFaqCategoryController])

Find the id

import app from '@adonisjs/core/services/app'
import { SiteClient } from '@fetchski/attract-cms-sdk'

const site = await app.container.make(SiteClient)
const row = (await site.faqCategories().listFaqCategoriesPick(['title', 'slug'])).find((each) => each.slug === 'getting-started') // { id, title, slug }, or undefined

Behavior

• Access: an API key with content:faq-categories:delete (or a master above it: content:faq-categories:all, content:all, admin:all). A signed-in person may call it as far as their own permissions allow; anyone else gets 403.
• Rate limit: the key’s own writes-per-minute limit, set when the key is created (default 120); over it, 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 (milliseconds) in config/attract.ts for longer.

Test it

import { test } from '@japa/runner'
import app from '@adonisjs/core/services/app'
import testUtils from '@adonisjs/core/services/test_utils'
import { fakeAttract } from '@fetchski/attract-cms-adonis/testing'
import DeleteFaqCategoryController from '#controllers/delete_faq_category_controller'

test('faqCategories.deleteFaqCategory', async () => {
  const site = fakeAttract()

  const ctx = await testUtils.createHttpContext()
  ctx.params = { id: 'clx8m2k4p0000a1b2c3d4e5f6' }
  const controller = await app.container.make(DeleteFaqCategoryController)
  await controller.handle(ctx)

  site.assertCalled('faqCategories.deleteFaqCategory', (args) => args.id === 'clx8m2k4p0000a1b2c3d4e5f6')
})

node ace test

Related