fix(specs): adjust style for banner descriptions (#4362) (generated) …

…[skip ci] Co-authored-by: Kai Welke <kai.welke@algolia.com> Co-authored-by: Pierre Millot <pierre.millot@algolia.com>
algolia · Jan 16, 2025 · f0afd35 · f0afd35
1 parent 952639f
commit f0afd35
Show file tree

Hide file tree

Showing 122 changed files with 193 additions and 193 deletions.
diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Recommend/Banner.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Recommend/Banner.cs
@@ -12,7 +12,7 @@
 namespace Algolia.Search.Models.Recommend;
 
 /// <summary>
-/// a search banner with image and url.
+/// Banner with image and link to redirect users.
 /// </summary>
 public partial class Banner
 {

diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Recommend/BannerImage.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Recommend/BannerImage.cs
@@ -12,7 +12,7 @@
 namespace Algolia.Search.Models.Recommend;
 
 /// <summary>
-/// image of a search banner.
+/// Image to show inside a banner.
 /// </summary>
 public partial class BannerImage
 {

diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Recommend/BannerImageUrl.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Recommend/BannerImageUrl.cs
@@ -12,7 +12,7 @@
 namespace Algolia.Search.Models.Recommend;
 
 /// <summary>
-/// url for a search banner image.
+/// URL for an image to show inside a banner.
 /// </summary>
 public partial class BannerImageUrl
 {

diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Recommend/BannerLink.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Recommend/BannerLink.cs
@@ -12,7 +12,7 @@
 namespace Algolia.Search.Models.Recommend;
 
 /// <summary>
-/// link for a banner defined in merchandising studio.
+/// Link for a banner defined in the Merchandising Studio.
 /// </summary>
 public partial class BannerLink
 {

diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Recommend/Widgets.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Recommend/Widgets.cs
@@ -12,7 +12,7 @@
 namespace Algolia.Search.Models.Recommend;
 
 /// <summary>
-/// widgets returned from any rules that are applied to the current search.
+/// Widgets returned from any rules that are applied to the current search.
 /// </summary>
 public partial class Widgets
 {
@@ -24,9 +24,9 @@ public Widgets()
   }
 
   /// <summary>
-  /// banners defined in the merchandising studio for the given search.
+  /// Banners defined in the Merchandising Studio for a given search.
   /// </summary>
-  /// <value>banners defined in the merchandising studio for the given search.</value>
+  /// <value>Banners defined in the Merchandising Studio for a given search.</value>
   [JsonPropertyName("banners")]
   public List<Banner> Banners { get; set; }
 

diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/Banner.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/Banner.cs
@@ -12,7 +12,7 @@
 namespace Algolia.Search.Models.Search;
 
 /// <summary>
-/// a search banner with image and url.
+/// Banner with image and link to redirect users.
 /// </summary>
 public partial class Banner
 {

diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/BannerImage.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/BannerImage.cs
@@ -12,7 +12,7 @@
 namespace Algolia.Search.Models.Search;
 
 /// <summary>
-/// image of a search banner.
+/// Image to show inside a banner.
 /// </summary>
 public partial class BannerImage
 {

diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/BannerImageUrl.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/BannerImageUrl.cs
@@ -12,7 +12,7 @@
 namespace Algolia.Search.Models.Search;
 
 /// <summary>
-/// url for a search banner image.
+/// URL for an image to show inside a banner.
 /// </summary>
 public partial class BannerImageUrl
 {

diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/BannerLink.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/BannerLink.cs
@@ -12,7 +12,7 @@
 namespace Algolia.Search.Models.Search;
 
 /// <summary>
-/// link for a banner defined in merchandising studio.
+/// Link for a banner defined in the Merchandising Studio.
 /// </summary>
 public partial class BannerLink
 {

diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/Widgets.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/Widgets.cs
@@ -12,7 +12,7 @@
 namespace Algolia.Search.Models.Search;
 
 /// <summary>
-/// widgets returned from any rules that are applied to the current search.
+/// Widgets returned from any rules that are applied to the current search.
 /// </summary>
 public partial class Widgets
 {
@@ -24,9 +24,9 @@ public Widgets()
   }
 
   /// <summary>
-  /// banners defined in the merchandising studio for the given search.
+  /// Banners defined in the Merchandising Studio for a given search.
   /// </summary>
-  /// <value>banners defined in the merchandising studio for the given search.</value>
+  /// <value>Banners defined in the Merchandising Studio for a given search.</value>
   [JsonPropertyName("banners")]
   public List<Banner> Banners { get; set; }
 

diff --git a/clients/algoliasearch-client-dart/packages/algoliasearch/lib/src/model/widgets.dart b/clients/algoliasearch-client-dart/packages/algoliasearch/lib/src/model/widgets.dart
@@ -13,7 +13,7 @@ final class Widgets {
     this.banners,
   });
 
-  /// banners defined in the merchandising studio for the given search.
+  /// Banners defined in the Merchandising Studio for a given search.
   @JsonKey(name: r'banners')
   final List<Banner>? banners;
 

diff --git a/clients/algoliasearch-client-dart/packages/client_recommend/lib/src/model/widgets.dart b/clients/algoliasearch-client-dart/packages/client_recommend/lib/src/model/widgets.dart
@@ -13,7 +13,7 @@ final class Widgets {
     this.banners,
   });
 
-  /// banners defined in the merchandising studio for the given search.
+  /// Banners defined in the Merchandising Studio for a given search.
   @JsonKey(name: r'banners')
   final List<Banner>? banners;
 

diff --git a/clients/algoliasearch-client-dart/packages/client_search/lib/src/model/widgets.dart b/clients/algoliasearch-client-dart/packages/client_search/lib/src/model/widgets.dart
@@ -13,7 +13,7 @@ final class Widgets {
     this.banners,
   });
 
-  /// banners defined in the merchandising studio for the given search.
+  /// Banners defined in the Merchandising Studio for a given search.
   @JsonKey(name: r'banners')
   final List<Banner>? banners;
 

diff --git a/clients/algoliasearch-client-go/algolia/recommend/model_banner.go b/clients/algoliasearch-client-go/algolia/recommend/model_banner.go
diff --git a/clients/algoliasearch-client-go/algolia/recommend/model_banner_image.go b/clients/algoliasearch-client-go/algolia/recommend/model_banner_image.go
diff --git a/clients/algoliasearch-client-go/algolia/recommend/model_banner_image_url.go b/clients/algoliasearch-client-go/algolia/recommend/model_banner_image_url.go
diff --git a/clients/algoliasearch-client-go/algolia/recommend/model_banner_link.go b/clients/algoliasearch-client-go/algolia/recommend/model_banner_link.go
diff --git a/clients/algoliasearch-client-go/algolia/recommend/model_widgets.go b/clients/algoliasearch-client-go/algolia/recommend/model_widgets.go
diff --git a/clients/algoliasearch-client-go/algolia/search/model_banner.go b/clients/algoliasearch-client-go/algolia/search/model_banner.go
diff --git a/clients/algoliasearch-client-go/algolia/search/model_banner_image.go b/clients/algoliasearch-client-go/algolia/search/model_banner_image.go
diff --git a/clients/algoliasearch-client-go/algolia/search/model_banner_image_url.go b/clients/algoliasearch-client-go/algolia/search/model_banner_image_url.go
diff --git a/clients/algoliasearch-client-go/algolia/search/model_banner_link.go b/clients/algoliasearch-client-go/algolia/search/model_banner_link.go
diff --git a/clients/algoliasearch-client-go/algolia/search/model_widgets.go b/clients/algoliasearch-client-go/algolia/search/model_widgets.go
diff --git a/...liasearch-client-java/algoliasearch/src/main/java/com/algolia/model/recommend/Banner.java b/...liasearch-client-java/algoliasearch/src/main/java/com/algolia/model/recommend/Banner.java
@@ -7,7 +7,7 @@
 import com.fasterxml.jackson.databind.annotation.*;
 import java.util.Objects;
 
-/** a search banner with image and url. */
+/** Banner with image and link to redirect users. */
 public class Banner {
 
   @JsonProperty("image")

diff --git a/...arch-client-java/algoliasearch/src/main/java/com/algolia/model/recommend/BannerImage.java b/...arch-client-java/algoliasearch/src/main/java/com/algolia/model/recommend/BannerImage.java
@@ -9,7 +9,7 @@
 import java.util.List;
 import java.util.Objects;
 
-/** image of a search banner. */
+/** Image to show inside a banner. */
 public class BannerImage {
 
   @JsonProperty("urls")

diff --git a/...h-client-java/algoliasearch/src/main/java/com/algolia/model/recommend/BannerImageUrl.java b/...h-client-java/algoliasearch/src/main/java/com/algolia/model/recommend/BannerImageUrl.java
@@ -7,7 +7,7 @@
 import com.fasterxml.jackson.databind.annotation.*;
 import java.util.Objects;
 
-/** url for a search banner image. */
+/** URL for an image to show inside a banner. */
 public class BannerImageUrl {
 
   @JsonProperty("url")

diff --git a/...earch-client-java/algoliasearch/src/main/java/com/algolia/model/recommend/BannerLink.java b/...earch-client-java/algoliasearch/src/main/java/com/algolia/model/recommend/BannerLink.java
@@ -7,7 +7,7 @@
 import com.fasterxml.jackson.databind.annotation.*;
 import java.util.Objects;
 
-/** link for a banner defined in merchandising studio. */
+/** Link for a banner defined in the Merchandising Studio. */
 public class BannerLink {
 
   @JsonProperty("url")

diff --git a/...iasearch-client-java/algoliasearch/src/main/java/com/algolia/model/recommend/Widgets.java b/...iasearch-client-java/algoliasearch/src/main/java/com/algolia/model/recommend/Widgets.java
@@ -9,7 +9,7 @@
 import java.util.List;
 import java.util.Objects;
 
-/** widgets returned from any rules that are applied to the current search. */
+/** Widgets returned from any rules that are applied to the current search. */
 public class Widgets {
 
   @JsonProperty("banners")
@@ -28,7 +28,7 @@ public Widgets addBanners(Banner bannersItem) {
     return this;
   }
 
-  /** banners defined in the merchandising studio for the given search. */
+  /** Banners defined in the Merchandising Studio for a given search. */
   @javax.annotation.Nullable
   public List<Banner> getBanners() {
     return banners;

diff --git a/...lgoliasearch-client-java/algoliasearch/src/main/java/com/algolia/model/search/Banner.java b/...lgoliasearch-client-java/algoliasearch/src/main/java/com/algolia/model/search/Banner.java
@@ -7,7 +7,7 @@
 import com.fasterxml.jackson.databind.annotation.*;
 import java.util.Objects;
 
-/** a search banner with image and url. */
+/** Banner with image and link to redirect users. */
 public class Banner {
 
   @JsonProperty("image")

diff --git a/...asearch-client-java/algoliasearch/src/main/java/com/algolia/model/search/BannerImage.java b/...asearch-client-java/algoliasearch/src/main/java/com/algolia/model/search/BannerImage.java
@@ -9,7 +9,7 @@
 import java.util.List;
 import java.util.Objects;
 
-/** image of a search banner. */
+/** Image to show inside a banner. */
 public class BannerImage {
 
   @JsonProperty("urls")

diff --git a/...arch-client-java/algoliasearch/src/main/java/com/algolia/model/search/BannerImageUrl.java b/...arch-client-java/algoliasearch/src/main/java/com/algolia/model/search/BannerImageUrl.java
@@ -7,7 +7,7 @@
 import com.fasterxml.jackson.databind.annotation.*;
 import java.util.Objects;
 
-/** url for a search banner image. */
+/** URL for an image to show inside a banner. */
 public class BannerImageUrl {
 
   @JsonProperty("url")

diff --git a/...iasearch-client-java/algoliasearch/src/main/java/com/algolia/model/search/BannerLink.java b/...iasearch-client-java/algoliasearch/src/main/java/com/algolia/model/search/BannerLink.java
@@ -7,7 +7,7 @@
 import com.fasterxml.jackson.databind.annotation.*;
 import java.util.Objects;
 
-/** link for a banner defined in merchandising studio. */
+/** Link for a banner defined in the Merchandising Studio. */
 public class BannerLink {
 
   @JsonProperty("url")

diff --git a/...goliasearch-client-java/algoliasearch/src/main/java/com/algolia/model/search/Widgets.java b/...goliasearch-client-java/algoliasearch/src/main/java/com/algolia/model/search/Widgets.java
@@ -9,7 +9,7 @@
 import java.util.List;
 import java.util.Objects;
 
-/** widgets returned from any rules that are applied to the current search. */
+/** Widgets returned from any rules that are applied to the current search. */
 public class Widgets {
 
   @JsonProperty("banners")
@@ -28,7 +28,7 @@ public Widgets addBanners(Banner bannersItem) {
     return this;
   }
 
-  /** banners defined in the merchandising studio for the given search. */
+  /** Banners defined in the Merchandising Studio for a given search. */
   @javax.annotation.Nullable
   public List<Banner> getBanners() {
     return banners;

diff --git a/clients/algoliasearch-client-javascript/packages/algoliasearch/lite/model/banner.ts b/clients/algoliasearch-client-javascript/packages/algoliasearch/lite/model/banner.ts
@@ -4,7 +4,7 @@ import type { BannerImage } from './bannerImage';
 import type { BannerLink } from './bannerLink';
 
 /**
- * a search banner with image and url.
+ * Banner with image and link to redirect users.
  */
 export type Banner = {
   image?: BannerImage;

diff --git a/clients/algoliasearch-client-javascript/packages/algoliasearch/lite/model/bannerImage.ts b/clients/algoliasearch-client-javascript/packages/algoliasearch/lite/model/bannerImage.ts
@@ -3,7 +3,7 @@
 import type { BannerImageUrl } from './bannerImageUrl';
 
 /**
- * image of a search banner.
+ * Image to show inside a banner.
  */
 export type BannerImage = {
   urls?: Array<BannerImageUrl>;

diff --git a/clients/algoliasearch-client-javascript/packages/algoliasearch/lite/model/bannerImageUrl.ts b/clients/algoliasearch-client-javascript/packages/algoliasearch/lite/model/bannerImageUrl.ts
@@ -1,7 +1,7 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 /**
- * url for a search banner image.
+ * URL for an image to show inside a banner.
  */
 export type BannerImageUrl = {
   url?: string;

diff --git a/clients/algoliasearch-client-javascript/packages/algoliasearch/lite/model/bannerLink.ts b/clients/algoliasearch-client-javascript/packages/algoliasearch/lite/model/bannerLink.ts
@@ -1,7 +1,7 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 /**
- * link for a banner defined in merchandising studio.
+ * Link for a banner defined in the Merchandising Studio.
  */
 export type BannerLink = {
   url?: string;

diff --git a/clients/algoliasearch-client-javascript/packages/algoliasearch/lite/model/widgets.ts b/clients/algoliasearch-client-javascript/packages/algoliasearch/lite/model/widgets.ts
@@ -3,11 +3,11 @@
 import type { Banner } from './banner';
 
 /**
- * widgets returned from any rules that are applied to the current search.
+ * Widgets returned from any rules that are applied to the current search.
  */
 export type Widgets = {
   /**
-   * banners defined in the merchandising studio for the given search.
+   * Banners defined in the Merchandising Studio for a given search.
    */
   banners?: Array<Banner>;
 };