Skip to content
On this page

Page


A page API resource represents a static markdown page used for guides and other documentation.

For example, the 'encoding/audio_normalization' page represents the documentation for audio normalization.

Fields

NameTypeNullableDefaultDescription
idIntegerNoYesThe primary key of the resource
nameStringNoYesThe primary title of the page
slugStringNoYesThe URL slug & route key of the resource
bodyStringNoNoThe body content of the resource
created_atDateNoNoThe date that the resource was created
updated_atDateNoNoThe date that the resource was last modified
deleted_atDateYesNoThe date that the resource was deleted

Allowed Include Paths

None

Endpoints

Page Destroy

The page destroy endpoint soft deletes a page and returns the deleted page resource.

Page Force Delete

The page force delete endpoint hard deletes a page and returns a confirmation message.

Page Index

The page index endpoint displays a listing of page resources.

Page Restore

The page restore endpoint restores a soft deleted page and returns the restored page resource.

Page Show

The page show endpoint returns a page resource.

Page Store

The page store endpoint creates a new page and returns the new page resource.

Page Update

The page update endpoint updates a page and returns the updated page resource.

Released under the MIT License.