Skip to content

[DOCS] Autogenerated code + improvements in source code documentation. #84

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

Merged
merged 3 commits into from
Jun 24, 2024

Conversation

picandocodigo
Copy link
Member

  • Extends API source code docs based on specification.
  • Updates generated source doc for correct YARD formatting
  • Updates README, client docs, yard in gitignore

API changes

  • create - Adds [Integer, String] parameter :wait_for_active_shards: The number of shard copies that must be active before proceeding with the operation. Set to +all+ or any positive integer up to the total number of shards in the index (+number_of_replicas+1+). Server default: 1.
  • field_caps - Adds boolean parameter :include_empty_fields: If false, empty fields are not included in the response. Server default: true.
  • get, mget, search - Add boolean parameter :force_synthetic_source: Should this request force synthetic _source? Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance. Fetches with this enabled will be slower the enabling synthetic source natively in the index.
  • ml.get_trained_models - Adds [String, Array] parameter :model_id: The unique identifier of the trained model or a model alias. You can get information for multiple trained models in a single API request by using a comma-separated list of model IDs or a wildcard expression.
  • ml.put_calendar_job Adds [String, Array] parameter :job_id: An identifier for the anomaly detection jobs. It can be a job identifier, a group name, or a comma-separated list of jobs or groups. (Required)
  • ml.put_trained_model - Adds boolean parameter :wait_for_completion: Whether to wait for all child operations (e.g. model download) to complete.
  • search_application.search - Adds boolean parameter :typed_keys: Determines whether aggregation names are prefixed by their respective types in the response.
  • security.get_api_key - Adds boolean parameter :active_only A boolean flag that can be used to query API keys that are currently active. An API key is considered active if it is neither invalidated, nor expired at query time. You can specify this together with other parameters such as owner or name. If active_only is false, the response will include both active and inactive (expired or invalidated) keys. Adds boolean parameter :with_profile_uid: Determines whether to also retrieve the profile uid, for the API key owner principal, if it exists.
  • security.query_api_keys - Adds boolean parameter :with_profile_uid: Determines whether to also retrieve the profile uid, for the API key owner principal, if it exists. Adds boolean parameter :typed_keys: Determines whether aggregation names are prefixed by their respective types in the response.

Extends API source code docs based on specification

API changes:

* `create` -  Adds [Integer, String] parameter `:wait_for_active_shards`: The number of shard copies that must be active before proceeding with the operation. Set to +all+ or any positive integer up to the total number of shards in the index (+number_of_replicas+1+). Server default: 1.
* `field_caps` - Adds boolean parameter `:include_empty_fields`: If false, empty fields are not included in the response. Server default: true.
* `get`, `mget`, `search` - Add boolean parameter `:force_synthetic_source`: Should this request force synthetic _source? Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance. Fetches with this enabled will be slower the enabling synthetic source natively in the index.
* `ml.get_trained_models` - Adds [String, Array] parameter `:model_id`: The unique identifier of the trained model or a model alias.  You can get information for multiple trained models in a single API request by using a comma-separated list of model IDs or a wildcard expression.
* `ml.put_calendar_job` Adds [String, Array] parameter `:job_id`: An identifier for the anomaly detection jobs. It can be a job identifier, a group name, or a comma-separated list of jobs or groups. (*Required*)
* `ml.put_trained_model` - Adds boolean parameter `:wait_for_completion`: Whether to wait for all child operations (e.g. model download) to complete.
* `search_application.search` - Adds boolean parameter `:typed_keys`: Determines whether aggregation names are prefixed by their respective types in the response.
* `security.get_api_key` - Adds boolean parameter `:active_only` A boolean flag that can be used to query API keys that are currently active. An API key is considered active if it is neither invalidated, nor expired at query time. You can specify this together with other parameters such as `owner` or `name`. If `active_only` is false, the response will include both active and inactive (expired or invalidated) keys. Adds boolean parameter `:with_profile_uid`: Determines whether to also retrieve the profile uid, for the API key owner principal, if it exists.
* `security.query_api_keys` - Adds boolean parameter `:with_profile_uid`: Determines whether to also retrieve the profile uid, for the API key owner principal, if it exists. Adds boolean parameter `:typed_keys`: Determines whether aggregation names are prefixed by their respective types in the response.
@picandocodigo picandocodigo merged commit 1090aa7 into main Jun 24, 2024
6 checks passed
@picandocodigo picandocodigo deleted the updates branch June 24, 2024 17:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant