Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(clients): escape char in comments #3973

Merged
merged 1 commit into from
Oct 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions templates/csharp/api.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ namespace Algolia.Search.Clients;
{{/x-acl}}
{{/vendorExtensions}}
{{#allParams}}
/// <param name="{{paramName}}">{{{description}}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}}</param>
/// <param name="{{paramName}}">{{{description}}}{{^required}} (optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}}</param>
{{/allParams}}
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
Expand All @@ -58,7 +58,7 @@ namespace Algolia.Search.Clients;
{{/x-acl}}
{{/vendorExtensions}}
{{#allParams}}
/// <param name="{{paramName}}">{{{description}}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}}</param>
/// <param name="{{paramName}}">{{{description}}}{{^required}} (optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}}</param>
{{/allParams}}
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
Expand Down
2 changes: 1 addition & 1 deletion templates/csharp/modelEnum.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
{{#allowableValues}}
{{#enumVars}}
/// <summary>
/// Enum {{name}} for value: {{value}}
/// Enum {{name}} for value: {{{value}}}
/// </summary>
{{#isString}}
{{^useGenericHost}}
Expand Down
2 changes: 1 addition & 1 deletion templates/csharp/modelGeneric.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@
/// </summary>
{{#readWriteVars}}
{{#required}}
/// <param name="{{#lambda.camelcase_sanitize_param}}{{name}}{{/lambda.camelcase_sanitize_param}}">{{description}}{{^description}}{{nameInCamelCase}}{{/description}}{{#required}} (required){{/required}}{{#defaultValue}} (default to {{.}}){{/defaultValue}}.</param>
/// <param name="{{#lambda.camelcase_sanitize_param}}{{name}}{{/lambda.camelcase_sanitize_param}}">{{{description}}}{{^description}}{{nameInCamelCase}}{{/description}}{{#required}} (required){{/required}}{{#defaultValue}} (default to {{{.}}}){{/defaultValue}}.</param>
{{/required}}
{{/readWriteVars}}
{{#hasOnlyReadOnly}}
Expand Down
2 changes: 1 addition & 1 deletion templates/csharp/snippets/method.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ public class Snippet{{client}}
/// </summary>
public async Task SnippetFor{{client}}{{#lambda.pascalcase}}{{method}}{{/lambda.pascalcase}}{{testIndex}}()
{
// >SEPARATOR {{method}} {{testName}}
// >SEPARATOR {{method}} {{{testName}}}
// Initialize the client
{{> snippets/init}}

Expand Down
2 changes: 1 addition & 1 deletion templates/dart/snippets/method.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
//
// {{{description}}}
void snippetFor{{method}}{{testIndex}}() async {
// >SEPARATOR {{method}} {{testName}}
// >SEPARATOR {{method}} {{{testName}}}
// Initialize the client
{{> snippets/init}}

Expand Down
2 changes: 1 addition & 1 deletion templates/go/snippets/method.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ func SnippetFor{{#lambda.titlecase}}{{method}}{{/lambda.titlecase}}Of{{#lambda.p
{{{description}}}
*/

// >SEPARATOR {{method}} {{testName}}
// >SEPARATOR {{method}} {{{testName}}}
// Initialize the client{{#hasRegionalHost}} with your application region, eg. {{clientPrefix}}.ALGOLIA_APPLICATION_REGION{{/hasRegionalHost}}
{{> snippets/init}}

Expand Down
8 changes: 4 additions & 4 deletions templates/java/api.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ public class {{classname}} extends ApiClient {
{{#operation}}
/**
* {{{notes}}}{{#allParams}}
* @param {{paramName}} {{{description}}}{{#required}} (required){{/required}}{{^required}} (optional{{^isContainer}}{{#defaultValue}}, default to {{.}}{{/defaultValue}}{{/isContainer}}){{/required}}{{/allParams}}
* @param {{paramName}} {{{description}}}{{#required}} (required){{/required}}{{^required}} (optional{{^isContainer}}{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}{{/isContainer}}){{/required}}{{/allParams}}
{{#vendorExtensions}}{{#x-is-generic}}* @param innerType The class held by the index, could be your custom class or {@link Object}.{{/x-is-generic}}{{/vendorExtensions}}
* @param requestOptions The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
{{> api_javadoc}}
Expand All @@ -145,7 +145,7 @@ public class {{classname}} extends ApiClient {
{{! This case only sets `requestOptions` as optional }}
/**
* {{{notes}}}{{#allParams}}
* @param {{paramName}} {{{description}}}{{#required}} (required){{/required}}{{^required}} (optional{{^isContainer}}{{#defaultValue}}, default to {{.}}{{/defaultValue}}{{/isContainer}}){{/required}}{{/allParams}}
* @param {{paramName}} {{{description}}}{{#required}} (required){{/required}}{{^required}} (optional{{^isContainer}}{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}{{/isContainer}}){{/required}}{{/allParams}}
{{#vendorExtensions}}{{#x-is-generic}}* @param innerType The class held by the index, could be your custom class or {@link Object}.{{/x-is-generic}}{{/vendorExtensions}}
{{> api_javadoc}}
public {{> return_type}} {{operationId}}({{#requiredParams}}@Nonnull {{{dataType}}} {{paramName}}{{^-last}}, {{/-last}}{{/requiredParams}}{{#hasRequiredParams}}{{#hasOptionalParams}},{{/hasOptionalParams}}{{/hasRequiredParams}}{{#optionalParams}}{{{dataType}}} {{paramName}}{{^-last}}, {{/-last}}{{/optionalParams}}{{#vendorExtensions}}{{#x-is-generic}}, Class<T> innerType{{/x-is-generic}}{{/vendorExtensions}}) throws AlgoliaRuntimeException {
Expand Down Expand Up @@ -180,7 +180,7 @@ public class {{classname}} extends ApiClient {
/**
* (asynchronously)
* {{{notes}}}{{#allParams}}
* @param {{paramName}} {{{description}}}{{#required}} (required){{/required}}{{^required}} (optional{{^isContainer}}{{#defaultValue}}, default to {{.}}{{/defaultValue}}{{/isContainer}}){{/required}}{{/allParams}}{{#vendorExtensions}}{{#x-is-generic}}
* @param {{paramName}} {{{description}}}{{#required}} (required){{/required}}{{^required}} (optional{{^isContainer}}{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}{{/isContainer}}){{/required}}{{/allParams}}{{#vendorExtensions}}{{#x-is-generic}}
* @param innerType The class held by the index, could be your custom class or {@link Object}.{{/x-is-generic}}{{/vendorExtensions}}
* @param requestOptions The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
{{> api_javadoc}}
Expand All @@ -204,7 +204,7 @@ public class {{classname}} extends ApiClient {
/**
* (asynchronously)
* {{{notes}}}{{#allParams}}
* @param {{paramName}} {{{description}}}{{#required}} (required){{/required}}{{^required}} (optional{{^isContainer}}{{#defaultValue}}, default to {{.}}{{/defaultValue}}{{/isContainer}}){{/required}}{{/allParams}}{{#vendorExtensions}}{{#x-is-generic}}
* @param {{paramName}} {{{description}}}{{#required}} (required){{/required}}{{^required}} (optional{{^isContainer}}{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}{{/isContainer}}){{/required}}{{/allParams}}{{#vendorExtensions}}{{#x-is-generic}}
* @param innerType The class held by the index, could be your custom class or {@link Object}.{{/x-is-generic}}{{/vendorExtensions}}
{{> api_javadoc}}
public {{> return_type_async}} {{operationId}}Async({{#requiredParams}}@Nonnull {{{dataType}}} {{paramName}}{{^-last}}, {{/-last}}{{/requiredParams}}{{#hasRequiredParams}}{{#hasOptionalParams}},{{/hasOptionalParams}}{{/hasRequiredParams}}{{#optionalParams}}{{{dataType}}} {{paramName}}{{^-last}}, {{/-last}}{{/optionalParams}}{{#vendorExtensions}}{{#x-is-generic}}, Class<T> innerType{{/x-is-generic}}{{/vendorExtensions}}) throws AlgoliaRuntimeException {
Expand Down
2 changes: 1 addition & 1 deletion templates/java/snippets/method.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ class Snippet{{client}} {
//
// {{{description}}}
void snippetFor{{#lambda.pascalcase}}{{method}}{{/lambda.pascalcase}}{{testIndex}}() throws Exception {
// >SEPARATOR {{method}} {{testName}}
// >SEPARATOR {{method}} {{{testName}}}
// Initialize the client
{{> snippets/init}}

Expand Down
2 changes: 1 addition & 1 deletion templates/javascript/snippets/method.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import type { RequestOptions } from '@algolia/client-common';
//
// {{{description}}}
export {{#isAsyncMethod}}async{{/isAsyncMethod}} function snippetFor{{#lambda.pascalcase}}{{method}}{{/lambda.pascalcase}}{{testIndex}}(): {{#isAsyncMethod}}Promise<void>{{/isAsyncMethod}}{{^isAsyncMethod}}void{{/isAsyncMethod}} {
// >SEPARATOR {{method}} {{testName}}
// >SEPARATOR {{method}} {{{testName}}}
// Initialize the client
// {{#hasRegionalHost}}Replace '{{defaultRegion}}' with your Algolia Application Region{{/hasRegionalHost}}
{{> snippets/init}}
Expand Down
2 changes: 1 addition & 1 deletion templates/kotlin/snippets/method.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ class Snippet{{client}} {
{{#blocksRequests}}
{{#snippets}}
suspend fun snippetFor{{#lambda.pascalcase}}{{method}}{{/lambda.pascalcase}}{{testIndex}}() {
// >SEPARATOR {{method}} {{testName}}
// >SEPARATOR {{method}} {{{testName}}}
// Initialize the client
{{> snippets/init}}

Expand Down
2 changes: 1 addition & 1 deletion templates/php/model.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ use Algolia\AlgoliaSearch\Model\ModelInterface;
*
* @category Class
{{#description}}
* @description {{.}}
* @description {{{.}}}
{{/description}}
* @package {{invokerPackage}}
*/
Expand Down
2 changes: 1 addition & 1 deletion templates/php/snippets/method.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ class Snippet{{client}}
*/
public function snippetFor{{#lambda.titlecase}}{{method}}{{/lambda.titlecase}}{{testIndex}}(): void
{
// >SEPARATOR {{method}} {{testName}}
// >SEPARATOR {{method}} {{{testName}}}
// Initialize the client
{{> snippets/init}}

Expand Down
2 changes: 1 addition & 1 deletion templates/python/snippets/method.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ def snippet_for_{{#lambda.snakecase}}{{method}}{{/lambda.snakecase}}{{testIndex}

{{{description}}}
"""
# >SEPARATOR {{method}} {{testName}}
# >SEPARATOR {{method}} {{{testName}}}
# Initialize the client
# In an asynchronous context, you can use {{#lambda.pascalcase}}{{{client}}}{{/lambda.pascalcase}} instead, which exposes the exact same methods.
{{> snippets/init}}
Expand Down
10 changes: 5 additions & 5 deletions templates/ruby/api.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ module {{moduleName}}

{{#operation}}
{{#notes}}
# {{.}}
# {{{.}}}
{{/notes}}
{{#vendorExtensions}}
{{#x-acl.0}}
Expand All @@ -89,10 +89,10 @@ module {{moduleName}}
{{/vendorExtensions}}
{{#allParams}}
{{#required}}
# @param {{paramName}} [{{{dataType}}}] {{description}} (required)
# @param {{paramName}} [{{{dataType}}}] {{{description}}} (required)
{{/required}}
{{^required}}
# @param {{paramName}} [{{{dataType}}}] {{description}}{{#defaultValue}} (default to {{{.}}}){{/defaultValue}}
# @param {{paramName}} [{{{dataType}}}] {{{description}}}{{#defaultValue}} (default to {{{.}}}){{/defaultValue}}
{{/required}}
{{/allParams}}
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
Expand Down Expand Up @@ -153,10 +153,10 @@ module {{moduleName}}
{{/vendorExtensions}}
{{#allParams}}
{{#required}}
# @param {{paramName}} [{{{dataType}}}] {{description}} (required)
# @param {{paramName}} [{{{dataType}}}] {{{description}}} (required)
{{/required}}
{{^required}}
# @param {{paramName}} [{{{dataType}}}] {{description}}{{#defaultValue}} (default to {{{.}}}){{/defaultValue}}
# @param {{paramName}} [{{{dataType}}}] {{{description}}}{{#defaultValue}} (default to {{{.}}}){{/defaultValue}}
{{/required}}
{{/allParams}}
# @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
Expand Down
2 changes: 1 addition & 1 deletion templates/ruby/snippets/method.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
#
# {{{description}}}
def snippet_for_{{#lambda.snakecase}}{{method}}{{/lambda.snakecase}}{{testIndex}}
# >SEPARATOR {{method}} {{testName}}
# >SEPARATOR {{method}} {{{testName}}}
# Initialize the client
{{> snippets/init}}

Expand Down
2 changes: 1 addition & 1 deletion templates/scala/enum.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ object {{classname}} {
{{#allowableValues}}
{{#values}}
case object {{#fnEnumEntry}}{{.}}{{/fnEnumEntry}} extends {{classname}} {
override def toString = "{{.}}"
override def toString = "{{{.}}}"
}
{{/values}}
{{/allowableValues}}
Expand Down
2 changes: 1 addition & 1 deletion templates/scala/snippets/method.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ class Snippet{{client}} {
* {{{description}}}
*/
def snippetFor{{#lambda.pascalcase}}{{client}}{{/lambda.pascalcase}}{{#lambda.pascalcase}}{{method}}{{/lambda.pascalcase}}{{testIndex}}(): Unit = {
// >SEPARATOR {{method}} {{testName}}
// >SEPARATOR {{method}} {{{testName}}}
// Initialize the client
{{> snippets/init}}

Expand Down
2 changes: 1 addition & 1 deletion templates/swift/model.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import Foundation

{{#description}}

/** {{.}} */{{/description}}{{#isDeprecated}}
/** {{{.}}} */{{/description}}{{#isDeprecated}}
@available(*, deprecated, message: "This schema is deprecated."){{/isDeprecated}}{{#vendorExtensions.x-is-one-of-interface}}
{{> modelOneOf}}{{/vendorExtensions.x-is-one-of-interface}}{{^vendorExtensions.x-is-one-of-interface}}{{#isArray}}
{{> modelArray}}{{/isArray}}{{^isArray}}{{#isEnum}}
Expand Down
2 changes: 1 addition & 1 deletion templates/swift/snippets/method.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ final class {{client}}Snippet {
//
// {{{description}}}
func snippetFor{{#lambda.pascalcase}}{{method}}{{/lambda.pascalcase}}{{testIndex}}() async throws {
// >SEPARATOR {{method}} {{testName}}
// >SEPARATOR {{method}} {{{testName}}}
// Initialize the client
{{> snippets/init}}

Expand Down
Loading