fix(specs): adjust style for banner descriptions (generated)

algolia/api-clients-automation#4362 Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Kai Welke <[email protected]> Co-authored-by: Pierre Millot <[email protected]>
algolia · Jan 16, 2025 · fdaa94d · fdaa94d
1 parent 01f3583
commit fdaa94d
Show file tree

Hide file tree

Showing 10 changed files with 12 additions and 12 deletions.
diff --git a/Sources/Recommend/Models/RecommendBanner.swift b/Sources/Recommend/Models/RecommendBanner.swift
@@ -6,7 +6,7 @@ import Foundation
     import Core
 #endif
 
-/// a search banner with image and url.
+/// Banner with image and link to redirect users.
 public struct RecommendBanner: Codable, JSONEncodable {
     public var image: RecommendBannerImage?
     public var link: RecommendBannerLink?

diff --git a/Sources/Recommend/Models/RecommendBannerImage.swift b/Sources/Recommend/Models/RecommendBannerImage.swift
@@ -6,7 +6,7 @@ import Foundation
     import Core
 #endif
 
-/// image of a search banner.
+/// Image to show inside a banner.
 public struct RecommendBannerImage: Codable, JSONEncodable {
     public var urls: [RecommendBannerImageUrl]?
     public var title: String?

diff --git a/Sources/Recommend/Models/RecommendBannerImageUrl.swift b/Sources/Recommend/Models/RecommendBannerImageUrl.swift
@@ -6,7 +6,7 @@ import Foundation
     import Core
 #endif
 
-/// url for a search banner image.
+/// URL for an image to show inside a banner.
 public struct RecommendBannerImageUrl: Codable, JSONEncodable {
     public var url: String?
 

diff --git a/Sources/Recommend/Models/RecommendBannerLink.swift b/Sources/Recommend/Models/RecommendBannerLink.swift
@@ -6,7 +6,7 @@ import Foundation
     import Core
 #endif
 
-/// link for a banner defined in merchandising studio.
+/// Link for a banner defined in the Merchandising Studio.
 public struct RecommendBannerLink: Codable, JSONEncodable {
     public var url: String?
 

diff --git a/Sources/Recommend/Models/RecommendWidgets.swift b/Sources/Recommend/Models/RecommendWidgets.swift
@@ -6,9 +6,9 @@ import Foundation
     import Core
 #endif
 
-/// 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 struct RecommendWidgets: Codable, JSONEncodable {
-    /// banners defined in the merchandising studio for the given search.
+    /// Banners defined in the Merchandising Studio for a given search.
     public var banners: [RecommendBanner]?
 
     public init(banners: [RecommendBanner]? = nil) {

diff --git a/Sources/Search/Models/SearchBanner.swift b/Sources/Search/Models/SearchBanner.swift
@@ -6,7 +6,7 @@ import Foundation
     import Core
 #endif
 
-/// a search banner with image and url.
+/// Banner with image and link to redirect users.
 public struct SearchBanner: Codable, JSONEncodable {
     public var image: SearchBannerImage?
     public var link: SearchBannerLink?

diff --git a/Sources/Search/Models/SearchBannerImage.swift b/Sources/Search/Models/SearchBannerImage.swift
@@ -6,7 +6,7 @@ import Foundation
     import Core
 #endif
 
-/// image of a search banner.
+/// Image to show inside a banner.
 public struct SearchBannerImage: Codable, JSONEncodable {
     public var urls: [SearchBannerImageUrl]?
     public var title: String?

diff --git a/Sources/Search/Models/SearchBannerImageUrl.swift b/Sources/Search/Models/SearchBannerImageUrl.swift
@@ -6,7 +6,7 @@ import Foundation
     import Core
 #endif
 
-/// url for a search banner image.
+/// URL for an image to show inside a banner.
 public struct SearchBannerImageUrl: Codable, JSONEncodable {
     public var url: String?
 

diff --git a/Sources/Search/Models/SearchBannerLink.swift b/Sources/Search/Models/SearchBannerLink.swift
@@ -6,7 +6,7 @@ import Foundation
     import Core
 #endif
 
-/// link for a banner defined in merchandising studio.
+/// Link for a banner defined in the Merchandising Studio.
 public struct SearchBannerLink: Codable, JSONEncodable {
     public var url: String?
 

diff --git a/Sources/Search/Models/SearchWidgets.swift b/Sources/Search/Models/SearchWidgets.swift
@@ -6,9 +6,9 @@ import Foundation
     import Core
 #endif
 
-/// 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 struct SearchWidgets: Codable, JSONEncodable {
-    /// banners defined in the merchandising studio for the given search.
+    /// Banners defined in the Merchandising Studio for a given search.
     public var banners: [SearchBanner]?
 
     public init(banners: [SearchBanner]? = nil) {