Skip to content
This repository was archived by the owner on Sep 6, 2025. It is now read-only.

Commit 2a22b83

Browse files
authored
Old neighbors endpoint deprecated, only minor changes in new endpoint (#81)
1 parent acfaafc commit 2a22b83

3 files changed

Lines changed: 28 additions & 0 deletions

File tree

DigitalOcean.API.Tests/Clients/DropletsClientTest.cs

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,5 +148,15 @@ public void CorrectRequestForListDropletNeighbors() {
148148

149149
factory.Received().GetPaginated<Droplet>("reports/droplet_neighbors", null, "neighbors");
150150
}
151+
152+
[Fact]
153+
public void CorrectRequestForListDropletNeighborIds() {
154+
var factory = Substitute.For<IConnection>();
155+
var client = new DropletsClient(factory);
156+
157+
client.ListDropletNeighborIds();
158+
159+
factory.Received().GetPaginated<List<long>>("reports/droplet_neighbors_ids", null, "neighbor_ids");
160+
}
151161
}
152162
}

DigitalOcean.API/Clients/DropletsClient.cs

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,10 +134,20 @@ public Task DeleteByTag(string tagName) {
134134
/// <summary>
135135
/// To retrieve a list of any Droplets that are running on the same physical hardware.
136136
/// </summary>
137+
[System.Obsolete("Deprecated on December 17th, 2019")]
137138
public Task<IReadOnlyList<Droplet>> ListDropletNeighbors() {
138139
return _connection.GetPaginated<Droplet>("reports/droplet_neighbors", null, "neighbors");
139140
}
140141

142+
/// <summary>
143+
/// To retrieve a list of all Droplets that are co-located on the same physical hardware.
144+
/// This will be set to an array of arrays. Each array will contain a set of Droplet IDs for Droplets that share a physical server.
145+
/// An empty array indicates that all Droplets associated with your account are located on separate physical hardware.
146+
/// </summary>
147+
public Task<IReadOnlyList<List<long>>> ListDropletNeighborIds() {
148+
return _connection.GetPaginated<List<long>>("reports/droplet_neighbors_ids", null, "neighbor_ids");
149+
}
150+
141151
#endregion
142152
}
143153
}

DigitalOcean.API/Clients/IDropletsClient.cs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,14 @@ public interface IDropletsClient {
6969
/// <summary>
7070
/// To retrieve a list of any Droplets that are running on the same physical hardware.
7171
/// </summary>
72+
[System.Obsolete("Deprecated on December 17th, 2019")]
7273
Task<IReadOnlyList<Droplet>> ListDropletNeighbors();
74+
75+
/// <summary>
76+
/// To retrieve a list of all Droplets that are co-located on the same physical hardware.
77+
/// This will be set to an array of arrays. Each array will contain a set of Droplet IDs for Droplets that share a physical server.
78+
/// An empty array indicates that all Droplets associated with your account are located on separate physical hardware.
79+
/// </summary>
80+
Task<IReadOnlyList<List<long>>> ListDropletNeighborIds();
7381
}
7482
}

0 commit comments

Comments
 (0)