⚡️ Reduce article API response sizes for GraphQL and audit log pages (#60192)

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Author: heiskr

src/article-api/templates/audit-logs-page.template.md

@@ -26,7 +26,7 @@ Each event below lists only its additional fields beyond these common fields.
 {% for event in events %}
 #### `{{ event.action }}`
 
-{{ event.description }}
+{% if event.description and event.description != 'N/A' %}{{ event.description }}{% endif %}
 
 {% if event.fields.size > 0 %}**Additional fields:** {% for field in event.fields %}`{{ field }}`{% unless forloop.last %}, {% endunless %}{% endfor %}{% endif %}
 

src/article-api/templates/graphql-reference.template.md

@@ -62,7 +62,7 @@ Connection types with only the standard pagination fields (`edges`, `nodes`, `pa
 
 ### Fields for `{{ item.name }}`
 
-{% for field in item.fields %}* `{{ field.name }}` ({{ field.type }}): {{ field.description }}{% if field.defaultValue %} Default: `{{ field.defaultValue }}`.{% endif %}{% if field.isDeprecated %} **Deprecated:** {{ field.deprecationReason }}{% endif %}{% if field.arguments.size > 0 %}
+{% for field in item.fields %}* `{{ field.name }}` ({{ field.type }}): {{ field.description }}{% if field.defaultValue %} Default: `{{ field.defaultValue }}`.{% endif %}{% if field.isDeprecated %} **Deprecated:** {{ field.deprecationReason }}{% endif %}{% if field.hasPaginationOnly %} _(Pagination: `after`, `before`, `first`, `last`)_{% elsif field.arguments.size > 0 %}
 {% for arg in field.arguments %}  * `{{ arg.name }}` ({{ arg.type.name }}): {{ arg.description }}{% if arg.defaultValue %} Default: `{{ arg.defaultValue }}`.{% endif %}
 {% endfor %}{% endif %}
 {% endfor %}
@@ -73,7 +73,7 @@ Connection types with only the standard pagination fields (`edges`, `nodes`, `pa
 
 ### Fields for `{{ item.name }}`
 
-{% for field in item.fields %}* `{{ field.name }}` ({{ field.type }}): {{ field.description }}{% if field.defaultValue %} Default: `{{ field.defaultValue }}`.{% endif %}{% if field.isDeprecated %} **Deprecated:** {{ field.deprecationReason }}{% endif %}{% if field.arguments.size > 0 %}
+{% for field in item.fields %}* `{{ field.name }}` ({{ field.type }}): {{ field.description }}{% if field.defaultValue %} Default: `{{ field.defaultValue }}`.{% endif %}{% if field.isDeprecated %} **Deprecated:** {{ field.deprecationReason }}{% endif %}{% if field.hasPaginationOnly %} _(Pagination: `after`, `before`, `first`, `last`)_{% elsif field.arguments.size > 0 %}
 {% for arg in field.arguments %}  * `{{ arg.name }}` ({{ arg.type.name }}): {{ arg.description }}{% if arg.defaultValue %} Default: `{{ arg.defaultValue }}`.{% endif %}
 {% endfor %}{% endif %}
 {% endfor %}

src/article-api/transformers/graphql-reference-transformer.ts

@@ -278,31 +278,49 @@ export class GraphQLReferenceTransformer implements PageTransformer {
     }
   }
 
+  private static STANDARD_PAGINATION_ARGS = new Set(['after', 'before', 'first', 'last'])
+
+  /**
+   * Check if a field has only the standard pagination arguments
+   * (after, before, first, last) with no additional args.
+   */
+  private hasOnlyStandardPaginationArgs(field: FieldT): boolean {
+    if (!field.arguments || field.arguments.length !== 4) return false
+    return field.arguments.every((arg) =>
+      GraphQLReferenceTransformer.STANDARD_PAGINATION_ARGS.has(arg.name),
+    )
+  }
+
   /**
    * Prepare fields for rendering
    */
   private async prepareFields(fields: FieldT[]): Promise<Array<Record<string, unknown>>> {
-    return fields.map((field) => ({
-      name: field.name,
-      type: field.type,
-      href: field.href,
-      description: field.description ? fastTextOnly(field.description) : '',
-      defaultValue: field.defaultValue,
-      isDeprecated: field.isDeprecated || false,
-      deprecationReason: field.deprecationReason
-        ? fastTextOnly(field.deprecationReason)
-        : undefined,
-      arguments: field.arguments
-        ? field.arguments.map((arg) => ({
-            name: arg.name,
-            description: arg.description ? fastTextOnly(arg.description) : '',
-            defaultValue: arg.defaultValue,
-            type: {
-              name: arg.type.name,
-              href: arg.type.href,
-            },
-          }))
-        : undefined,
-    }))
+    return fields.map((field) => {
+      const hasPaginationOnly = this.hasOnlyStandardPaginationArgs(field)
+      return {
+        name: field.name,
+        type: field.type,
+        href: field.href,
+        description: field.description ? fastTextOnly(field.description) : '',
+        defaultValue: field.defaultValue,
+        isDeprecated: field.isDeprecated || false,
+        deprecationReason: field.deprecationReason
+          ? fastTextOnly(field.deprecationReason)
+          : undefined,
+        hasPaginationOnly,
+        arguments:
+          field.arguments && !hasPaginationOnly
+            ? field.arguments.map((arg) => ({
+                name: arg.name,
+                description: arg.description ? fastTextOnly(arg.description) : '',
+                defaultValue: arg.defaultValue,
+                type: {
+                  name: arg.type.name,
+                  href: arg.type.href,
+                },
+              }))
+            : undefined,
+      }
+    })
   }
 }