Skip to content

Commit 0d9e65f

Browse files
committed
XML docs for alias methods
1 parent f681b63 commit 0d9e65f

File tree

2 files changed

+20
-0
lines changed

2 files changed

+20
-0
lines changed

Diff for: src/Nest/ElasticClient-Aliases.cs

+4
Original file line numberDiff line numberDiff line change
@@ -173,6 +173,7 @@ public Task<IPutAliasResponse> PutAliasAsync(Func<PutAliasDescriptor, PutAliasDe
173173
);
174174
}
175175

176+
/// <inheritdoc />
176177
public IDeleteAliasResponse DeleteAlias(IDeleteAliasRequest deleteAliasRequest)
177178
{
178179
return this.Dispatch<IDeleteAliasRequest, DeleteAliasRequestParameters, DeleteAliasResponse>(
@@ -181,6 +182,7 @@ public IDeleteAliasResponse DeleteAlias(IDeleteAliasRequest deleteAliasRequest)
181182
);
182183
}
183184

185+
/// <inheritdoc />
184186
public Task<IDeleteAliasResponse> DeleteAliasAsync(IDeleteAliasRequest deleteAliasRequest)
185187
{
186188
return this.DispatchAsync<IDeleteAliasRequest, DeleteAliasRequestParameters, DeleteAliasResponse, IDeleteAliasResponse>(
@@ -189,6 +191,7 @@ public Task<IDeleteAliasResponse> DeleteAliasAsync(IDeleteAliasRequest deleteAli
189191
);
190192
}
191193

194+
/// <inheritdoc />
192195
public IDeleteAliasResponse DeleteAlias<T>(Func<DeleteAliasDescriptor<T>, DeleteAliasDescriptor<T>> deleteAliasDescriptor)
193196
where T : class
194197
{
@@ -198,6 +201,7 @@ public IDeleteAliasResponse DeleteAlias<T>(Func<DeleteAliasDescriptor<T>, Delete
198201
);
199202
}
200203

204+
/// <inheritdoc />
201205
public Task<IDeleteAliasResponse> DeleteAliasAsync<T>(Func<DeleteAliasDescriptor<T>, DeleteAliasDescriptor<T>> deleteAliasDescriptor)
202206
where T : class
203207
{

Diff for: src/Nest/IElasticClient.cs

+16
Original file line numberDiff line numberDiff line change
@@ -1008,20 +1008,36 @@ Task<IGetResponse<T>> GetAsync<T>(IGetRequest getRequest)
10081008
/// <inheritdoc />
10091009
Task<IGetAliasesResponse> GetAliasesAsync(IGetAliasesRequest getAliasesRequest);
10101010

1011+
/// <summary>
1012+
/// Add a single index alias
1013+
/// http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html#alias-adding
1014+
/// </summary>
1015+
/// <param name="putAliasRequest">A descriptor that describes the put alias request</param>
10111016
IPutAliasResponse PutAlias(IPutAliasRequest putAliasRequest);
10121017

1018+
/// <inheritdoc />
10131019
Task<IPutAliasResponse> PutAliasAsync(IPutAliasRequest putAliasRequest);
10141020

1021+
/// <inheritdoc />
10151022
IPutAliasResponse PutAlias(Func<PutAliasDescriptor, PutAliasDescriptor> putAliasDescriptor);
10161023

1024+
/// <inheritdoc />
10171025
Task<IPutAliasResponse> PutAliasAsync(Func<PutAliasDescriptor, PutAliasDescriptor> putAliasDescriptor);
10181026

1027+
/// <summary>
1028+
/// Delete an index alias
1029+
/// http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html#deleting
1030+
/// </summary>
1031+
/// <param name="deleteAliasRequest">A descriptor that describes the delete alias request</param>
10191032
IDeleteAliasResponse DeleteAlias(IDeleteAliasRequest deleteAliasRequest);
10201033

1034+
/// <inheritdoc />
10211035
Task<IDeleteAliasResponse> DeleteAliasAsync(IDeleteAliasRequest deleteAliasRequest);
10221036

1037+
/// <inheritdoc />
10231038
IDeleteAliasResponse DeleteAlias<T>(Func<DeleteAliasDescriptor<T>, DeleteAliasDescriptor<T>> deleteAliasDescriptor) where T : class;
10241039

1040+
/// <inheritdoc />
10251041
Task<IDeleteAliasResponse> DeleteAliasAsync<T>(Func<DeleteAliasDescriptor<T>, DeleteAliasDescriptor<T>> deleteAliasDescriptor) where T : class;
10261042

10271043
/// <summary>

0 commit comments

Comments
 (0)