fix: simpler externalDocs

Author: kai687

specs/abtesting-v3/spec.yml

@@ -1,8 +1,7 @@
 openapi: 3.0.2
 externalDocs:
   url: https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/
-  description: |
-    Related guide: A/B testing.
+  description: A/B testing.
 info:
   title: A/B Testing API
   description: |

specs/abtesting/spec.yml

@@ -1,8 +1,7 @@
 openapi: 3.0.2
 externalDocs:
   url: https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/
-  description: |
-    Related guide: A/B testing.
+  description: A/B testing.
 info:
   title: A/B Testing API
   description: |

specs/advanced-personalization/spec.yml

@@ -92,8 +92,7 @@ tags:
       User profiles contain the affinities each user has for the different facets in your index.
     externalDocs:
       url: https://www.algolia.com/doc/guides/personalization/ai-personalization/what-is-ai-personalization/concepts/user-profiles/
-      description: |
-        Related guide: User Profiles.
+      description: User profiles.
 x-tagGroups:
   - name: Advanced Personalization
     tags:

specs/analytics/paths/search/getUsersCount.yml

@@ -11,13 +11,12 @@ get:
     Since it returns the number of unique users, the sum of the daily values might be different from the total number.
 
     By default:
-    
+
     - Algolia distinguishes search users by their IP address, _unless_ you include a pseudonymous user identifier in your search requests with the `userToken` API parameter or `x-algolia-usertoken` request header.
     - The analyzed period includes the last eight days including the current day.
   externalDocs:
     url: https://www.algolia.com/doc/guides/search-analytics/guides/usertoken/
-    description: |
-      Related guide: Distinguish users for analytics.
+    description: Distinguish users for analytics.
   parameters:
     - $ref: '../../../common/parameters.yml#/Index'
     - $ref: '../../../common/parameters.yml#/StartDate'

specs/analytics/spec.yml

@@ -1,8 +1,7 @@
 openapi: 3.0.2
 externalDocs:
   url: https://www.algolia.com/doc/guides/search-analytics/overview/
-  description: |
-    Related guide: Search analytics.
+  description: Search analytics.
 info:
   title: Analytics API
   description: |

specs/ingestion/paths/tasks/v2/pushTask.yml

@@ -12,8 +12,7 @@ post:
   operationId: pushTask
   externalDocs:
     url: https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/how-to/transform-your-data/
-    description: |
-      Related guide: Pre-indexing data transformation.
+    description: Pre-indexing data transformation.
   x-acl:
     - addObject
     - deleteIndex

specs/personalization/spec.yml

@@ -55,8 +55,7 @@ info:
   version: 1.0.0
 externalDocs:
   url: https://www.algolia.com/doc/guides/personalization/what-is-personalization/
-  description: |
-    Related guide: Algolia Personalization.
+  description: Algolia Personalization.
 components:
   securitySchemes:
     appId:

specs/recommend/spec.yml

@@ -99,15 +99,13 @@ tags:
     description: Retrieve recommendations from a pre-trained AI model. You can train models in the [Algolia dashboard](https://dashboard.algolia.com/recommend/).
     externalDocs:
       url: https://www.algolia.com/doc/guides/algolia-recommend/overview/
-      description: |
-        Related guide: Algolia Recommend.
+      description: Algolia Recommend.
   - name: rules
     x-displayName: Rules
     description: Curate your recommendations with rules, which are _if_-_then_ statements.
     externalDocs:
       url: https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/
-      description: |
-        Related guide: Recommend Rules.
+      description: Recommend Rules.
 x-tagGroups:
   - name: Recommend
     tags:

specs/search/paths/objects/objects.yml

@@ -76,8 +76,7 @@ delete:
       For more information, see [Delete replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/deleting-replicas/).
   externalDocs:
     url: https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/delete-indices/
-    description: |
-      Related guide: Delete indices.
+    description: Delete indices.
   parameters:
     - $ref: '../../../common/parameters.yml#/IndexName'
   responses:

specs/search/spec.yml

@@ -121,8 +121,7 @@ tags:
       API keys can have permissions (access control lists, ACL) and restrictions.
     externalDocs:
       url: https://www.algolia.com/doc/guides/security/api-keys/
-      description: |
-        Related guide: API keys.
+      description: API keys.
 
   - name: Clusters
     description: |
@@ -140,8 +139,7 @@ tags:
       Dictionaries are application-wide.
     externalDocs:
       url: https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/
-      description: |
-        Related guide: Natural languages.
+      description: Natural languages.
   - name: Indices
     description: |
       Manage your indices and index settings.
@@ -150,8 +148,7 @@ tags:
       They're optimal data structures for fast search and are made up of records and settings.
     externalDocs:
       url: https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/
-      description: |
-        Related guide: Manage your indices.
+      description: Manage your indices.
   - name: Records
     description: |
       Add, update, and delete records from your indices.
@@ -162,8 +159,7 @@ tags:
       When adding or updating many records, check the [indexing rate limits](https://support.algolia.com/hc/en-us/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
     externalDocs:
       url: https://www.algolia.com/doc/guides/sending-and-managing-data/prepare-your-data/
-      description: |
-        Related guide: Prepare your records.
+      description: Prepare your records.
   - name: Rules
     description: |
       Create, update, delete, and search for rules.
@@ -174,8 +170,7 @@ tags:
       This can be useful for tuning specific queries or for merchandising.
     externalDocs:
       url: https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/
-      description: |
-        Related guide: Rules.
+      description: Index Rules.
   - name: Search
     description: Search one or more indices for matching records or facet values.
   - name: Synonyms
@@ -185,14 +180,12 @@ tags:
       Synonyms are terms that the search engine should consider equal.
     externalDocs:
       url: https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/
-      description: |
-        Related guide: Synonyms.
+      description: Synonyms.
   - name: Vaults
     description: Algolia Vault lets you restrict access to your clusters to specific IP addresses and provides disk-level encryption at rest.
     externalDocs:
       url: https://www.algolia.com/doc/guides/security/algolia-vault/
-      description: |
-        Related guide: Algolia Vault.
+      description: Algolia Vault.
   - name: _model_index_settings
     x-displayName: Index settings
     description: |