diff --git a/reference/font-collections.md b/reference/font-collections.md new file mode 100644 index 0000000..109c276 --- /dev/null +++ b/reference/font-collections.md @@ -0,0 +1,157 @@ +--- +--- + +# Font Collections + +
+
+

Schema

+

The schema defines all the fields that exist within a font collection record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.

+ + + + + + + + + + + + + + + + + + + + + +
+ slug + +

Unique identifier for the font collection.

+

+ JSON data type: string

+

Read only

+

Context: view, edit, embed

+
+ name + +

The name for the font collection.

+

+ JSON data type: string

+

Context: view, edit, embed

+
+ description + +

The description for the font collection.

+

+ JSON data type: string

+

Context: view, edit, embed

+
+ font_families + +

The font families for the font collection.

+

+ JSON data type: array

+

Context: view, edit, embed

+
+ categories + +

The categories for the font collection.

+

+ JSON data type: array

+

Context: view, edit, embed

+
+ +
+
+ +
+
+

List Font Collections

+

Query this endpoint to retrieve a collection of font collections. The response you receive can be controlled and filtered using the URL query parameters below.

+ +

Definition

+ + GET /wp/v2/font-collections + +

Example Request

+ + $ curl https://example.com/wp-json/wp/v2/font-collections +
+
+

Arguments

+ + + + + + + + + + + + + +
+ context
+
+

Scope under which the request is made; determines fields present in response.

+

+ Default: view +

+

One of: view, embed, edit

+
+ page
+
+

Current page of the collection.

+

+ Default: 1 +

+
+ per_page
+
+

Maximum number of items to be returned in result set.

+

+ Default: 10 +

+
+ +
+
+
+
+

Retrieve a Font Collection

+ +

Definition & Example Request

+ + GET /wp/v2/font-collections/<slug> + +

Query this endpoint to retrieve a specific font collection record.

+ + $ curl https://example.com/wp-json/wp/v2/font-collections/<slug> +
+
+

Arguments

+ + + + + +
+ context
+
+

Scope under which the request is made; determines fields present in response.

+

+ Default: view +

+

One of: view, embed, edit

+
+ +
+
+
diff --git a/reference/wp_font_faces.md b/reference/wp_font_faces.md new file mode 100644 index 0000000..140c83b --- /dev/null +++ b/reference/wp_font_faces.md @@ -0,0 +1,322 @@ +--- +--- + +# Font_Faces + +
+
+

Schema

+

The schema defines all the fields that exist within a font_face record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.

+ + + + + + + + + + + + + + + + + +
+ id + +

Unique identifier for the post.

+

+ JSON data type: integer

+

Read only

+

Context: view, edit, embed

+
+ theme_json_version + +

Version of the theme.json schema used for the typography settings.

+

+ JSON data type: integer

+

Context: view, edit, embed

+
+ parent + +

The ID for the parent font family of the font face.

+

+ JSON data type: integer

+

Context: view, edit, embed

+
+ font_face_settings + +

font-face declaration in theme.json format.

+

+ JSON data type: object

+

Context: view, edit, embed

+
+ +
+
+ +
+
+

List Font_Faces

+

Query this endpoint to retrieve a collection of font_faces. The response you receive can be controlled and filtered using the URL query parameters below.

+ +

Definition

+ + GET /wp/v2/font-families/<font_family_id>/font-faces + +

Example Request

+ + $ curl https://example.com/wp-json/wp/v2/font-families/<font_family_id>/font-faces +
+
+

Arguments

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ font_family_id
+
+

The ID for the parent font family of the font face.

+

+ Required: 1 +

+
+ context
+
+

Scope under which the request is made; determines fields present in response.

+

+ Default: view +

+

One of: view, embed, edit

+
+ page
+
+

Current page of the collection.

+

+ Default: 1 +

+
+ per_page
+
+

Maximum number of items to be returned in result set.

+

+ Default: 10 +

+
+ exclude
+
+

Ensure result set excludes specific IDs.

+
+ include
+
+

Limit result set to specific IDs.

+
+ offset
+
+

Offset the result set by a specific number of items.

+
+ order
+
+

Order sort attribute ascending or descending.

+

+ Default: desc +

+

One of: asc, desc

+
+ orderby
+
+

Sort collection by post attribute.

+

+ Default: id +

+

One of: id, include

+
+ +
+
+
+
+

Create a Font_Face

+

Arguments

+ + + + + + + + + + + + + +
+ font_family_id
+
+

The ID for the parent font family of the font face.

+

+ Required: 1 +

+
+ theme_json_version
+
+

Version of the theme.json schema used for the typography settings.

+

+ Default: 2 +

+
+ font_face_settings
+
+

font-face declaration in theme.json format, encoded as a string.

+

+ Required: 1 +

+
+ +
+
+

Definition

+ + POST /wp/v2/font-families/<font_family_id>/font-faces +
+
+
+
+

Retrieve a Font_Face

+ +

Definition & Example Request

+ + GET /wp/v2/font-families/<font_family_id>/font-faces/<id> + +

Query this endpoint to retrieve a specific font_face record.

+ + $ curl https://example.com/wp-json/wp/v2/font-families/<font_family_id>/font-faces/<id> +
+
+

Arguments

+ + + + + + + + + + + + + +
+ font_family_id
+
+

The ID for the parent font family of the font face.

+

+ Required: 1 +

+
+ id
+
+

Unique identifier for the font face.

+

+ Required: 1 +

+
+ context
+
+

Scope under which the request is made; determines fields present in response.

+

+ Default: view +

+

One of: view, embed, edit

+
+ +
+
+
+
+

Delete a Font_Face

+

Arguments

+ + + + + + + + + + + + + +
+ font_family_id
+
+

The ID for the parent font family of the font face.

+

+ Required: 1 +

+
+ id
+
+

Unique identifier for the font face.

+

+ Required: 1 +

+
+ force
+
+

Whether to bypass Trash and force deletion.

+
+ +
+
+

Definition

+ + DELETE /wp/v2/font-families/<font_family_id>/font-faces/<id> + +

Example Request

+ + $ curl -X DELETE https://example.com/wp-json/wp/v2/font-families/<font_family_id>/font-faces/<id> +
+
+
diff --git a/reference/wp_font_families.md b/reference/wp_font_families.md new file mode 100644 index 0000000..1d9be47 --- /dev/null +++ b/reference/wp_font_families.md @@ -0,0 +1,328 @@ +--- +--- + +# Font_Families + +
+
+

Schema

+

The schema defines all the fields that exist within a font_family record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.

+ + + + + + + + + + + + + + + + + +
+ id + +

Unique identifier for the post.

+

+ JSON data type: integer

+

Read only

+

Context: view, edit, embed

+
+ theme_json_version + +

Version of the theme.json schema used for the typography settings.

+

+ JSON data type: integer

+

Context: view, edit, embed

+
+ font_faces + +

The IDs of the child font faces in the font family.

+

+ JSON data type: array

+

Context: view, edit, embed

+
+ font_family_settings + +

font-face definition in theme.json format.

+

+ JSON data type: object

+

Context: view, edit, embed

+
+ +
+
+ +
+
+

List Font_Families

+

Query this endpoint to retrieve a collection of font_families. The response you receive can be controlled and filtered using the URL query parameters below.

+ +

Definition

+ + GET /wp/v2/font-families + +

Example Request

+ + $ curl https://example.com/wp-json/wp/v2/font-families +
+
+

Arguments

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ context
+
+

Scope under which the request is made; determines fields present in response.

+

+ Default: view +

+

One of: view, embed, edit

+
+ page
+
+

Current page of the collection.

+

+ Default: 1 +

+
+ per_page
+
+

Maximum number of items to be returned in result set.

+

+ Default: 10 +

+
+ exclude
+
+

Ensure result set excludes specific IDs.

+
+ include
+
+

Limit result set to specific IDs.

+
+ offset
+
+

Offset the result set by a specific number of items.

+
+ order
+
+

Order sort attribute ascending or descending.

+

+ Default: desc +

+

One of: asc, desc

+
+ orderby
+
+

Sort collection by post attribute.

+

+ Default: id +

+

One of: id, include

+
+ slug
+
+

Limit result set to posts with one or more specific slugs.

+
+ +
+
+
+
+

Create a Font_Family

+

Arguments

+ + + + + + + + + +
+ theme_json_version
+
+

Version of the theme.json schema used for the typography settings.

+

+ Default: 2 +

+
+ font_family_settings
+
+

font-family declaration in theme.json format, encoded as a string.

+

+ Required: 1 +

+
+ +
+
+

Definition

+ + POST /wp/v2/font-families +
+
+
+
+

Retrieve a Font_Family

+ +

Definition & Example Request

+ + GET /wp/v2/font-families/<id> + +

Query this endpoint to retrieve a specific font_family record.

+ + $ curl https://example.com/wp-json/wp/v2/font-families/<id> +
+
+

Arguments

+ + + + + + + + + +
+ id
+
+

Unique identifier for the post.

+
+ context
+
+

Scope under which the request is made; determines fields present in response.

+

+ Default: view +

+

One of: view, embed, edit

+
+ +
+
+
+
+

Update a Font_Family

+

Arguments

+ + + + + + + + + + + + + +
+ id
+
+

Unique identifier for the post.

+
+ theme_json_version
+
+

Version of the theme.json schema used for the typography settings.

+

+ Default: 2 +

+
+ font_family_settings
+
+

font-family declaration in theme.json format, encoded as a string.

+

+ Required: 1 +

+
+ +
+
+

Definition

+ + POST /wp/v2/font-families/<id> + +

Example Request

+ + +
+
+
+
+

Delete a Font_Family

+

Arguments

+ + + + + + + + + +
+ id
+
+

Unique identifier for the post.

+
+ force
+
+

Whether to bypass Trash and force deletion.

+
+ +
+
+

Definition

+ + DELETE /wp/v2/font-families/<id> + +

Example Request

+ + $ curl -X DELETE https://example.com/wp-json/wp/v2/font-families/<id> +
+
+