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
Name | Type | Nullable | Default | Description |
---|---|---|---|---|
id | Integer | No | Yes | The primary key of the resource |
name | String | No | Yes | The primary title of the page |
slug | String | No | Yes | The URL slug & route key of the resource |
body | String | No | No | The body content of the resource |
created_at | Date | No | No | The date that the resource was created |
updated_at | Date | No | No | The date that the resource was last modified |
deleted_at | Date | Yes | No | The date that the resource was deleted |
Allowed Include Paths
None
Endpoints
The page destroy endpoint soft deletes a page and returns the deleted page resource.
The page force delete endpoint hard deletes a page and returns a confirmation message.
The page index endpoint displays a listing of page resources.
The page restore endpoint restores a soft deleted page and returns the restored page resource.
The page show endpoint returns a page resource.
The page store endpoint creates a new page and returns the new page resource.
The page update endpoint updates a page and returns the updated page resource.