Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Adds reference pages for font endpoints #176

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Adds reference pages for font endpoints #176

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
157 changes: 157 additions & 0 deletions reference/font-collections.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,157 @@
---
---

# Font Collections

<section class="route">
<div class="primary">
<h2>Schema</h2>
<p>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.</p>
<table class="attributes">
<tr id="schema-slug">
<td>
<code>slug</code>
</td>
<td>
<p>Unique identifier for the font collection.</p>
<p class="type">
JSON data type: string </p>
<p class="read-only">Read only</p>
<p class="context">Context: <code>view</code>, <code>edit</code>, <code>embed</code></p>
</td>
</tr>
<tr id="schema-name">
<td>
<code>name</code>
</td>
<td>
<p>The name for the font collection.</p>
<p class="type">
JSON data type: string </p>
<p class="context">Context: <code>view</code>, <code>edit</code>, <code>embed</code></p>
</td>
</tr>
<tr id="schema-description">
<td>
<code>description</code>
</td>
<td>
<p>The description for the font collection.</p>
<p class="type">
JSON data type: string </p>
<p class="context">Context: <code>view</code>, <code>edit</code>, <code>embed</code></p>
</td>
</tr>
<tr id="schema-font_families">
<td>
<code>font_families</code>
</td>
<td>
<p>The font families for the font collection.</p>
<p class="type">
JSON data type: array </p>
<p class="context">Context: <code>view</code>, <code>edit</code>, <code>embed</code></p>
</td>
</tr>
<tr id="schema-categories">
<td>
<code>categories</code>
</td>
<td>
<p>The categories for the font collection.</p>
<p class="type">
JSON data type: array </p>
<p class="context">Context: <code>view</code>, <code>edit</code>, <code>embed</code></p>
</td>
</tr>
</table>

</div>
</section>

<div><section class="route">
<div class="primary">
<h2>List Font Collections</h2>
<p>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.</p>

<h3>Definition</h3>

<code>GET /wp/v2/font-collections</code>

<h3>Example Request</h3>

<code>$ curl https://example.com/wp-json/wp/v2/font-collections</code>
</div>
<div class="secondary">
<h3>Arguments</h3>
<table class="arguments">
<tr>
<td>
<code>context</code><br />
</td>
<td>
<p>Scope under which the request is made; determines fields present in response.</p>
<p class="default">
Default: <code>view</code>
</p>
<p>One of: <code>view</code>, <code>embed</code>, <code>edit</code></p>
</td>
</tr>
<tr>
<td>
<code>page</code><br />
</td>
<td>
<p>Current page of the collection.</p>
<p class="default">
Default: <code>1</code>
</p>
</td>
</tr>
<tr>
<td>
<code>per_page</code><br />
</td>
<td>
<p>Maximum number of items to be returned in result set.</p>
<p class="default">
Default: <code>10</code>
</p>
</td>
</tr>
</table>

</div>
</section>
<section class="route">
<div class="primary">
<h2>Retrieve a Font Collection</h2>

<h3>Definition & Example Request</h3>

<code>GET /wp/v2/font-collections/&lt;slug&gt;</code>

<p>Query this endpoint to retrieve a specific font collection record.</p>

<code>$ curl https://example.com/wp-json/wp/v2/font-collections/&lt;slug&gt;</code>
</div>
<div class="secondary">
<h3>Arguments</h3>
<table class="arguments">
<tr>
<td>
<code>context</code><br />
</td>
<td>
<p>Scope under which the request is made; determines fields present in response.</p>
<p class="default">
Default: <code>view</code>
</p>
<p>One of: <code>view</code>, <code>embed</code>, <code>edit</code></p>
</td>
</tr>
</table>

</div>
</section>
</div>