Skip to content

Commit 3794c35

Browse files
committed
Return summaries from list servers
* ListServers returns Server * ListServerSummaries returns ServerSummary * Image/ServerVolume has a ServerReference
1 parent d877b00 commit 3794c35

13 files changed

Lines changed: 46 additions & 36 deletions

File tree

src/corelib/Compute/v2_1/ComputeApiBuilder.cs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -160,16 +160,16 @@ protected ComputeApiBuilder(IServiceType serviceType, IAuthenticationProvider au
160160
}
161161

162162
/// <summary />
163-
public virtual async Task<TPage> ListServerReferencesAsync<TPage>(IQueryStringBuilder queryString, CancellationToken cancellationToken = default(CancellationToken))
163+
public virtual async Task<TPage> ListServerSummariesAsync<TPage>(IQueryStringBuilder queryString, CancellationToken cancellationToken = default(CancellationToken))
164164
where TPage : IPageBuilder<TPage>, IEnumerable<IServiceResource>
165165
{
166-
Url initialRequestUrl = await BuildListServerReferencesUrlAsync(queryString, cancellationToken);
166+
Url initialRequestUrl = await BuildListServerSummariesUrl(queryString, cancellationToken);
167167
return await Endpoint.GetResourcePageAsync<TPage>(initialRequestUrl, cancellationToken)
168168
.PropogateOwnerToChildren(this);
169169
}
170170

171171
/// <summary />
172-
public virtual async Task<Url> BuildListServerReferencesUrlAsync(IQueryStringBuilder queryString, CancellationToken cancellationToken = default(CancellationToken))
172+
public virtual async Task<Url> BuildListServerSummariesUrl(IQueryStringBuilder queryString, CancellationToken cancellationToken = default(CancellationToken))
173173
{
174174
Url endpoint = await Endpoint.GetEndpoint(cancellationToken).ConfigureAwait(false);
175175

@@ -182,13 +182,13 @@ protected ComputeApiBuilder(IServiceType serviceType, IAuthenticationProvider au
182182
public virtual async Task<TPage> ListServersAsync<TPage>(IQueryStringBuilder queryString, CancellationToken cancellationToken = default(CancellationToken))
183183
where TPage : IPageBuilder<TPage>, IEnumerable<IServiceResource>
184184
{
185-
Url initialRequestUrl = await BuildListServersUrlAsync(queryString, cancellationToken);
185+
Url initialRequestUrl = await BuildListServersUrl(queryString, cancellationToken);
186186
return await Endpoint.GetResourcePageAsync<TPage>(initialRequestUrl, cancellationToken)
187187
.PropogateOwnerToChildren(this);
188188
}
189189

190190
/// <summary />
191-
public virtual async Task<Url> BuildListServersUrlAsync(IQueryStringBuilder queryString, CancellationToken cancellationToken = default(CancellationToken))
191+
public virtual async Task<Url> BuildListServersUrl(IQueryStringBuilder queryString, CancellationToken cancellationToken = default(CancellationToken))
192192
{
193193
Url endpoint = await Endpoint.GetEndpoint(cancellationToken).ConfigureAwait(false);
194194

src/corelib/Compute/v2_1/ComputeService.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,10 +54,10 @@ public ComputeService(IAuthenticationProvider authenticationProvider, string reg
5454
return _computeApi.WaitForServerStatusAsync<Server, ServerStatus>(serverId, statuses, refreshDelay, timeout, progress, cancellationToken);
5555
}
5656

57-
/// <inheritdoc cref="ComputeApiBuilder.ListServerReferencesAsync{TPage}(IQueryStringBuilder,CancellationToken)" />
58-
public async Task<IPage<ServerReference>> ListServerReferencesAsync(ServerListOptions options = null, CancellationToken cancellationToken = default(CancellationToken))
57+
/// <inheritdoc cref="ComputeApiBuilder.ListServerSummariesAsync{TPage}" />
58+
public async Task<IPage<ServerSummary>> ListServerSummariesAsync(ServerListOptions options = null, CancellationToken cancellationToken = default(CancellationToken))
5959
{
60-
return await _computeApi.ListServerReferencesAsync<ServerReferenceCollection>(options, cancellationToken);
60+
return await _computeApi.ListServerSummariesAsync<ServerSummaryCollection>(options, cancellationToken);
6161
}
6262

6363
/// <inheritdoc cref="ComputeApiBuilder.ListServersAsync{TPage}(IQueryStringBuilder,CancellationToken)" />

src/corelib/Compute/v2_1/ComputeServiceExtensions.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,10 @@ public static Server WaitForServerStatus(this ComputeService service, Identifier
3636
return service.WaitForServerStatusAsync(serverId, statuses, refreshDelay, timeout, progress).ForceSynchronous();
3737
}
3838

39-
/// <inheritdoc cref="ComputeService.ListServerReferencesAsync" />
40-
public static IPage<ServerReference> ListServerReferences(this ComputeService service, ServerListOptions options = null)
39+
/// <inheritdoc cref="ComputeService.ListServerSummariesAsync" />
40+
public static IPage<ServerSummary> ListServerSummaries(this ComputeService service, ServerListOptions options = null)
4141
{
42-
return service.ListServerReferencesAsync(options).ForceSynchronous();
42+
return service.ListServerSummariesAsync(options).ForceSynchronous();
4343
}
4444

4545
/// <inheritdoc cref="ComputeService.ListServersAsync" />

src/corelib/Compute/v2_1/Serialization/ServerCollection.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,10 @@ public class ServerCollection<TPage, TItem> : Page<TPage, TItem, PageLink>
2626
}
2727

2828
/// <summary>
29-
/// Represents a collection of references to server resources of the <see cref="ComputeService"/>.
29+
/// Represents a collection of server summary resources of the <see cref="ComputeService"/>.
3030
/// </summary>
3131
/// <exclude />
32-
public class ServerReferenceCollection : ServerCollection<ServerReferenceCollection, ServerReference>
32+
public class ServerSummaryCollection : ServerCollection<ServerSummaryCollection, ServerSummary>
3333
{ }
3434

3535
/// <inheritdoc cref="ServerCollection{TPage, TItem}" />

src/corelib/Compute/v2_1/Server.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ namespace OpenStack.Compute.v2_1
1111
{
1212
/// <summary />
1313
[JsonConverterWithConstructor(typeof(RootWrapperConverter), "server")]
14-
public class Server : ServerReference
14+
public class Server : ServerSummary
1515
{
1616
/// <summary />
1717
public Server()

src/corelib/Compute/v2_1/ServerReference.cs

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,6 @@ public class ServerReference : IHaveExtraData, IServiceResource
1616
[JsonProperty("id")]
1717
public Identifier Id { get; set; }
1818

19-
/// <summary />
20-
[JsonProperty("name")]
21-
public string Name { get; set; }
22-
2319
/// <summary />
2420
[JsonExtensionData]
2521
IDictionary<string, JToken> IHaveExtraData.Data { get; set; } = new Dictionary<string, JToken>();
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
using Newtonsoft.Json;
2+
3+
namespace OpenStack.Compute.v2_1
4+
{
5+
/// <summary />
6+
public class ServerSummary : ServerReference
7+
{
8+
/// <summary />
9+
[JsonProperty("name")]
10+
public string Name { get; set; }
11+
}
12+
}

src/corelib/Compute/v2_2/ComputeService.cs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
using System.Threading;
22
using System.Threading.Tasks;
33
using OpenStack.Authentication;
4+
using OpenStack.Compute.v2_1;
45
using OpenStack.Compute.v2_2.Serialization;
56
using OpenStack.Serialization;
67

@@ -18,10 +19,10 @@ public ComputeService(IAuthenticationProvider authenticationProvider, string reg
1819
}
1920

2021
#region Servers
21-
/// <inheritdoc cref="v2_1.ComputeApiBuilder.ListServerReferencesAsync{TPage}(IQueryStringBuilder,CancellationToken)" />
22+
/// <inheritdoc cref="v2_1.ComputeApiBuilder.ListServerSummariesAsync{TPage}" />
2223
public virtual async Task<IPage<ServerReference>> ListServerReferencesAsync(ServerListOptions options = null, CancellationToken cancellationToken = default(CancellationToken))
2324
{
24-
return await _computeApiBuilder.ListServerReferencesAsync<ServerCollection>(options, cancellationToken);
25+
return await _computeApiBuilder.ListServerSummariesAsync<ServerCollection>(options, cancellationToken);
2526
}
2627

2728
/// <summary />

src/corelib/Compute/v2_6/ComputeService.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ public ComputeService(IAuthenticationProvider authenticationProvider, string reg
2121
/// <summary />
2222
public virtual async Task<IPage<ServerReference>> ListServerReferencesAsync(ServerListOptions options = null, CancellationToken cancellationToken = default(CancellationToken))
2323
{
24-
return await _computeApiBuilder.ListServerReferencesAsync<ServerCollection>(options, cancellationToken);
24+
return await _computeApiBuilder.ListServerSummariesAsync<ServerCollection>(options, cancellationToken);
2525
}
2626

2727
/// <summary />

src/corelib/OpenStack.csproj

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,7 @@
125125
<Compile Include="Compute\v2_1\Serialization\VolumeSnapshotCollection.cs" />
126126
<Compile Include="Compute\v2_1\Serialization\VolumeTypeCollection.cs" />
127127
<Compile Include="Compute\v2_1\Serialization\VolumeCollection.cs" />
128+
<Compile Include="Compute\v2_1\ServerSummary.cs" />
128129
<Compile Include="Compute\v2_1\VolumeSnapshotExtensions.cs" />
129130
<Compile Include="Compute\v2_1\VolumeExtensions.cs" />
130131
<Compile Include="Compute\v2_1\ServerGroupExtensions.cs" />

0 commit comments

Comments
 (0)