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 · b936532 · b936532
1 parent 28f7703
commit b936532
Show file tree

Hide file tree

Showing 20 changed files with 24 additions and 24 deletions.
diff --git a/packages/algoliasearch/lite/model/banner.ts b/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/packages/algoliasearch/lite/model/bannerImage.ts b/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/packages/algoliasearch/lite/model/bannerImageUrl.ts b/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/packages/algoliasearch/lite/model/bannerLink.ts b/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/packages/algoliasearch/lite/model/widgets.ts b/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>;
 };
diff --git a/packages/client-composition/model/banner.ts b/packages/client-composition/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/packages/client-composition/model/bannerImage.ts b/packages/client-composition/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/packages/client-composition/model/bannerImageUrl.ts b/packages/client-composition/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/packages/client-composition/model/bannerLink.ts b/packages/client-composition/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/packages/client-composition/model/widgets.ts b/packages/client-composition/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>;
 };
diff --git a/packages/client-search/model/banner.ts b/packages/client-search/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/packages/client-search/model/bannerImage.ts b/packages/client-search/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/packages/client-search/model/bannerImageUrl.ts b/packages/client-search/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/packages/client-search/model/bannerLink.ts b/packages/client-search/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/packages/client-search/model/widgets.ts b/packages/client-search/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>;
 };
diff --git a/packages/recommend/model/banner.ts b/packages/recommend/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/packages/recommend/model/bannerImage.ts b/packages/recommend/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/packages/recommend/model/bannerImageUrl.ts b/packages/recommend/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/packages/recommend/model/bannerLink.ts b/packages/recommend/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/packages/recommend/model/widgets.ts b/packages/recommend/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>;
 };