in src/core/public/doc_links/doc_links_service.ts [43:545]
public start({ injectedMetadata }: StartDeps): DocLinksStart {
const DOC_LINK_VERSION =
injectedMetadata.getOpenSearchDashboardsBranch() === 'main'
? 'latest'
: injectedMetadata.getOpenSearchDashboardsBranch();
const OPENSEARCH_WEBSITE_URL = 'https://opensearch.org/';
const OPENSEARCH_WEBSITE_DOCS = `${OPENSEARCH_WEBSITE_URL}docs/${DOC_LINK_VERSION}`;
const OPENSEARCH_VERSIONED_DOCS = `${OPENSEARCH_WEBSITE_DOCS}/opensearch/`;
const OPENSEARCH_DASHBOARDS_VERSIONED_DOCS = `${OPENSEARCH_WEBSITE_DOCS}/dashboards/`;
return deepFreeze({
DOC_LINK_VERSION,
OPENSEARCH_WEBSITE_URL,
links: {
opensearch: {
// https://opensearch.org/docs/latest/opensearch/index/
introduction: `${OPENSEARCH_VERSIONED_DOCS}index/`,
installation: {
// https://opensearch.org/docs/latest/opensearch/install/index/
base: `${OPENSEARCH_VERSIONED_DOCS}install/index/`,
// https://opensearch.org/docs/latest/opensearch/install/compatibility/
compatibility: `${OPENSEARCH_VERSIONED_DOCS}install/compatibility/`,
// https://opensearch.org/docs/latest/opensearch/install/docker/
docker: `${OPENSEARCH_VERSIONED_DOCS}install/docker`,
// https://opensearch.org/docs/latest/opensearch/install/docker-security/
dockerSecurity: `${OPENSEARCH_VERSIONED_DOCS}install/docker-security`,
// https://opensearch.org/docs/latest/opensearch/install/helm/
helm: `${OPENSEARCH_VERSIONED_DOCS}install/helm/`,
// https://opensearch.org/docs/latest/opensearch/install/tar/
tar: `${OPENSEARCH_VERSIONED_DOCS}install/tar/`,
// https://opensearch.org/docs/latest/opensearch/install/ansible/
ansible: `${OPENSEARCH_VERSIONED_DOCS}install/ansible/`,
// https://opensearch.org/docs/latest/opensearch/install/important-settings/
settings: `${OPENSEARCH_VERSIONED_DOCS}install/important-settings/`,
// https://opensearch.org/docs/latest/opensearch/install/plugins/
plugins: `${OPENSEARCH_VERSIONED_DOCS}install/plugins/`,
},
// https://opensearch.org/docs/latest/opensearch/configuration/
configuration: `${OPENSEARCH_VERSIONED_DOCS}configuration/`,
cluster: {
// https://opensearch.org/docs/latest/opensearch/cluster/
base: `${OPENSEARCH_VERSIONED_DOCS}cluster/`,
// https://opensearch.org/docs/latest/opensearch/cluster/#step-1-name-a-cluster
naming: `${OPENSEARCH_VERSIONED_DOCS}cluster/#step-1-name-a-cluster`,
// https://opensearch.org/docs/latest/opensearch/cluster/#step-2-set-node-attributes-for-each-node-in-a-cluster
set_attribute: `${OPENSEARCH_VERSIONED_DOCS}cluster/#step-2-set-node-attributes-for-each-node-in-a-cluster`,
// https://opensearch.org/docs/latest/opensearch/cluster/#step-3-bind-a-cluster-to-specific-ip-addresses
build_cluster: `${OPENSEARCH_VERSIONED_DOCS}cluster/#step-3-bind-a-cluster-to-specific-ip-addresses`,
// https://opensearch.org/docs/latest/opensearch/cluster/#step-4-configure-discovery-hosts-for-a-cluster
config_host: `${OPENSEARCH_VERSIONED_DOCS}cluster/cluster/#step-4-configure-discovery-hosts-for-a-cluster`,
// https://opensearch.org/docs/latest/opensearch/cluster/#step-5-start-the-cluster
start: `${OPENSEARCH_VERSIONED_DOCS}cluster/#step-5-start-the-cluster`,
// https://opensearch.org/docs/latest/opensearch/cluster/#advanced-step-6-configure-shard-allocation-awareness-or-forced-awareness
config_shard: `${OPENSEARCH_VERSIONED_DOCS}cluster/#advanced-step-6-configure-shard-allocation-awareness-or-forced-awareness`,
// https://opensearch.org/docs/latest/opensearch/cluster/#advanced-step-7-set-up-a-hot-warm-architecture
setup_hot_arch: `${OPENSEARCH_VERSIONED_DOCS}cluster/#advanced-step-7-set-up-a-hot-warm-architecture`,
},
indexData: {
// https://opensearch.org/docs/latest/opensearch/index-data/
base: `${OPENSEARCH_VERSIONED_DOCS}index-data/`,
// https://opensearch.org/docs/latest/opensearch/index-data/#naming-restrictions-for-indices
naming: `${OPENSEARCH_VERSIONED_DOCS}index-data/#naming-restrictions-for-indices`,
// https://opensearch.org/docs/latest/opensearch/index-data/#read-data
read_data: `${OPENSEARCH_VERSIONED_DOCS}index-data/#read-data`,
// https://opensearch.org/docs/latest/opensearch/index-data/#update-data
update_data: `${OPENSEARCH_VERSIONED_DOCS}index-data/#update-data`,
// https://opensearch.org/docs/latest/opensearch/index-data/#delete-data
delete_data: `${OPENSEARCH_VERSIONED_DOCS}index-data/#delete-data`,
},
indexAlias: {
// https://opensearch.org/docs/latest/opensearch/index-alias/
base: `${OPENSEARCH_VERSIONED_DOCS}index-alias/`,
// https://opensearch.org/docs/latest/opensearch/index-alias/#create-aliases
create_alias: `${OPENSEARCH_VERSIONED_DOCS}index-alias/#create-aliases`,
// https://opensearch.org/docs/latest/opensearch/index-alias/#add-or-remove-indices
add_remove_index: `${OPENSEARCH_VERSIONED_DOCS}index-alias/#add-or-remove-indices`,
// https://opensearch.org/docs/latest/opensearch/index-alias/#manage-aliases
manage_alias: `${OPENSEARCH_VERSIONED_DOCS}index-alias/#manage-aliases`,
// https://opensearch.org/docs/latest/opensearch/index-alias/#create-filtered-aliases
filtered_alias: `${OPENSEARCH_VERSIONED_DOCS}index-alias/#create-filtered-aliases`,
// https://opensearch.org/docs/latest/opensearch/index-alias/#index-alias-options
alias_option: `${OPENSEARCH_VERSIONED_DOCS}index-alias/#index-alias-options`,
},
// https://opensearch.org/docs/latest/opensearch/data-streams/
dataStreams: `${OPENSEARCH_VERSIONED_DOCS}data-streams/`,
// https://opensearch.org/docs/latest/opensearch/aggregations/
aggregations: {
// https://opensearch.org/docs/latest/opensearch/aggregations/
base: `${OPENSEARCH_VERSIONED_DOCS}aggregations/`,
metric: {
// https://opensearch.org/docs/latest/opensearch/metric-agg/
base: `${OPENSEARCH_VERSIONED_DOCS}metric-agg/`,
// https://opensearch.org/docs/latest/opensearch/metric-agg/#types-of-metric-aggregations
types: `${OPENSEARCH_VERSIONED_DOCS}metric-agg/#types-of-metric-aggregations`,
// https://opensearch.org/docs/latest/opensearch/metric-agg/#sum-min-max-avg
sum: `${OPENSEARCH_VERSIONED_DOCS}metric-agg/#sum-min-max-avg`,
// https://opensearch.org/docs/latest/opensearch/metric-agg/#cardinality
cardinality: `${OPENSEARCH_VERSIONED_DOCS}metric-agg/#cardinality`,
// https://opensearch.org/docs/latest/opensearch/metric-agg/#value_count
value_count: `${OPENSEARCH_VERSIONED_DOCS}metric-agg/#value_count`,
// https://opensearch.org/docs/latest/opensearch/metric-agg/#stats-extended_stats-matrix_stats
stats: `${OPENSEARCH_VERSIONED_DOCS}metric-agg/#stats-extended_stats-matrix_stats`,
// https://opensearch.org/docs/latest/opensearch/metric-agg/#percentile-percentile_ranks
percentile: `${OPENSEARCH_VERSIONED_DOCS}metric-agg/#percentile-percentile_ranks`,
// https://opensearch.org/docs/latest/opensearch/metric-agg/#geo_bound
geo_bound: `${OPENSEARCH_VERSIONED_DOCS}metric-agg/#geo_bound`,
// https://opensearch.org/docs/latest/opensearch/metric-agg/#top_hits
top_hits: `${OPENSEARCH_VERSIONED_DOCS}metric-agg/#top_hits`,
// https://opensearch.org/docs/latest/opensearch/metric-agg/#scripted_metric
scripted_metric: `${OPENSEARCH_VERSIONED_DOCS}metric-agg/#scripted_metric`,
},
bucket: {
// https://opensearch.org/docs/latest/opensearch/bucket-agg/
base: `${OPENSEARCH_VERSIONED_DOCS}bucket-agg/`,
// https://opensearch.org/docs/latest/opensearch/bucket-agg/#terms
terms: `${OPENSEARCH_VERSIONED_DOCS}bucket-agg/#terms`,
// https://opensearch.org/docs/latest/opensearch/bucket-agg/#sampler-diversified_sampler
smapler: `${OPENSEARCH_VERSIONED_DOCS}bucket-agg/#sampler-diversified_sampler`,
// https://opensearch.org/docs/latest/opensearch/bucket-agg/#significant_terms-significant_text
significant_terms: `${OPENSEARCH_VERSIONED_DOCS}bucket-agg/#significant_terms-significant_text`,
// https://opensearch.org/docs/latest/opensearch/bucket-agg/#missing
missing: `${OPENSEARCH_VERSIONED_DOCS}bucket-agg/#missing`,
// https://opensearch.org/docs/latest/opensearch/bucket-agg/#histogram-date_histogram
histogram: `${OPENSEARCH_VERSIONED_DOCS}bucket-agg/#histogram-date_histogram`,
// https://opensearch.org/docs/latest/opensearch/bucket-agg/#range-date_range-ip_range
range: `${OPENSEARCH_VERSIONED_DOCS}bucket-agg/#range-date_range-ip_range`,
// https://opensearch.org/docs/latest/opensearch/bucket-agg/#filter-filters
filter: `${OPENSEARCH_VERSIONED_DOCS}bucket-agg/#filter-filters`,
// https://opensearch.org/docs/latest/opensearch/bucket-agg/#global
global: `${OPENSEARCH_VERSIONED_DOCS}bucket-agg/#global`,
// https://opensearch.org/docs/latest/opensearch/bucket-agg/#geo_distance-geohash_grid
geo: `${OPENSEARCH_VERSIONED_DOCS}bucket-agg/#geo_distance-geohash_grid`,
// https://opensearch.org/docs/latest/opensearch/bucket-agg/#adjacency_matrix
adjacency_matrix: `${OPENSEARCH_VERSIONED_DOCS}bucket-agg/#adjacency_matrix`,
// https://opensearch.org/docs/latest/opensearch/bucket-agg/#nested-reverse_nested
nested: `${OPENSEARCH_VERSIONED_DOCS}bucket-agg/#nested-reverse_nested`,
},
pipeline: {
// https://opensearch.org/docs/latest/opensearch/pipeline-agg/
base: `${OPENSEARCH_VERSIONED_DOCS}pipeline-agg/`,
// https://opensearch.org/docs/latest/opensearch/pipeline-agg/#pipeline-aggregation-syntax
syntax: `${OPENSEARCH_VERSIONED_DOCS}pipeline-agg/#pipeline-aggregation-syntax`,
// https://opensearch.org/docs/latest/opensearch/pipeline-agg/#types-of-pipeline-aggregations
types: `${OPENSEARCH_VERSIONED_DOCS}pipeline-agg/#types-of-pipeline-aggregations`,
// https://opensearch.org/docs/latest/opensearch/pipeline-agg/#avg_bucket-sum_bucket-min_bucket-max_bucket
avg_bucket: `${OPENSEARCH_VERSIONED_DOCS}pipeline-agg/#avg_bucket-sum_bucket-min_bucket-max_bucket`,
// https://opensearch.org/docs/latest/opensearch/pipeline-agg/#stats_bucket-extended_stats_bucket
stats_bucket: `${OPENSEARCH_VERSIONED_DOCS}pipeline-agg/#stats_bucket-extended_stats_bucket`,
// https://opensearch.org/docs/latest/opensearch/pipeline-agg/#bucket_script-bucket_selector
bucket_script: `${OPENSEARCH_VERSIONED_DOCS}pipeline-agg/#bucket_script-bucket_selector`,
// https://opensearch.org/docs/latest/opensearch/pipeline-agg/#bucket_sort
bucket_sort: `${OPENSEARCH_VERSIONED_DOCS}pipeline-agg/#bucket_sort`,
// https://opensearch.org/docs/latest/opensearch/pipeline-agg/#cumulative_sum
cumulative_sum: `${OPENSEARCH_VERSIONED_DOCS}pipeline-agg/#cumulative_sum`,
// https://opensearch.org/docs/latest/opensearch/pipeline-agg/#derivative
derivative: `${OPENSEARCH_VERSIONED_DOCS}pipeline-agg/#derivative`,
// https://opensearch.org/docs/latest/opensearch/pipeline-agg/#moving_avg
moving_avg: `${OPENSEARCH_VERSIONED_DOCS}pipeline-agg/#moving_avg`,
// https://opensearch.org/docs/latest/opensearch/pipeline-agg/#serial_diff
serial_diff: `${OPENSEARCH_VERSIONED_DOCS}pipeline-agg/#serial_diff`,
},
},
indexTemplates: {
// https://opensearch.org/docs/latest/opensearch/index-templates/
base: `${OPENSEARCH_VERSIONED_DOCS}index-templates`,
// https://opensearch.org/docs/latest/opensearch/index-templates/#composable-index-templates
composable: `${OPENSEARCH_VERSIONED_DOCS}index-templates/#composable-index-templates`,
// https://opensearch.org/docs/latest/opensearch/index-templates/#index-template-options
options: `${OPENSEARCH_VERSIONED_DOCS}index-templates/#index-template-options`,
},
reindexData: {
// https://opensearch.org/docs/latest/opensearch/reindex-data/
base: `${OPENSEARCH_VERSIONED_DOCS}reindex-data/`,
// https://opensearch.org/docs/latest/opensearch/reindex-data/#reindex-all-documents
all: `${OPENSEARCH_VERSIONED_DOCS}reindex-data/#reindex-all-documents`,
// https://opensearch.org/docs/latest/opensearch/reindex-data/#reindex-from-a-remote-cluster
remote: `${OPENSEARCH_VERSIONED_DOCS}reindex-data/#reindex-from-a-remote-cluster`,
// https://opensearch.org/docs/latest/opensearch/reindex-data/#reindex-a-subset-of-documents
subset: `${OPENSEARCH_VERSIONED_DOCS}reindex-data/#reindex-a-subset-of-documents`,
// https://opensearch.org/docs/latest/opensearch/reindex-data/#combine-one-or-more-indices
combine: `${OPENSEARCH_VERSIONED_DOCS}reindex-data/#combine-one-or-more-indices`,
// https://opensearch.org/docs/latest/opensearch/reindex-data/#reindex-only-unique-documents
unique: `${OPENSEARCH_VERSIONED_DOCS}reindex-data/#reindex-only-unique-documents`,
// https://opensearch.org/docs/latest/opensearch/reindex-data/#transform-documents-during-reindexing
transform: `${OPENSEARCH_VERSIONED_DOCS}reindex-data/#transform-documents-during-reindexing`,
// https://opensearch.org/docs/latest/opensearch/reindex-data/#update-documents-in-the-current-index
update: `${OPENSEARCH_VERSIONED_DOCS}reindex-data/#update-documents-in-the-current-index`,
// https://opensearch.org/docs/latest/opensearch/reindex-data/#source-index-options
source: `${OPENSEARCH_VERSIONED_DOCS}reindex-data/#source-index-options`,
// https://opensearch.org/docs/latest/opensearch/reindex-data/#destination-index-options
destination: `${OPENSEARCH_VERSIONED_DOCS}reindex-data/#destination-index-options`,
},
queryDSL: {
// https://opensearch.org/docs/latest/opensearch/query-dsl/index/
base: `${OPENSEARCH_VERSIONED_DOCS}query-dsl/index/`,
term: {
// https://opensearch.org/docs/latest/opensearch/query-dsl/term/
base: `${OPENSEARCH_VERSIONED_DOCS}query-dsl/term/`,
// https://opensearch.org/docs/latest/opensearch/query-dsl/term/#terms
terms: `${OPENSEARCH_VERSIONED_DOCS}query-dsl/term/#terms`,
// https://opensearch.org/docs/latest/opensearch/query-dsl/term/#ids
ids: `${OPENSEARCH_VERSIONED_DOCS}query-dsl/term/#ids`,
// https://opensearch.org/docs/latest/opensearch/query-dsl/term/#range
range: `${OPENSEARCH_VERSIONED_DOCS}query-dsl/term/#range`,
// https://opensearch.org/docs/latest/opensearch/query-dsl/term/#prefix
prefix: `${OPENSEARCH_VERSIONED_DOCS}query-dsl/term/#prefix`,
// https://opensearch.org/docs/latest/opensearch/query-dsl/term/#exists
exists: `${OPENSEARCH_VERSIONED_DOCS}query-dsl/term/#exists`,
// https://opensearch.org/docs/latest/opensearch/query-dsl/term/#wildcards
wildcards: `${OPENSEARCH_VERSIONED_DOCS}query-dsl/term/#wildcards`,
// https://opensearch.org/docs/latest/opensearch/query-dsl/term/#regex
regex: `${OPENSEARCH_VERSIONED_DOCS}query-dsl/term/#regex`,
},
fullText: {
// https://opensearch.org/docs/latest/opensearch/query-dsl/full-text/
base: `${OPENSEARCH_VERSIONED_DOCS}query-dsl/full-text/`,
// https://opensearch.org/docs/latest/opensearch/query-dsl/full-text/#match
match: `${OPENSEARCH_VERSIONED_DOCS}query-dsl/full-text/#match`,
// https://opensearch.org/docs/latest/opensearch/query-dsl/full-text/#multi-match
multi_match: `${OPENSEARCH_VERSIONED_DOCS}query-dsl/full-text/#multi-match`,
// https://opensearch.org/docs/latest/opensearch/query-dsl/full-text/#match-phrase
match_phrase: `${OPENSEARCH_VERSIONED_DOCS}query-dsl/full-text/#match-phrase`,
// https://opensearch.org/docs/latest/opensearch/query-dsl/full-text/#common-terms
common_terms: `${OPENSEARCH_VERSIONED_DOCS}query-dsl/full-text/#common-terms`,
// https://opensearch.org/docs/latest/opensearch/query-dsl/full-text/#query-string
query_string: `${OPENSEARCH_VERSIONED_DOCS}query-dsl/full-text/#query-string`,
// https://opensearch.org/docs/latest/opensearch/query-dsl/full-text/#options
options: `${OPENSEARCH_VERSIONED_DOCS}query-dsl/full-text/#options`,
},
// https://opensearch.org/docs/latest/opensearch/query-dsl/bool/
boolQuery: `${OPENSEARCH_VERSIONED_DOCS}query-dsl/bool/`,
},
searchTemplate: {
// https://opensearch.org/docs/latest/opensearch/search-template/
base: `${OPENSEARCH_VERSIONED_DOCS}search-template`,
// https://opensearch.org/docs/latest/opensearch/search-template/#create-search-templates
create: `${OPENSEARCH_VERSIONED_DOCS}search-template/#create-search-templates`,
// https://opensearch.org/docs/latest/opensearch/search-template/#save-and-execute-search-templates
execute: `${OPENSEARCH_VERSIONED_DOCS}search-template/#save-and-execute-search-templates`,
// https://opensearch.org/docs/latest/opensearch/search-template/#advanced-parameter-conversion-with-search-templates
advanced_operation: `${OPENSEARCH_VERSIONED_DOCS}search-template/#advanced-parameter-conversion-with-search-templates`,
// https://opensearch.org/docs/latest/opensearch/search-template/#multiple-search-templates
multiple_search: `${OPENSEARCH_VERSIONED_DOCS}search-template/#multiple-search-templates`,
// https://opensearch.org/docs/latest/opensearch/search-template/#manage-search-templates
manage: `${OPENSEARCH_VERSIONED_DOCS}search-template/#manage-search-templates`,
},
searchExperience: {
// https://opensearch.org/docs/latest/opensearch/ux/
base: `${OPENSEARCH_VERSIONED_DOCS}ux`,
// https://opensearch.org/docs/latest/opensearch/ux/#autocomplete-queries
autocomplete: `${OPENSEARCH_VERSIONED_DOCS}ux/#autocomplete-queries`,
// https://opensearch.org/docs/latest/opensearch/ux/#paginate-results
paginate: `${OPENSEARCH_VERSIONED_DOCS}ux/#paginate-results`,
// https://opensearch.org/docs/latest/opensearch/ux/#scroll-search
scroll: `${OPENSEARCH_VERSIONED_DOCS}ux/#scroll-search`,
// https://opensearch.org/docs/latest/opensearch/ux/#sort-results
sort: `${OPENSEARCH_VERSIONED_DOCS}ux/#sort-results`,
// https://opensearch.org/docs/latest/opensearch/ux/#highlight-query-matches
highlight_match: `${OPENSEARCH_VERSIONED_DOCS}ux/#highlight-query-matches`,
},
logs: {
// https://opensearch.org/docs/latest/opensearch/logs/
base: `${OPENSEARCH_VERSIONED_DOCS}logs`,
// https://opensearch.org/docs/latest/opensearch/logs/#application-logs
application_log: `${OPENSEARCH_VERSIONED_DOCS}logs/#application-logs`,
// https://opensearch.org/docs/latest/opensearch/logs/#slow-logs
slow_log: `${OPENSEARCH_VERSIONED_DOCS}logs/#slow-logs`,
// https://opensearch.org/docs/latest/opensearch/logs/#deprecation-logs
deprecation_log: `${OPENSEARCH_VERSIONED_DOCS}logs/#deprecation-logs`,
},
snapshotRestore: {
// https://opensearch.org/docs/latest/opensearch/snapshot-restore/
base: `${OPENSEARCH_VERSIONED_DOCS}snapshot-restore`,
// https://opensearch.org/docs/latest/opensearch/snapshot-restore/#register-repository
register: `${OPENSEARCH_VERSIONED_DOCS}snapshot-restore/#register-repository`,
// https://opensearch.org/docs/latest/opensearch/snapshot-restore/#take-snapshots
take_snapshot: `${OPENSEARCH_VERSIONED_DOCS}snapshot-restore/#take-snapshots`,
// https://opensearch.org/docs/latest/opensearch/snapshot-restore/#restore-snapshots
restore_snapshot: `${OPENSEARCH_VERSIONED_DOCS}snapshot-restore/#restore-snapshots`,
// https://opensearch.org/docs/latest/opensearch/snapshot-restore/#security-plugin-considerations
security_plugin: `${OPENSEARCH_VERSIONED_DOCS}snapshot-restore/#security-plugin-considerations`,
},
// https://opensearch.org/docs/latest/opensearch/units/
supportedUnits: `${OPENSEARCH_VERSIONED_DOCS}units`,
// https://opensearch.org/docs/latest/opensearch/common-parameters/
commonParameters: `${OPENSEARCH_VERSIONED_DOCS}common-parameters`,
// https://opensearch.org/docs/latest/opensearch/popular-api/
popularAPI: `${OPENSEARCH_VERSIONED_DOCS}popular-api`,
// https://opensearch.org/docs/latest/opensearch/rest-api/index/
restAPI: {
base: `${OPENSEARCH_VERSIONED_DOCS}rest-api/index/`,
indexAPI: {
base: `${OPENSEARCH_VERSIONED_DOCS}rest-api/index-apis/index/`,
create: `${OPENSEARCH_VERSIONED_DOCS}rest-api/index-apis/create-index/`,
exists: `${OPENSEARCH_VERSIONED_DOCS}rest-api/index-apis/exists/`,
delete: `${OPENSEARCH_VERSIONED_DOCS}rest-api/index-apis/delete-index/`,
get: `${OPENSEARCH_VERSIONED_DOCS}rest-api/index-apis/get-index/`,
close: `${OPENSEARCH_VERSIONED_DOCS}rest-api/index-apis/close-index/`,
},
},
},
opensearchDashboards: {
// https://opensearch.org/docs/latest/dashboards/index/
introduction: `${OPENSEARCH_DASHBOARDS_VERSIONED_DOCS}index/`,
installation: {
// https://opensearch.org/docs/latest/dashboards/install/index/
base: `${OPENSEARCH_DASHBOARDS_VERSIONED_DOCS}install/index/`,
// https://opensearch.org/docs/latest/dashboards/install/docker/
docker: `${OPENSEARCH_DASHBOARDS_VERSIONED_DOCS}install/docker/`,
// https://opensearch.org/docs/latest/dashboards/install/tar/
tar: `${OPENSEARCH_DASHBOARDS_VERSIONED_DOCS}install/tar/`,
// https://opensearch.org/docs/latest/dashboards/install/helm/
helm: `${OPENSEARCH_DASHBOARDS_VERSIONED_DOCS}install/helm/`,
// https://opensearch.org/docs/latest/dashboards/install/tls/
tls: `${OPENSEARCH_DASHBOARDS_VERSIONED_DOCS}install/tls/`,
// https://opensearch.org/docs/latest/dashboards/install/plugins/
plugins: `${OPENSEARCH_DASHBOARDS_VERSIONED_DOCS}install/plugins/`,
},
// https://opensearch.org/docs/latest/dashboards/maptiles/
mapTiles: `${OPENSEARCH_DASHBOARDS_VERSIONED_DOCS}maptiles`,
// https://opensearch.org/docs/latest/dashboards/gantt/
ganttCharts: `${OPENSEARCH_DASHBOARDS_VERSIONED_DOCS}gantt`,
// https://opensearch.org/docs/latest/dashboards/reporting/
reporting: `${OPENSEARCH_DASHBOARDS_VERSIONED_DOCS}reporting`,
notebooks: {
// https://opensearch.org/docs/latest/dashboards/notebooks/
base: `${OPENSEARCH_DASHBOARDS_VERSIONED_DOCS}notebooks`,
// https://opensearch.org/docs/latest/dashboards/notebooks/#get-started-with-notebooks
notebook_tutorial: `${OPENSEARCH_DASHBOARDS_VERSIONED_DOCS}notebooks/#get-started-with-notebooks`,
// https://opensearch.org/docs/latest/dashboards/notebooks/#paragraph-actions
paragraph_tutorial: `${OPENSEARCH_DASHBOARDS_VERSIONED_DOCS}notebooks/#paragraph-actions`,
// https://opensearch.org/docs/latest/dashboards/notebooks/#sample-notebooks
sample_notebook: `${OPENSEARCH_DASHBOARDS_VERSIONED_DOCS}notebooks/#sample-notebooks`,
// https://opensearch.org/docs/latest/dashboards/notebooks/#create-a-report
create_report: `${OPENSEARCH_DASHBOARDS_VERSIONED_DOCS}notebooks/#create-a-report`,
},
dql: {
// https://opensearch.org/docs/latest/dashboards/dql/
base: `${OPENSEARCH_DASHBOARDS_VERSIONED_DOCS}dql`,
// https://opensearch.org/docs/latest/dashboards/dql/#terms-query
terms_query: `${OPENSEARCH_DASHBOARDS_VERSIONED_DOCS}dql/#terms-query`,
// https://opensearch.org/docs/latest/dashboards/dql/#boolean-query
boolean_query: `${OPENSEARCH_DASHBOARDS_VERSIONED_DOCS}dql/#boolean-query`,
// https://opensearch.org/docs/latest/dashboards/dql/#date-and-range-queries
date_query: `${OPENSEARCH_DASHBOARDS_VERSIONED_DOCS}dql/#date-and-range-queries`,
// https://opensearch.org/docs/latest/dashboards/dql/#nested-field-query
nested_query: `${OPENSEARCH_DASHBOARDS_VERSIONED_DOCS}dql/#nested-field-query`,
},
browser: `${OPENSEARCH_DASHBOARDS_VERSIONED_DOCS}browser-compatibility`,
},
noDocumentation: {
auditbeat: `https://opensearch.org/docs/latest/downloads/beats/auditbeat`,
filebeat: `https://opensearch.org/docs/latest/downloads/beats/filebeat`,
metricbeat: `https://opensearch.org/docs/latest/downloads/beats/metricbeat`,
heartbeat: `https://opensearch.org/docs/latest/downloads/beats/heartbeat`,
logstash: `${OPENSEARCH_WEBSITE_DOCS}`,
functionbeat: `https://opensearch.org/docs/latest/downloads/beats/functionbeat`,
winlogbeat: `${OPENSEARCH_WEBSITE_DOCS}`,
siem: `${OPENSEARCH_WEBSITE_DOCS}`,
indexPatterns: {
loadingData: `${OPENSEARCH_WEBSITE_DOCS}`,
introduction: `${OPENSEARCH_WEBSITE_DOCS}`,
},
management: {
opensearchDashboardsGeneralSettings: `${OPENSEARCH_WEBSITE_DOCS}`,
opensearchDashboardsSearchSettings: `${OPENSEARCH_WEBSITE_DOCS}`,
dashboardSettings: `${OPENSEARCH_WEBSITE_DOCS}`,
},
scriptedFields: {
scriptFields: `${OPENSEARCH_WEBSITE_DOCS}`,
scriptAggs: `${OPENSEARCH_WEBSITE_DOCS}`,
painless: `${OPENSEARCH_WEBSITE_DOCS}`,
painlessApi: `${OPENSEARCH_WEBSITE_DOCS}`,
painlessSyntax: `${OPENSEARCH_WEBSITE_DOCS}`,
luceneExpressions: `${OPENSEARCH_WEBSITE_DOCS}`,
},
visualize: {
guide: `${OPENSEARCH_WEBSITE_DOCS}`,
timelineDeprecation: `${OPENSEARCH_WEBSITE_DOCS}`,
},
addData: `${OPENSEARCH_WEBSITE_DOCS}`,
vega: `${OPENSEARCH_DASHBOARDS_VERSIONED_DOCS}`,
dateMath: `${OPENSEARCH_WEBSITE_DOCS}`,
savedObject: {
manageSavedObject: `https://opensearch.org/docs/latest/guide/en/kibana/current/managing-saved-objects.html#_export`,
},
clusterAPI: {
clusterRoute: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/cluster-reroute.html`,
clusterState: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/cluster-state.html`,
clusterStats: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/cluster-stats.html`,
clusterPending: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/cluster-pending.html`,
},
mappingTypes: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/current/mapping-types.html`,
moduleScripting: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/modules-scripting.html`,
indexAPI: {
indexAnalyze: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/indices-analyze.html`,
indexClearCache: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/indices-clearcache.html`,
indexClone: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/indices-clone-index.html`,
indexSynced: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/indices-synced-flush-api.html`,
indexFlush: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/indices-flush.html`,
indexForceMerge: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/indices-forcemerge.html`,
indexSetting: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/indices-get-settings.html`,
indexUpgrade: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/indices-upgrade.html`,
indexUpdateSetting: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/indices-update-settings.html`,
indexRecovery: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/indices-recovery.html`,
indexRefresh: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/indices-refresh.html`,
indexRollover: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/indices-rollover-index.html`,
indexSegment: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/indices-segments.html`,
indexShardStore: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/indices-shards-stores.html`,
indexShrink: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/indices-shrink-index.html`,
indexSplit: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/indices-split-index.html`,
indexStats: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/indices-stats.html`,
indexGetFieldMapping: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/indices-get-field-mapping.html`,
indexGetMapping: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/indices-get-mapping.html`,
indexOpenClose: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/indices-open-close.html`,
indexPutMapping: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/indices-put-mapping.html`,
indexSearchValidate: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/search-validate.html`,
},
ingest: {
deletePipeline: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/delete-pipeline-api.html`,
getPipeline: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/get-pipeline-api.html`,
putPipeline: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/put-pipeline-api.html`,
simulatePipeline: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/simulate-pipeline-api.html`,
grokProcessor: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/grok-processor.html`,
appendProcessor: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/append-processor.html`,
bytesProcessor: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/bytes-processor.html`,
ingestCircleProcessor: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/ingest-circle-processor.html`,
csvProcessor: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/csv-processor.html`,
convertProcessor: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/convert-processor.html`,
dataProcessor: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/date-processor.html`,
dataIndexNamProcessor: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/date-index-name-processor.html`,
dissectProcessor: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/dissect-processor.html`,
dotExpandProcessor: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/dot-expand-processor.html`,
dropProcessor: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/drop-processor.html`,
failProcessor: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/fail-processor.html`,
foreachProcessor: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/foreach-processor.html`,
geoIPProcessor: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/geoip-processor.html`,
gusbProcessor: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/gsub-processor.html`,
htmlstripProcessor: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/htmlstrip-processor.html`,
inferenceProcessor: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/inference-processor.html`,
joinProcessor: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/join-processor.html`,
jsonProcessor: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/json-processor.html`,
kvProcessor: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/kv-processor.html`,
lowecaseProcessor: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/lowercase-processor.html`,
pipelineProcessor: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/pipeline-processor.html`,
removeProcessor: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/remove-processor.html`,
renameProcessor: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/rename-processor.html`,
scriptProcessor: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/script-processor.html`,
setProcessor: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/set-processor.html`,
securityUserProcessor: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/ingest-node-set-security-user-processor.html`,
splitProcessor: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/split-processor.html`,
sortProcessor: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/sort-processor.html`,
trimProcessor: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/trim-processor.html`,
uppercaseProcessor: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/uppercase-processor.html`,
urldecodeProcessor: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/urldecode-processor.html`,
userAgentProcessor: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/user-agent-processor.html`,
},
nodes: {
info: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/cluster-nodes-info.html`,
hotThreads: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/cluster-nodes-hot-threads.html`,
reloadSecuritySetting: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/secure-settings.html#reloadable-secure-settings`,
// Possible here but no details: https://opensearch.org/docs/latest/opensearch/popular-api/#get-node-statistics
nodeStats: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/cluster-nodes-stats.html`,
usage: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/cluster-nodes-usage.html`,
},
reIndex: {
// Missing _rethrottle
rethrottle: `https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/reindex/`,
},
timelineDeprecation: `https://opensearch.org/docs/latest/guide/en/kibana/master/dashboard.html#timeline-deprecation`,
apmServer: `https://opensearch.org/downloads/apm/apm-server`,
tutorial: {
loadDataTutorial: `https://opensearch.org/guide/en/kibana/current/tutorial-load-dataset.html`,
visualizeTutorial: `https://opensearch.org/guide/en/kibana/current/tutorial-visualizing.html`,
},
scroll: {
clear_scroll: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/search-request-body.html#_clear_scroll_api`,
},
documentAPI: {
// missing `rethrottle` info
delete_by_query: `https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/delete-by-query/`,
multiTermVector: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/docs-multi-termvectors.html`,
termVector: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/docs-termvectors.html`,
update_by_query_rethrottle: `https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/update-by-query/`,
},
filed_caps: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/search-field-caps.html`,
painless_execute: `https://opensearch.org/docs/latest/guide/en/elasticsearch/painless/master/painless-execute-api.html`,
search: {
search: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/search-search.html`,
searchRankEval: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/search-rank-eval.html`,
searchShards: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/search-shards.html`,
searchFieldCap: `https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/search-field-caps.html`,
},
snapshot: {
deleteSnapshot: `https://opensearch.org/docs/latest/opensearch/snapshot-restore/`,
deleteRepository: `https://opensearch.org/docs/latest/opensearch/snapshot-restore/`,
cleanup: `https://opensearch.org/docs/latest/opensearch/snapshot-restore/`,
veirfyRepository: `https://opensearch.org/docs/latest/opensearch/snapshot-restore/`,
},
},
},
});
}