Files
animethemes-api-docs/docs/page
..
2022-02-18 14:08:08 -06:00
2022-02-18 14:08:08 -06:00
2022-02-18 14:08:08 -06:00

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

Name Type Nullable Description
id Integer No The primary key of the resource
name String No The primary title of the page
slug String No The URL slug & route key of the resource
created_at Date No The date that the resource was created
updated_at Date No The date that the resource was last modified
deleted_at Date Yes The date that the resource was deleted

Note: At the time of writing, the body field of the underlying page model is purposely excluded from the page API resource due to size constraints.

Allowed Include Paths

None

Endpoints

Page Show

The page show endpoint returns a page resource.

Page Index

The page index endpoint displays a listing of page resources.