Skip to content

Commit 4f25815

Browse files
simon-dewdgnicholson
authored andcommitted
DOC-13120: Convert Search REST APIs to OpenAPI (#165)
* Add Search Gradle files * Import Search specs * Add deprecation notice snippets * Add header attributes * Add CSS passthroughs * Add security partials * Externalize examples * Migrate examples from docs-server * Improve parameter descriptions and examples * Move nsstats for index into the Stats spec * Update description of partition APIs * Standardize API versions * Explain parameters in examples * Build output docs
1 parent c7a1505 commit 4f25815

182 files changed

Lines changed: 25310 additions & 74 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

build.gradle

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,12 @@ defaultTasks 'admin:openApiGenerate',
2929
'eventing:openApiGenerate',
3030
'functions:openApiGenerate',
3131
'indexes:openApiGenerate',
32+
'search-index:openApiGenerate',
33+
'search-nodes:openApiGenerate',
34+
'search-advanced:openApiGenerate',
35+
'search-stats:openApiGenerate',
36+
'search-query:openApiGenerate',
37+
'search-manage:openApiGenerate',
3238
'analytics-admin:openApiGenerate',
3339
'analytics-config:openApiGenerate',
3440
'analytics-library:openApiGenerate',

docs/modules/analytics-rest-admin/pages/index.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ The URL scheme. Use `https` for secure access.
6565
a| *host*
6666
a| [markdown]
6767
--
68-
The host name or IP address of a node running the Analytics service.
68+
The host name or IP address of a node running the Analytics Service.
6969
--
7070

7171
[%hardbreaks]
@@ -76,7 +76,7 @@ The host name or IP address of a node running the Analytics service.
7676
a| *port*
7777
a| [markdown]
7878
--
79-
The Analytics service REST port. Use `18095` for secure access.
79+
The Analytics Service REST port. Use `18095` for secure access.
8080
--
8181

8282
[%hardbreaks]
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
The Analytics Administration REST APIs support HTTP basic authentication.
2-
Credentials can be passed via HTTP headers.
2+
Pass your credentials through HTTP headers.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
Refer to xref:learn:security/roles.adoc[] for more details.
1+
For more information, see xref:learn:security/roles.adoc[].

docs/modules/analytics-rest-config/pages/index.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ The URL scheme. Use `https` for secure access.
6565
a| *host*
6666
a| [markdown]
6767
--
68-
The host name or IP address of a node running the Analytics service.
68+
The host name or IP address of a node running the Analytics Service.
6969
--
7070

7171
[%hardbreaks]
@@ -76,7 +76,7 @@ The host name or IP address of a node running the Analytics service.
7676
a| *port*
7777
a| [markdown]
7878
--
79-
The Analytics service REST port. Use `18095` for secure access.
79+
The Analytics Service REST port. Use `18095` for secure access.
8080
--
8181

8282
[%hardbreaks]
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
The Analytics Configuration REST API supports HTTP basic authentication.
2-
Credentials can be passed via HTTP headers.
2+
Pass your credentials through HTTP headers.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
Refer to xref:learn:security/roles.adoc[] for more details.
1+
For more information, see xref:learn:security/roles.adoc[].

docs/modules/analytics-rest-library/pages/index.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ The URL scheme. Use `https` for secure access.
6565
a| *host*
6666
a| [markdown]
6767
--
68-
The host name or IP address of a node running the Analytics service.
68+
The host name or IP address of a node running the Analytics Service.
6969
--
7070

7171
[%hardbreaks]
@@ -76,7 +76,7 @@ The host name or IP address of a node running the Analytics service.
7676
a| *port*
7777
a| [markdown]
7878
--
79-
The Analytics service REST port. Use `18095` for secure access.
79+
The Analytics Service REST port. Use `18095` for secure access.
8080
--
8181

8282
[%hardbreaks]
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
The Analytics Library REST API supports HTTP basic authentication.
2-
Credentials can be passed via HTTP headers.
2+
Pass your credentials through HTTP headers.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
Refer to xref:learn:security/roles.adoc[] for more details.
1+
For more information, see xref:learn:security/roles.adoc[].

0 commit comments

Comments
 (0)