add location object

docs/reference-docs/LOCATIONS-API-Location-Object.md

@@ -1,13 +1,45 @@
 ---
 title: Location Object
-type: endpoint
+type: basic
 categorySlug: voucherify-api
 parentDocSlug: locations-api
 slug: location-object
 hidden: false
 order: 1
 ---
 
+## Location object
+| Attributes |  Description |
+|:-----|:--------|
+| id</br>`string` | <p>Unique location ID, assigned by the Voucherify API.</p> **Example:** <p>loc_NoMGXmHO9OUs7iz9mGWpamma</p> |
+| object</br>`string` | <p>The type of object represented by JSON. This object stores information about a <code>location</code>.</p> |
+| name</br>`string` | <p>Location name.</p> |
+| shape</br>`object` | <p>Defines the shape and boundaries of the location.</p> Any of: [Circle](#circle), [Polygon](#polygon) |
+| created_at</br>`string` | <p>Timestamp representing the date and time when the location was created in ISO 8601 format.</p> **Example:** <p>2022-02-14T15:12:06.817Z</p> |
+| updated_at</br>`string` | <p>Timestamp representing the date and time when the location was updated in ISO 8601 format.</p> **Example:** <p>2022-03-14T15:12:06.817Z</p> |
+
+## Circle
+| Attributes |  Description |
+|:-----|:--------|
+| type</br>`string` | <p>The type of shape being defined is a <code>circle</code>.</p> |
+| format</br>`string` | <p>The location is defined in terms of a <code>distance</code> object.</p> |
+| distance</br>`object` | <p>Defines the parameters for the circle.</p> <h3>Distance</h3><table><thead><tr><th style="text-align:left">Attributes</th><th style="text-align:left">Description</th></tr></thead><tbody><tr><td style="text-align:left">center</br><code>string</code></td><td style="text-align:left"><p>Center of the circle identified by GPS coordinates in decimal degrees.</p> <strong>Example:</strong> <p>geo:40.79372699823857,-74.15092132694554</p></td></tr><tr><td style="text-align:left">radius</br><code>string</code></td><td style="text-align:left"><p>Defines the radius of the circle.</p></td></tr></tbody></table> |
+
+## Polygon
+| Attributes |  Description |
+|:-----|:--------|
+| type</br>`string` | <p>The type of shape being defined is a <code>polygon</code>.</p> |
+| format</br>`string` | <p>The location is defined in terms of a <code>geojson</code> object.</p> |
+| distance</br>`object` | <p>Defines the parameters for the polygon.</p> <h3>Geojson</h3><table><thead><tr><th style="text-align:left">Attributes</th><th style="text-align:left">Description</th></tr></thead><tbody><tr><td style="text-align:left">type</br><code>string</code></td><td style="text-align:left"><p>Type of geojson coordinates, i.e. <code>Polygon</code>.</p></td></tr><tr><td style="text-align:left">coordinates</br><code>array</code></td><td style="text-align:left"><p>Contains array of GeoJSON coordinate arrays.</p> Array of <a href="#geojson-coordinate-array.">GeoJSON coordinate array.</a></td></tr></tbody></table> |
+
+## GeoJSON coordinate array.
+<p>GeoJSON coordinate array.</p>
+
+Array of [GeoJSON coordinate.](#geojson-coordinate.)
+
+## GeoJSON coordinate.
+<p>GeoJSON coordinate.</p>
+
 [block:html]
 {
   "html": "<style>\n[title=\"Toggle library\"] { \n  display: none; }\n.LanguagePicker-divider { \n  display: none; }\n.Playground-section3VTXuaYZivJK > .APISectionHeader3LN_-QIR0m7x {\n  display: none; }\n.LanguagePicker-languages1qVVo_v6AlP9 {\n  display: none; }\n.headline-container-article-info2GaOf2jMpV0r {\n  display: none; }\n.APISectionHeader3LN_-QIR0m7x {\n  display: none; }\n.APIResponseSchemaPicker-label3XMQ9E-slNcS {\n  display: none; }\n.PlaygroundC7DInM9NFvBg {\n  display: none; }\n.Modal-Header3VPrQs3MUWWd {\n  display: none; }\n.rm-ReferenceMain .rm-Article {\n  max-width: 2000px; }\n</style>"

scripts/md-tables.ts

@@ -28,5 +28,6 @@ export const mdTables: [string, string?][] = [
     ['16_obj_export_object', 'EXPORTS-API-Export-Object.md'],
     ['20_obj_category_object', 'CATEGORIES-API-Category-Object.md'],
     ['21_obj_metadata_schema_object', 'METADATA-SCHEMAS-API-Metadata-Schema-Object.md'],
+    ['22_obj_location_object', 'LOCATIONS-API-Location-Object.md'],
     ['23_obj_qualification_object', 'QUALIFICATIONS-API-Qualification-Object.md']
 ];

scripts/src/schema-to-md-table.ts

@@ -13,7 +13,7 @@ yup.addMethod(yup.MixedSchema, "oneOfSchemas", function (schemas: yup.AnySchema[
 
 const nodeWithTitleAndPropertiesSchema = yup.object({
     title: yup.string().optional(),
-    type: yup.string().oneOf(['object', 'string']),
+    type: yup.string().oneOf(['object', 'string', 'array']),
     properties: yup.object({}),
     anyOf: yup.array().optional(),
 });