Skip to content

Commit

Permalink
feat(go): comments are enhanced to provide better developer experience
Browse files Browse the repository at this point in the history
algolia/api-clients-automation#1536

Co-authored-by: Mehmet Ali Gok <33124154+mehmetaligok@users.noreply.github.com>
  • Loading branch information
algolia-bot and mehmetaligok committed May 16, 2023
1 parent 7f45a05 commit fdd2be3
Show file tree
Hide file tree
Showing 30 changed files with 577 additions and 8 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
## [4.0.0-alpha.9](https://github.com/algolia/algoliasearch-client-go/compare/4.0.0-alpha.8...4.0.0-alpha.9)

- [49b4c00c](https://github.com/algolia/api-clients-automation/commit/49b4c00c) feat(specs): add property to BigQuery source input ([#1547](https://github.com/algolia/api-clients-automation/pull/1547)) by [@Fluf22](https://github.com/Fluf22/)
- [fe7057d1](https://github.com/algolia/api-clients-automation/commit/fe7057d1) feat(go): parameter arguments for request creation improved with all … ([#1535](https://github.com/algolia/api-clients-automation/pull/1535)) by [@mehmetaligok](https://github.com/mehmetaligok/)
- [d2ad9cb9](https://github.com/algolia/api-clients-automation/commit/d2ad9cb9) feat(go): Add context support to all requests ([#1527](https://github.com/algolia/api-clients-automation/pull/1527)) by [@mehmetaligok](https://github.com/mehmetaligok/)

## [4.0.0-alpha.8](https://github.com/algolia/algoliasearch-client-go/compare/4.0.0-alpha.7...4.0.0-alpha.8)

- [57b59189](https://github.com/algolia/api-clients-automation/commit/57b59189) feat(go): release process for generated go client ([#1512](https://github.com/algolia/api-clients-automation/pull/1512)) by [@mehmetaligok](https://github.com/mehmetaligok/)
Expand Down
23 changes: 23 additions & 0 deletions algolia/analytics/.openapi-generator-ignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# OpenAPI Generator Ignore
# Generated by openapi-generator https://github.com/openapitools/openapi-generator

# Use this file to prevent files from being overwritten by the generator.
# The patterns follow closely to .gitignore or .dockerignore.

# As an example, the C# client generator defines ApiClient.cs.
# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
#ApiClient.cs

# You can match any string of characters against a directory, file or extension with a single asterisk (*):
#foo/*/qux
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux

# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
#foo/**/qux
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux

# You can also negate patterns with an exclamation (!).
# For example, you can ignore all files in a docs folder with the file extension .md:
#docs/*.md
# Then explicitly reverse the ignore rule for a single file:
#!docs/README.md
49 changes: 49 additions & 0 deletions algolia/analytics/.openapi-generator/FILES
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
.openapi-generator-ignore
api_analytics.go
client.go
configuration.go
model_average_click_event.go
model_click_position.go
model_click_through_rate_event.go
model_conversion_rate_event.go
model_direction.go
model_error_base.go
model_get_average_click_position_response.go
model_get_click_positions_response.go
model_get_click_through_rate_response.go
model_get_conversation_rate_response.go
model_get_no_click_rate_response.go
model_get_no_results_rate_response.go
model_get_searches_count_response.go
model_get_searches_no_clicks_response.go
model_get_searches_no_results_response.go
model_get_status_response.go
model_get_top_countries_response.go
model_get_top_filter_attribute.go
model_get_top_filter_attributes_response.go
model_get_top_filter_for_attribute.go
model_get_top_filter_for_attribute_response.go
model_get_top_filters_no_results_response.go
model_get_top_filters_no_results_value.go
model_get_top_filters_no_results_values.go
model_get_top_hits_response.go
model_get_top_searches_response.go
model_get_users_count_response.go
model_no_click_rate_event.go
model_no_results_rate_event.go
model_order_by.go
model_search_event.go
model_search_no_click_event.go
model_search_no_result_event.go
model_top_country.go
model_top_hit.go
model_top_hit_with_analytics.go
model_top_hits_response.go
model_top_hits_response_with_analytics.go
model_top_search.go
model_top_search_with_analytics.go
model_top_searches_response.go
model_top_searches_response_with_analytics.go
model_user_with_date.go
response.go
utils.go
1 change: 1 addition & 0 deletions algolia/analytics/.openapi-generator/VERSION
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
6.5.0
2 changes: 1 addition & 1 deletion algolia/analytics/client.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion algolia/ingestion/client.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

23 changes: 23 additions & 0 deletions algolia/insights/.openapi-generator-ignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# OpenAPI Generator Ignore
# Generated by openapi-generator https://github.com/openapitools/openapi-generator

# Use this file to prevent files from being overwritten by the generator.
# The patterns follow closely to .gitignore or .dockerignore.

# As an example, the C# client generator defines ApiClient.cs.
# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
#ApiClient.cs

# You can match any string of characters against a directory, file or extension with a single asterisk (*):
#foo/*/qux
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux

# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
#foo/**/qux
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux

# You can also negate patterns with an exclamation (!).
# For example, you can ignore all files in a docs folder with the file extension .md:
#docs/*.md
# Then explicitly reverse the ignore rule for a single file:
#!docs/README.md
11 changes: 11 additions & 0 deletions algolia/insights/.openapi-generator/FILES
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
.openapi-generator-ignore
api_insights.go
client.go
configuration.go
model_error_base.go
model_event_type.go
model_insight_event.go
model_insight_events.go
model_push_events_response.go
response.go
utils.go
1 change: 1 addition & 0 deletions algolia/insights/.openapi-generator/VERSION
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
6.5.0
2 changes: 1 addition & 1 deletion algolia/insights/client.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

23 changes: 23 additions & 0 deletions algolia/personalization/.openapi-generator-ignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# OpenAPI Generator Ignore
# Generated by openapi-generator https://github.com/openapitools/openapi-generator

# Use this file to prevent files from being overwritten by the generator.
# The patterns follow closely to .gitignore or .dockerignore.

# As an example, the C# client generator defines ApiClient.cs.
# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
#ApiClient.cs

# You can match any string of characters against a directory, file or extension with a single asterisk (*):
#foo/*/qux
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux

# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
#foo/**/qux
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux

# You can also negate patterns with an exclamation (!).
# For example, you can ignore all files in a docs folder with the file extension .md:
#docs/*.md
# Then explicitly reverse the ignore rule for a single file:
#!docs/README.md
13 changes: 13 additions & 0 deletions algolia/personalization/.openapi-generator/FILES
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
.openapi-generator-ignore
api_personalization.go
client.go
configuration.go
model_delete_user_profile_response.go
model_error_base.go
model_event_scoring.go
model_facet_scoring.go
model_get_user_token_response.go
model_personalization_strategy_params.go
model_set_personalization_strategy_response.go
response.go
utils.go
1 change: 1 addition & 0 deletions algolia/personalization/.openapi-generator/VERSION
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
6.5.0
2 changes: 1 addition & 1 deletion algolia/personalization/client.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

23 changes: 23 additions & 0 deletions algolia/predict/.openapi-generator-ignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# OpenAPI Generator Ignore
# Generated by openapi-generator https://github.com/openapitools/openapi-generator

# Use this file to prevent files from being overwritten by the generator.
# The patterns follow closely to .gitignore or .dockerignore.

# As an example, the C# client generator defines ApiClient.cs.
# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
#ApiClient.cs

# You can match any string of characters against a directory, file or extension with a single asterisk (*):
#foo/*/qux
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux

# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
#foo/**/qux
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux

# You can also negate patterns with an exclamation (!).
# For example, you can ignore all files in a docs folder with the file extension .md:
#docs/*.md
# Then explicitly reverse the ignore rule for a single file:
#!docs/README.md
77 changes: 77 additions & 0 deletions algolia/predict/.openapi-generator/FILES
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
.openapi-generator-ignore
api_predict.go
client.go
configuration.go
model_activate_model_instance_response.go
model_activate_model_params.go
model_affinity.go
model_all_params.go
model_all_update_segment_params.go
model_compatible_sources.go
model_create_segment_params.go
model_create_segment_response.go
model_delete_model_instance_response.go
model_delete_segment_response.go
model_delete_user_profile_response.go
model_error.go
model_error_base.go
model_fetch_all_user_profiles_params.go
model_fetch_all_user_profiles_response.go
model_funnel_stage.go
model_get_available_model_types_response_inner.go
model_get_available_model_types_response_inner_data_requirements.go
model_get_model_instance_config_status.go
model_get_model_metrics_response.go
model_get_segment_users_response.go
model_limit_param.go
model_model_attributes.go
model_model_instance.go
model_model_metrics.go
model_model_status.go
model_models_to_retrieve.go
model_models_to_retrieve_param.go
model_next_page_token_param.go
model_params.go
model_prediction_affinity_value.go
model_predictions.go
model_predictions_affinities.go
model_predictions_affinities_success.go
model_predictions_funnel_stage.go
model_predictions_funnel_stage_success.go
model_predictions_order_value.go
model_predictions_order_value_success.go
model_previous_page_token_param.go
model_properties.go
model_segment.go
model_segment_affinity_filter.go
model_segment_affinity_filter_value.go
model_segment_child_condition_operands.go
model_segment_child_conditions.go
model_segment_condition_operator.go
model_segment_conditions_param.go
model_segment_filter_operator_boolean.go
model_segment_filter_operator_numerical.go
model_segment_filter_probability.go
model_segment_funnel_stage_filter.go
model_segment_name_param.go
model_segment_operand_affinity.go
model_segment_operand_funnel_stage.go
model_segment_operand_order_value.go
model_segment_operand_property.go
model_segment_order_value_filter.go
model_segment_parent_condition_operands.go
model_segment_parent_conditions.go
model_segment_property_filter.go
model_segment_property_filter_value.go
model_segment_status.go
model_segment_type.go
model_segments.go
model_types_to_retrieve.go
model_types_to_retrieve_param.go
model_update_model_instance_response.go
model_update_model_params.go
model_update_segment_params.go
model_update_segment_response.go
model_user_profile.go
response.go
utils.go
1 change: 1 addition & 0 deletions algolia/predict/.openapi-generator/VERSION
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
6.5.0
2 changes: 1 addition & 1 deletion algolia/predict/client.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

23 changes: 23 additions & 0 deletions algolia/query-suggestions/.openapi-generator-ignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# OpenAPI Generator Ignore
# Generated by openapi-generator https://github.com/openapitools/openapi-generator

# Use this file to prevent files from being overwritten by the generator.
# The patterns follow closely to .gitignore or .dockerignore.

# As an example, the C# client generator defines ApiClient.cs.
# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
#ApiClient.cs

# You can match any string of characters against a directory, file or extension with a single asterisk (*):
#foo/*/qux
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux

# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
#foo/**/qux
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux

# You can also negate patterns with an exclamation (!).
# For example, you can ignore all files in a docs folder with the file extension .md:
#docs/*.md
# Then explicitly reverse the ignore rule for a single file:
#!docs/README.md
18 changes: 18 additions & 0 deletions algolia/query-suggestions/.openapi-generator/FILES
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
.openapi-generator-ignore
api_query_suggestions.go
client.go
configuration.go
model_error_base.go
model_index_name.go
model_log_file.go
model_log_level.go
model_query_suggestions_index.go
model_query_suggestions_index_param.go
model_query_suggestions_index_with_index_param.go
model_source_index.go
model_source_index_external.go
model_source_index_with_replicas.go
model_status.go
model_success_response.go
response.go
utils.go
1 change: 1 addition & 0 deletions algolia/query-suggestions/.openapi-generator/VERSION
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
6.5.0
2 changes: 1 addition & 1 deletion algolia/query-suggestions/client.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

23 changes: 23 additions & 0 deletions algolia/recommend/.openapi-generator-ignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# OpenAPI Generator Ignore
# Generated by openapi-generator https://github.com/openapitools/openapi-generator

# Use this file to prevent files from being overwritten by the generator.
# The patterns follow closely to .gitignore or .dockerignore.

# As an example, the C# client generator defines ApiClient.cs.
# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
#ApiClient.cs

# You can match any string of characters against a directory, file or extension with a single asterisk (*):
#foo/*/qux
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux

# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
#foo/**/qux
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux

# You can also negate patterns with an exclamation (!).
# For example, you can ignore all files in a docs folder with the file extension .md:
#docs/*.md
# Then explicitly reverse the ignore rule for a single file:
#!docs/README.md
Loading

0 comments on commit fdd2be3

Please sign in to comment.