Add documentation on the get-entry-by-url endpoint

docs/content/api-server/endpoints.md

@@ -3,3 +3,59 @@ title = "Endpoints"
 type = "default"
 description = "An overview of all the API endpoints"
 +++
+
+## Get entry by URL
+
+`/api/v1/get-entry-by-url`
+
+### Parameters
+
+- `url` ^(required)^
+  - The full URL of the entry. This includes the path parts from the parent pages
+- `locale` ^(required)^
+  - The locale of the entry to fetch
+
+### Response type
+
+```typescript
+{
+  data: {
+    // An array of alternative locales will always
+    // be returned alongside the entry itself.
+    alt_locales: {
+      uid: string,
+      content_type: string,
+      locale: string,
+      slug: string,
+      url: string,
+    }[],
+
+    // The entry is directly queried from Contentstack.
+    entry: {
+      ACL: unknown,
+      _in_progress: boolean,
+      _version: number,
+      created_at: string, // Timestamp string
+      created_by: string, // UID of the creator
+      locale: string,
+      parent: {
+        _content_type_uid: string,
+        uid: string,
+      }[],
+      publish_details: {
+        environment: string, // The environment UID
+        locale: string,
+        time: string, // Timestamp string
+        user: string, // The user UID
+      },
+      tags: string[],
+      title: string,
+      uid: string,
+      updated_at: string, // Timestamp string
+      updated_by: string, // The user UID
+      url: string,
+    },
+  },
+  error?: string // Will be null unless there's an error
+}
+```

docs/hugo.toml

@@ -4,6 +4,17 @@ title = 'Contentstack Bridge'
 contentDir = 'content'
 disableHugoGeneratorInject = true
 
+[markup]
+  [markup.goldmark]
+    [markup.goldmark.extensions]
+      [markup.goldmark.extensions.extras]
+        [markup.goldmark.extensions.extras.delete]
+          enable = true
+        [markup.goldmark.extensions.extras.superscript]
+          enable = true
+        [markup.goldmark.extensions.extras.subscript]
+          enable = true
+
 [params]
   linkTitle = 'CSB Docs'
   themeVariant = 'zen-dark'