Skip to content

Commit 9145c99

Browse files
authored
Predefined validation rules (#52)
1 parent 9d759c6 commit 9145c99

Some content is hidden

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

91 files changed

+1996
-1764
lines changed

doc/index.html

Lines changed: 127 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -265,6 +265,45 @@ <h2>Table of Contents</h2>
265265
</li>
266266

267267

268+
<li>
269+
<a href="#metalstack%2fapi%2fv2%2fpredefined_rules.proto">metalstack/api/v2/predefined_rules.proto</a>
270+
<ul>
271+
272+
273+
274+
<li>
275+
<a href="#metalstack%2fapi%2fv2%2fpredefined_rules.proto-extensions"><span class="badge">X</span>File-level Extensions</a>
276+
</li>
277+
278+
<li>
279+
<a href="#metalstack%2fapi%2fv2%2fpredefined_rules.proto-extensions"><span class="badge">X</span>File-level Extensions</a>
280+
</li>
281+
282+
<li>
283+
<a href="#metalstack%2fapi%2fv2%2fpredefined_rules.proto-extensions"><span class="badge">X</span>File-level Extensions</a>
284+
</li>
285+
286+
<li>
287+
<a href="#metalstack%2fapi%2fv2%2fpredefined_rules.proto-extensions"><span class="badge">X</span>File-level Extensions</a>
288+
</li>
289+
290+
<li>
291+
<a href="#metalstack%2fapi%2fv2%2fpredefined_rules.proto-extensions"><span class="badge">X</span>File-level Extensions</a>
292+
</li>
293+
294+
<li>
295+
<a href="#metalstack%2fapi%2fv2%2fpredefined_rules.proto-extensions"><span class="badge">X</span>File-level Extensions</a>
296+
</li>
297+
298+
<li>
299+
<a href="#metalstack%2fapi%2fv2%2fpredefined_rules.proto-extensions"><span class="badge">X</span>File-level Extensions</a>
300+
</li>
301+
302+
303+
</ul>
304+
</li>
305+
306+
268307
<li>
269308
<a href="#metalstack%2fapi%2fv2%2ffilesystem.proto">metalstack/api/v2/filesystem.proto</a>
270309
<ul>
@@ -2415,6 +2454,86 @@ <h3 id="metalstack/api/v2/common.proto-extensions">File-level Extensions</h3>
24152454

24162455

24172456

2457+
<div class="file-heading">
2458+
<h2 id="metalstack/api/v2/predefined_rules.proto">metalstack/api/v2/predefined_rules.proto</h2><a href="#title">Top</a>
2459+
</div>
2460+
<p></p>
2461+
2462+
2463+
2464+
2465+
2466+
2467+
<h3 id="metalstack/api/v2/predefined_rules.proto-extensions">File-level Extensions</h3>
2468+
<table class="extension-table">
2469+
<thead>
2470+
<tr><td>Extension</td><td>Type</td><td>Base</td><td>Number</td><td>Description</td></tr>
2471+
</thead>
2472+
<tbody>
2473+
2474+
<tr>
2475+
<td>ips</td>
2476+
<td><a href="#bool">bool</a></td>
2477+
<td><a href="#buf.validate.RepeatedRules">.buf.validate.RepeatedRules</a></td>
2478+
<td>80048957</td>
2479+
<td><p>Ips validates if a slice of ips in string form are valid</p></td>
2480+
</tr>
2481+
2482+
<tr>
2483+
<td>prefixes</td>
2484+
<td><a href="#bool">bool</a></td>
2485+
<td><a href="#buf.validate.RepeatedRules">.buf.validate.RepeatedRules</a></td>
2486+
<td>80048956</td>
2487+
<td><p>Prefixes validates if a slice of prefixes in string form are valid</p></td>
2488+
</tr>
2489+
2490+
<tr>
2491+
<td>is_description</td>
2492+
<td><a href="#bool">bool</a></td>
2493+
<td><a href="#buf.validate.StringRules">.buf.validate.StringRules</a></td>
2494+
<td>80048953</td>
2495+
<td><p>IsDescription returns true if description field satisfies our requirements</p></td>
2496+
</tr>
2497+
2498+
<tr>
2499+
<td>is_name</td>
2500+
<td><a href="#bool">bool</a></td>
2501+
<td><a href="#buf.validate.StringRules">.buf.validate.StringRules</a></td>
2502+
<td>80048952</td>
2503+
<td><p>IsName returns true if name field satisfies our requirements</p></td>
2504+
</tr>
2505+
2506+
<tr>
2507+
<td>is_partition</td>
2508+
<td><a href="#bool">bool</a></td>
2509+
<td><a href="#buf.validate.StringRules">.buf.validate.StringRules</a></td>
2510+
<td>80048954</td>
2511+
<td><p>IsPartition returns true if partition field satisfies our requirements</p></td>
2512+
</tr>
2513+
2514+
<tr>
2515+
<td>is_prefix</td>
2516+
<td><a href="#bool">bool</a></td>
2517+
<td><a href="#buf.validate.StringRules">.buf.validate.StringRules</a></td>
2518+
<td>80048955</td>
2519+
<td><p>IsPrefix validates if the given string is a valid prefix</p></td>
2520+
</tr>
2521+
2522+
<tr>
2523+
<td>macaddress</td>
2524+
<td><a href="#bool">bool</a></td>
2525+
<td><a href="#buf.validate.StringRules">.buf.validate.StringRules</a></td>
2526+
<td>80048951</td>
2527+
<td><p>Macaddress returns true if the given string is a valid macadress</p></td>
2528+
</tr>
2529+
2530+
</tbody>
2531+
</table>
2532+
2533+
2534+
2535+
2536+
24182537
<div class="file-heading">
24192538
<h2 id="metalstack/api/v2/filesystem.proto">metalstack/api/v2/filesystem.proto</h2><a href="#title">Top</a>
24202539
</div>
@@ -8003,7 +8122,7 @@ <h3 id="metalstack.api.v2.MachineServiceCreateRequest">MachineServiceCreateReque
80038122
<tr>
80048123
<td>description</td>
80058124
<td><a href="#string">string</a></td>
8006-
<td></td>
8125+
<td>optional</td>
80078126
<td><p>Description for this machine </p></td>
80088127
</tr>
80098128

@@ -8925,7 +9044,7 @@ <h3 id="metalstack.admin.v2.MachineServiceListRequest">MachineServiceListRequest
89259044
<tr>
89269045
<td>partition</td>
89279046
<td><a href="#string">string</a></td>
8928-
<td></td>
9047+
<td>optional</td>
89299048
<td><p>Partition for which machines should be listed, could be left empty if only one partition is present
89309049
otherwise an error is thrown that the partition must be specified </p></td>
89319050
</tr>
@@ -10142,14 +10261,14 @@ <h3 id="metalstack.api.v2.BGPFilter">BGPFilter</h3>
1014210261
<td>cidrs</td>
1014310262
<td><a href="#string">string</a></td>
1014410263
<td>repeated</td>
10145-
<td><p>Cidrs for which to allow BGP. </p></td>
10264+
<td><p>CIDRs for which to allow BGP </p></td>
1014610265
</tr>
1014710266

1014810267
<tr>
1014910268
<td>vnis</td>
1015010269
<td><a href="#string">string</a></td>
1015110270
<td>repeated</td>
10152-
<td><p>Vnis for which to allow BGP. </p></td>
10271+
<td><p>VNIs for which to allow BGP </p></td>
1015310272
</tr>
1015410273

1015510274
</tbody>
@@ -10402,28 +10521,28 @@ <h3 id="metalstack.api.v2.SwitchNic">SwitchNic</h3>
1040210521
<td>name</td>
1040310522
<td><a href="#string">string</a></td>
1040410523
<td></td>
10405-
<td><p>Name of the switch port. </p></td>
10524+
<td><p>Name of the switch port </p></td>
1040610525
</tr>
1040710526

1040810527
<tr>
1040910528
<td>identifier</td>
1041010529
<td><a href="#string">string</a></td>
1041110530
<td></td>
10412-
<td><p>Identifier of the port. </p></td>
10531+
<td><p>Identifier of the port </p></td>
1041310532
</tr>
1041410533

1041510534
<tr>
1041610535
<td>mac</td>
1041710536
<td><a href="#string">string</a></td>
1041810537
<td></td>
10419-
<td><p>Mac address of the port. </p></td>
10538+
<td><p>MAC address of the port </p></td>
1042010539
</tr>
1042110540

1042210541
<tr>
1042310542
<td>vrf</td>
1042410543
<td><a href="#string">string</a></td>
1042510544
<td>optional</td>
10426-
<td><p>Vrf name if the port is bound in one. </p></td>
10545+
<td><p>VRF name if the port is bound in one </p></td>
1042710546
</tr>
1042810547

1042910548
<tr>

go/metalstack/admin/v2/filesystem.pb.go

Lines changed: 5 additions & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

go/metalstack/admin/v2/image.pb.go

Lines changed: 5 additions & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

go/metalstack/admin/v2/machine.pb.go

Lines changed: 10 additions & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)