feat(specs): merge composition & composition-full (generated)

algolia/api-clients-automation#5333

Co-authored-by: algolia-bot <[email protected]>
Co-authored-by: Clara Muller <[email protected]>
Co-authored-by: Pierre Millot <[email protected]>
Co-authored-by: shortcuts <[email protected]>

Author: 4 people

algoliasearch/Clients/CompositionClient.cs

@@ -1,7 +1,7 @@
 /*
 * Composition API
 *
-* The Algolia Composition API lets you run composed search requests on your Compositions.  ## Client libraries  Use Algolia's API clients and libraries to reliably integrate Algolia's APIs with your apps.  See: [Algolia's ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/)  ## Base URLs  The base URLs for requests to the Composition API are:  - `https://{APPLICATION_ID}.algolia.net` - `https://{APPLICATION_ID}-dsn.algolia.net`.   If your subscription includes a [Distributed Search Network](https://dashboard.algolia.com/infra),   this ensures that requests are sent to servers closest to users.  Both URLs provide high availability by distributing requests with load balancing.  **All requests must use HTTPS.**  ## Retry strategy  To guarantee high availability, implement a retry strategy for all API requests using the URLs of your servers as fallbacks:  - `https://{APPLICATION_ID}-1.algolianet.com` - `https://{APPLICATION_ID}-2.algolianet.com` - `https://{APPLICATION_ID}-3.algolianet.com`  These URLs use a different DNS provider than the primary URLs. You should randomize this list to ensure an even load across the three servers.  All Algolia API clients implement this retry strategy.  ## Authentication  To authenticate your API requests, add these headers:  - `x-algolia-application-id`. Your Algolia application ID. - `x-algolia-api-key`. An API key with the necessary permissions to make the request.   The required access control list (ACL) to make a request is listed in each endpoint's reference.  You can find your application ID and API key in the [Algolia dashboard](https://dashboard.algolia.com/account).  ## Request format  Depending on the endpoint, request bodies are either JSON objects or arrays of JSON objects,  ## Parameters  Parameters are passed as query parameters for GET and DELETE requests, and in the request body for POST and PUT requests.  Query parameters must be [URL-encoded](https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding). Non-ASCII characters must be UTF-8 encoded. Plus characters (`+`) are interpreted as spaces. Arrays as query parameters must be one of:  - A comma-separated string: `attributesToRetrieve=title,description` - A URL-encoded JSON array: `attributesToRetrieve=%5B%22title%22,%22description%22%D`  ## Response status and errors  The Composition API returns JSON responses. Since JSON doesn't guarantee any specific ordering, don't rely on the order of attributes in the API response.  Successful responses return a `2xx` status. Client errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a `message` property with more information.  ## Version  The current version of the Composition API is version 1, as indicated by the `/1/` in each endpoint's URL.
+* The Algolia Composition API lets you run composed search requests on your Compositions.  ## Client libraries  Use Algolia's API clients and libraries to reliably integrate Algolia's APIs with your apps.  See: [Algolia's ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/)  ## Base URLs  The base URLs for requests to the Composition API are:  - `https://{APPLICATION_ID}.algolia.net` - `https://{APPLICATION_ID}-dsn.algolia.net`.   If your subscription includes a [Distributed Search Network](https://dashboard.algolia.com/infra),   this ensures that requests are sent to servers closest to users.  Both URLs provide high availability by distributing requests with load balancing.  **All requests must use HTTPS.**  ## Retry strategy  To guarantee high availability, implement a retry strategy for all API requests using the URLs of your servers as fallbacks:  - `https://{APPLICATION_ID}-1.algolianet.com` - `https://{APPLICATION_ID}-2.algolianet.com` - `https://{APPLICATION_ID}-3.algolianet.com`  These URLs use a different DNS provider than the primary URLs. You should randomize this list to ensure an even load across the three servers.  All Algolia API clients implement this retry strategy.  ## Authentication  To authenticate your API requests, add these headers:  - `x-algolia-application-id`. Your Algolia application ID. - `x-algolia-api-key`. An API key with the necessary permissions to make the request.   The required access control list (ACL) to make a request is listed in each endpoint's reference.  You can find your application ID and API key in the [Algolia dashboard](https://dashboard.algolia.com/account).  ## Request format  Depending on the endpoint, request bodies are either JSON objects or arrays of JSON objects,  ## Parameters  Parameters are passed in the request body for POST and PUT requests. Query parameters must be [URL-encoded](https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding). Non-ASCII characters must be UTF-8 encoded. Plus characters (`+`) are interpreted as spaces.  ## Response status and errors  The Composition API returns JSON responses. Since JSON doesn't guarantee any specific ordering, don't rely on the order of attributes in the API response.  Successful responses return a `2xx` status. Client errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a `message` property with more information.  ## Version  The current version of the Composition API is version 1, as indicated by the `/1/` in each endpoint's URL.
 *
 * The version of the OpenAPI document: 1.0.0
 * Generated by: https://github.com/openapitools/openapi-generator.git

algoliasearch/Clients/CompositionConfiguration.cs

@@ -0,0 +1,32 @@
+//
+// 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.
+//
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Text.Json;
+using System.Text.Json.Serialization;
+using Algolia.Search.Serializer;
+
+namespace Algolia.Search.Models.Composition;
+
+/// <summary>
+/// Type of Composition Batch operation.
+/// </summary>
+/// <value>Type of Composition Batch operation.</value>
+[JsonConverter(typeof(Serializer.JsonStringEnumConverter<Action>))]
+public enum Action
+{
+  /// <summary>
+  /// Enum Upsert for value: upsert
+  /// </summary>
+  [JsonPropertyName("upsert")]
+  Upsert = 1,
+
+  /// <summary>
+  /// Enum Delete for value: delete
+  /// </summary>
+  [JsonPropertyName("delete")]
+  Delete = 2,
+}

algoliasearch/Models/Composition/Action.cs

@@ -0,0 +1,31 @@
+//
+// 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.
+//
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Text.Json;
+using System.Text.Json.Serialization;
+using Algolia.Search.Serializer;
+
+namespace Algolia.Search.Models.Composition;
+
+/// <summary>
+/// Defines advancedSyntaxFeatures
+/// </summary>
+[JsonConverter(typeof(Serializer.JsonStringEnumConverter<AdvancedSyntaxFeatures>))]
+public enum AdvancedSyntaxFeatures
+{
+  /// <summary>
+  /// Enum ExactPhrase for value: exactPhrase
+  /// </summary>
+  [JsonPropertyName("exactPhrase")]
+  ExactPhrase = 1,
+
+  /// <summary>
+  /// Enum ExcludeWords for value: excludeWords
+  /// </summary>
+  [JsonPropertyName("excludeWords")]
+  ExcludeWords = 2,
+}

algoliasearch/Models/Composition/AdvancedSyntaxFeatures.cs

@@ -0,0 +1,43 @@
+//
+// 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.
+//
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Text.Json;
+using System.Text.Json.Serialization;
+using Algolia.Search.Serializer;
+
+namespace Algolia.Search.Models.Composition;
+
+/// <summary>
+/// Defines alternativesAsExact
+/// </summary>
+[JsonConverter(typeof(Serializer.JsonStringEnumConverter<AlternativesAsExact>))]
+public enum AlternativesAsExact
+{
+  /// <summary>
+  /// Enum IgnorePlurals for value: ignorePlurals
+  /// </summary>
+  [JsonPropertyName("ignorePlurals")]
+  IgnorePlurals = 1,
+
+  /// <summary>
+  /// Enum SingleWordSynonym for value: singleWordSynonym
+  /// </summary>
+  [JsonPropertyName("singleWordSynonym")]
+  SingleWordSynonym = 2,
+
+  /// <summary>
+  /// Enum MultiWordsSynonym for value: multiWordsSynonym
+  /// </summary>
+  [JsonPropertyName("multiWordsSynonym")]
+  MultiWordsSynonym = 3,
+
+  /// <summary>
+  /// Enum IgnoreConjugations for value: ignoreConjugations
+  /// </summary>
+  [JsonPropertyName("ignoreConjugations")]
+  IgnoreConjugations = 4,
+}

algoliasearch/Models/Composition/AlternativesAsExact.cs

@@ -0,0 +1,44 @@
+//
+// 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.
+//
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Text.Json;
+using System.Text.Json.Serialization;
+using Algolia.Search.Serializer;
+
+namespace Algolia.Search.Models.Composition;
+
+/// <summary>
+/// Which part of the search query the pattern should match:  - `startsWith`. The pattern must match the beginning of the query. - `endsWith`. The pattern must match the end of the query. - `is`. The pattern must match the query exactly. - `contains`. The pattern must match anywhere in the query.  Empty queries are only allowed as patterns with `anchoring: is`.
+/// </summary>
+/// <value>Which part of the search query the pattern should match:  - `startsWith`. The pattern must match the beginning of the query. - `endsWith`. The pattern must match the end of the query. - `is`. The pattern must match the query exactly. - `contains`. The pattern must match anywhere in the query.  Empty queries are only allowed as patterns with `anchoring: is`. </value>
+[JsonConverter(typeof(Serializer.JsonStringEnumConverter<Anchoring>))]
+public enum Anchoring
+{
+  /// <summary>
+  /// Enum Is for value: is
+  /// </summary>
+  [JsonPropertyName("is")]
+  Is = 1,
+
+  /// <summary>
+  /// Enum StartsWith for value: startsWith
+  /// </summary>
+  [JsonPropertyName("startsWith")]
+  StartsWith = 2,
+
+  /// <summary>
+  /// Enum EndsWith for value: endsWith
+  /// </summary>
+  [JsonPropertyName("endsWith")]
+  EndsWith = 3,
+
+  /// <summary>
+  /// Enum Contains for value: contains
+  /// </summary>
+  [JsonPropertyName("contains")]
+  Contains = 4,
+}