Update human-friendly documentation

public/index.html

@@ -31,24 +31,37 @@
     <section>
       <h2>MoonCat&#8203;Data API</h2>
       <p>
-        This site serves requests for MoonCat trait data. Results are
-        <em>json</em> files. The parameter <code>catId_or_rescueIndex</code> can
-        be either a valid <em>moonCatId</em> (e.g. 0x00d8523a53) or original
-        <em>rescueIndex</em> (0 <= rescueIndex <= 25439)
+        This site serves requests for MoonCat metadata and images. Results are <em>json</em> formatted for traits and other metadata. Results are <em>png</em> images for all renders unless otherwise noted. The parameter <code>catId_or_rescueIndex</code> can be either a valid <em>moonCatId</em> (e.g. <code>0x00d8523a53</code>) or original <em>rescueIndex</em> (0 &lt;= rescueIndex &lt;= 25439)
       </p>
       <h3>Endpoints</h3>
+      <p>Below is a summary of the MoonCat-related API endpoints this server hosts. For complete details of the API endpoints, see the <a target="_blank" href="https://gitlab.com/mooncatrescue/data-api-server/-/blob/master/spec.yml">OpenAPI specification document</a>.</p>
       <ul>
         <li>
-          <code>/traits/:catId_or_rescueIndex</code> trait metadata for provided
-          id
+          <code>/traits/:catId_or_rescueIndex</code> Trait metadata for the requested MoonCat
         </li>
         <li>
-          <code>/contract-details/:catId_or_rescueIndex</code> only
-          contract-related trait metadata for provided id
+          <code>/contract-details/:catId_or_rescueIndex</code> Contract-related trait metadata for the requested MoonCat
         </li>
         <li>
-          <code>/image/:catId_or_rescueIndex</code> image of MoonCat with
-          provided id in PNG format
+          <code>/image/:catId_or_rescueIndex</code> Image in PNG format of the requested MoonCat. Highly-customizable endpoint that can generate customized views of each MoonCat, given different query parameters.
+        </li>
+        <li>
+          <code>/cat-image/:catId_or_rescueIndex</code> Image in PNG format of the requested MoonCat by themselves
+        </li>
+        <li>
+          <code>/regular-image/:catId_or_rescueIndex</code> Image in PNG format of the requested MoonCat in an original state
+        </li>
+        <li>
+          <code>/glow-image/:catId_or_rescueIndex</code> Image in PNG format of the requested MoonCat with an Acclimated glow
+        </li>
+        <li>
+          <code>/face-image/:catId_or_rescueIndex</code> Image in PNG format of the requested MoonCat's face
+        </li>
+        <li>
+          <code>/accessorized-image/:catId_or_rescueIndex</code> Image in PNG format of requested MoonCat with worn accessories
+        </li>
+        <li>
+          <code>/cat-walk/:catId_or_rescueIndex</code> Image in PNG format of requested MoonCat as a sprite sheet for 8-frame animation
         </li>
       </ul>
     </section>

spec.yml

@@ -13,7 +13,7 @@ paths:
     get:
       tags:
         - traits
-      summary: Trait metadata for requested MoonCat
+      summary: Trait metadata for the requested MoonCat
       description: Full metadata used as the return URL for a TokenURI request on the Acclimated wrapper. This includes an `attributes` property that adheres to [OpenSea metadata standards](https://docs.opensea.io/docs/metadata-standards), and a `detials` property that is more MoonCat-specific in formatting.
       parameters:
         - $ref: '#/components/parameters/MoonCatIdentifier'
@@ -44,7 +44,7 @@ paths:
                     - $ref: '#/components/schemas/RescueIndex'
       responses:
         '200':
-          description: JSON array of contract details for requested MoonCats
+          description: JSON array of contract details for the requested MoonCats
           content:
             application/json:
               schema:
@@ -57,7 +57,7 @@ paths:
     get:
       tags:
         - traits
-      summary: Contract-related trait metadata for a single MoonCat
+      summary: Contract-related trait metadata for the requested MoonCat
       parameters:
         - $ref: '#/components/parameters/MoonCatIdentifier'
       responses:
@@ -162,7 +162,7 @@ paths:
     get:
       tags:
         - images
-      summary: Image in PNG format of requested MoonCat by themselves
+      summary: Image in PNG format of the requested MoonCat by themselves
       description: PNG rendering of the MoonCat by itself, with no additional accessories or extras, and if they're not Acclimated, not glowing either
       parameters:
         - $ref: '#/components/parameters/MoonCatIdentifier'
@@ -174,7 +174,7 @@ paths:
     get:
       tags:
         - images
-      summary: Image in PNG format of requested MoonCat in an original state
+      summary: Image in PNG format of the requested MoonCat in an original state
       description: PNG rendering of the MoonCat by itself, not glowing, with no additional accessories or extras.
       parameters:
         - $ref: '#/components/parameters/MoonCatIdentifier'
@@ -186,7 +186,7 @@ paths:
     get:
       tags:
         - images
-      summary: Image in PNG format of requested MoonCat with an Acclimated glow
+      summary: Image in PNG format of the requested MoonCat with an Acclimated glow
       description: PNG rendering of what this MoonCat looks like when Acclimated; it gains a glow around it, which has a color matching its core hex identifier color.
       parameters:
         - $ref: '#/components/parameters/MoonCatIdentifier'
@@ -198,7 +198,7 @@ paths:
     get:
       tags:
         - images
-      summary: Image in PNG format of requested MoonCat's face
+      summary: Image in PNG format of the requested MoonCat's face
       description: PNG rendering of this MoonCat's face, with no additional accessories or extras, and if they're not Acclimated, not glowing either.
       parameters:
         - $ref: '#/components/parameters/MoonCatIdentifier'