Delete

# spec.yml
name: Collection Name
methods:
  delete:
    parametersSchema:
      type: object
      properties:
        hardDelete:
          type: boolean
          default: false
          description: Permanently delete instead of soft delete

path: /contacts/{id}
method: DELETE
requestMapping:
  pathParameters:
    id: { $var: $.id }
  query:
    permanent: { $var: $.parameters.hardDelete }
responseMapping:
  success: true

export default async function deleteRecord({ apiClient, id, parameters }) {
  const queryParams = {}

  if (parameters?.hardDelete) {
    queryParams.permanent = true
  }

  await apiClient.delete(`/contacts/${id}`, { params: queryParams })

  return {
    success: true,
  }
}