Skip to content

Commit

Permalink
[API] Updates source code docs
Browse files Browse the repository at this point in the history
  • Loading branch information
picandocodigo committed Oct 3, 2024
1 parent 3ee4d60 commit 23723df
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ module Actions
#
# @option arguments [List] :name A comma-separated list of names or wildcard expressions
# @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all)
# @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
# @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.15/indices-resolve-index-api.html
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ module Actions
# @option arguments [List] :id A comma-separated list of geoip database configurations to delete
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.15/TODO.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.15/delete-geoip-database-api.html
#
def delete_geoip_database(arguments = {})
request_opts = { endpoint: arguments[:endpoint] || 'ingest.delete_geoip_database' }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ module Actions
# @option arguments [List] :id A comma-separated list of geoip database configurations to get; use `*` to get all geoip database configurations
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.15/TODO.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.15/get-geoip-database-api.html
#
def get_geoip_database(arguments = {})
request_opts = { endpoint: arguments[:endpoint] || 'ingest.get_geoip_database' }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ module Actions
# @option arguments [Hash] :headers Custom HTTP headers
# @option arguments [Hash] :body The database configuration definition (*Required*)
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.15/TODO.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.15/put-geoip-database-api.html
#
def put_geoip_database(arguments = {})
request_opts = { endpoint: arguments[:endpoint] || 'ingest.put_geoip_database' }
Expand Down

0 comments on commit 23723df

Please sign in to comment.