Skip to content

Commit 617765f

Browse files
gertdgertd
committed
writer.batch API
1 parent fb5c1d6 commit 617765f

File tree

5 files changed

+576
-0
lines changed

5 files changed

+576
-0
lines changed

‎docs/api.md‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,10 @@
123123
- [Writer](#aserto-directory-writer-v3-Writer)
124124

125125
- [aserto/directory/writer/v4/writer.proto](#aserto_directory_writer_v4_writer-proto)
126+
- [BatchRequest](#aserto-directory-writer-v4-BatchRequest)
127+
- [BatchRequests](#aserto-directory-writer-v4-BatchRequests)
128+
- [BatchResponse](#aserto-directory-writer-v4-BatchResponse)
129+
- [BatchResponses](#aserto-directory-writer-v4-BatchResponses)
126130
- [DeleteManifestRequest](#aserto-directory-writer-v4-DeleteManifestRequest)
127131
- [DeleteManifestResponse](#aserto-directory-writer-v4-DeleteManifestResponse)
128132
- [DeleteObjectRequest](#aserto-directory-writer-v4-DeleteObjectRequest)
@@ -1861,6 +1865,72 @@ Directory Reader service
18611865

18621866

18631867

1868+
<a name="aserto-directory-writer-v4-BatchRequest"></a>
1869+
1870+
### BatchRequest
1871+
1872+
1873+
1874+
| Field | Type | Label | Description |
1875+
| ----- | ---- | ----- | ----------- |
1876+
| requests | [BatchRequests](#aserto-directory-writer-v4-BatchRequests) | repeated | requests collection |
1877+
1878+
1879+
1880+
1881+
1882+
1883+
<a name="aserto-directory-writer-v4-BatchRequests"></a>
1884+
1885+
### BatchRequests
1886+
1887+
1888+
1889+
| Field | Type | Label | Description |
1890+
| ----- | ---- | ----- | ----------- |
1891+
| set_object | [SetObjectRequest](#aserto-directory-writer-v4-SetObjectRequest) | | set object request |
1892+
| delete_object | [DeleteObjectRequest](#aserto-directory-writer-v4-DeleteObjectRequest) | | delete object request |
1893+
| set_relation | [SetRelationRequest](#aserto-directory-writer-v4-SetRelationRequest) | | set relation request |
1894+
| delete_relation | [DeleteRelationRequest](#aserto-directory-writer-v4-DeleteRelationRequest) | | delete relation request |
1895+
1896+
1897+
1898+
1899+
1900+
1901+
<a name="aserto-directory-writer-v4-BatchResponse"></a>
1902+
1903+
### BatchResponse
1904+
1905+
1906+
1907+
| Field | Type | Label | Description |
1908+
| ----- | ---- | ----- | ----------- |
1909+
| responses | [BatchResponses](#aserto-directory-writer-v4-BatchResponses) | repeated | responses collection |
1910+
1911+
1912+
1913+
1914+
1915+
1916+
<a name="aserto-directory-writer-v4-BatchResponses"></a>
1917+
1918+
### BatchResponses
1919+
1920+
1921+
1922+
| Field | Type | Label | Description |
1923+
| ----- | ---- | ----- | ----------- |
1924+
| set_object | [SetObjectResponse](#aserto-directory-writer-v4-SetObjectResponse) | | set object request |
1925+
| delete_object | [DeleteObjectResponse](#aserto-directory-writer-v4-DeleteObjectResponse) | | delete object request |
1926+
| set_relation | [SetRelationResponse](#aserto-directory-writer-v4-SetRelationResponse) | | set relation request |
1927+
| delete_relation | [DeleteRelationResponse](#aserto-directory-writer-v4-DeleteRelationResponse) | | delete relation request |
1928+
1929+
1930+
1931+
1932+
1933+
18641934
<a name="aserto-directory-writer-v4-DeleteManifestRequest"></a>
18651935

18661936
### DeleteManifestRequest
@@ -2158,6 +2228,7 @@ Directory Writer service
21582228
| DeleteObject | [DeleteObjectRequest](#aserto-directory-writer-v4-DeleteObjectRequest) | [DeleteObjectResponse](#aserto-directory-writer-v4-DeleteObjectResponse) | delete object instance |
21592229
| SetRelation | [SetRelationRequest](#aserto-directory-writer-v4-SetRelationRequest) | [SetRelationResponse](#aserto-directory-writer-v4-SetRelationResponse) | set relation instance |
21602230
| DeleteRelation | [DeleteRelationRequest](#aserto-directory-writer-v4-DeleteRelationRequest) | [DeleteRelationResponse](#aserto-directory-writer-v4-DeleteRelationResponse) | delete relation instance |
2231+
| Batch | [BatchRequest](#aserto-directory-writer-v4-BatchRequest) | [BatchResponse](#aserto-directory-writer-v4-BatchResponse) | batch a set of object and or relation based operations ((Set|Delete)|(Object|Relation)) in a single transaction |
21612232
| Import | [ImportRequest](#aserto-directory-writer-v4-ImportRequest) stream | [ImportResponse](#aserto-directory-writer-v4-ImportResponse) stream | import stream of objects and relations |
21622233

21632234

‎html/index.html‎

Lines changed: 171 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -656,6 +656,22 @@ <h2>Table of Contents</h2>
656656
<a href="#aserto%2fdirectory%2fwriter%2fv4%2fwriter.proto">aserto/directory/writer/v4/writer.proto</a>
657657
<ul>
658658

659+
<li>
660+
<a href="#aserto.directory.writer.v4.BatchRequest"><span class="badge">M</span>BatchRequest</a>
661+
</li>
662+
663+
<li>
664+
<a href="#aserto.directory.writer.v4.BatchRequests"><span class="badge">M</span>BatchRequests</a>
665+
</li>
666+
667+
<li>
668+
<a href="#aserto.directory.writer.v4.BatchResponse"><span class="badge">M</span>BatchResponse</a>
669+
</li>
670+
671+
<li>
672+
<a href="#aserto.directory.writer.v4.BatchResponses"><span class="badge">M</span>BatchResponses</a>
673+
</li>
674+
659675
<li>
660676
<a href="#aserto.directory.writer.v4.DeleteManifestRequest"><span class="badge">M</span>DeleteManifestRequest</a>
661677
</li>
@@ -4840,6 +4856,144 @@ <h2 id="aserto/directory/writer/v4/writer.proto">aserto/directory/writer/v4/writ
48404856
<p></p>
48414857

48424858

4859+
<h3 id="aserto.directory.writer.v4.BatchRequest">BatchRequest</h3>
4860+
<p></p>
4861+
4862+
4863+
<table class="field-table">
4864+
<thead>
4865+
<tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
4866+
</thead>
4867+
<tbody>
4868+
4869+
<tr>
4870+
<td>requests</td>
4871+
<td><a href="#aserto.directory.writer.v4.BatchRequests">BatchRequests</a></td>
4872+
<td>repeated</td>
4873+
<td><p>requests collection </p></td>
4874+
</tr>
4875+
4876+
</tbody>
4877+
</table>
4878+
4879+
4880+
4881+
4882+
4883+
<h3 id="aserto.directory.writer.v4.BatchRequests">BatchRequests</h3>
4884+
<p></p>
4885+
4886+
4887+
<table class="field-table">
4888+
<thead>
4889+
<tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
4890+
</thead>
4891+
<tbody>
4892+
4893+
<tr>
4894+
<td>set_object</td>
4895+
<td><a href="#aserto.directory.writer.v4.SetObjectRequest">SetObjectRequest</a></td>
4896+
<td></td>
4897+
<td><p>set object request </p></td>
4898+
</tr>
4899+
4900+
<tr>
4901+
<td>delete_object</td>
4902+
<td><a href="#aserto.directory.writer.v4.DeleteObjectRequest">DeleteObjectRequest</a></td>
4903+
<td></td>
4904+
<td><p>delete object request </p></td>
4905+
</tr>
4906+
4907+
<tr>
4908+
<td>set_relation</td>
4909+
<td><a href="#aserto.directory.writer.v4.SetRelationRequest">SetRelationRequest</a></td>
4910+
<td></td>
4911+
<td><p>set relation request </p></td>
4912+
</tr>
4913+
4914+
<tr>
4915+
<td>delete_relation</td>
4916+
<td><a href="#aserto.directory.writer.v4.DeleteRelationRequest">DeleteRelationRequest</a></td>
4917+
<td></td>
4918+
<td><p>delete relation request </p></td>
4919+
</tr>
4920+
4921+
</tbody>
4922+
</table>
4923+
4924+
4925+
4926+
4927+
4928+
<h3 id="aserto.directory.writer.v4.BatchResponse">BatchResponse</h3>
4929+
<p></p>
4930+
4931+
4932+
<table class="field-table">
4933+
<thead>
4934+
<tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
4935+
</thead>
4936+
<tbody>
4937+
4938+
<tr>
4939+
<td>responses</td>
4940+
<td><a href="#aserto.directory.writer.v4.BatchResponses">BatchResponses</a></td>
4941+
<td>repeated</td>
4942+
<td><p>responses collection </p></td>
4943+
</tr>
4944+
4945+
</tbody>
4946+
</table>
4947+
4948+
4949+
4950+
4951+
4952+
<h3 id="aserto.directory.writer.v4.BatchResponses">BatchResponses</h3>
4953+
<p></p>
4954+
4955+
4956+
<table class="field-table">
4957+
<thead>
4958+
<tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
4959+
</thead>
4960+
<tbody>
4961+
4962+
<tr>
4963+
<td>set_object</td>
4964+
<td><a href="#aserto.directory.writer.v4.SetObjectResponse">SetObjectResponse</a></td>
4965+
<td></td>
4966+
<td><p>set object request </p></td>
4967+
</tr>
4968+
4969+
<tr>
4970+
<td>delete_object</td>
4971+
<td><a href="#aserto.directory.writer.v4.DeleteObjectResponse">DeleteObjectResponse</a></td>
4972+
<td></td>
4973+
<td><p>delete object request </p></td>
4974+
</tr>
4975+
4976+
<tr>
4977+
<td>set_relation</td>
4978+
<td><a href="#aserto.directory.writer.v4.SetRelationResponse">SetRelationResponse</a></td>
4979+
<td></td>
4980+
<td><p>set relation request </p></td>
4981+
</tr>
4982+
4983+
<tr>
4984+
<td>delete_relation</td>
4985+
<td><a href="#aserto.directory.writer.v4.DeleteRelationResponse">DeleteRelationResponse</a></td>
4986+
<td></td>
4987+
<td><p>delete relation request </p></td>
4988+
</tr>
4989+
4990+
</tbody>
4991+
</table>
4992+
4993+
4994+
4995+
4996+
48434997
<h3 id="aserto.directory.writer.v4.DeleteManifestRequest">DeleteManifestRequest</h3>
48444998
<p></p>
48454999

@@ -5482,6 +5636,13 @@ <h3 id="aserto.directory.writer.v4.Writer">Writer</h3>
54825636
<td><p>delete relation instance</p></td>
54835637
</tr>
54845638

5639+
<tr>
5640+
<td>Batch</td>
5641+
<td><a href="#aserto.directory.writer.v4.BatchRequest">BatchRequest</a></td>
5642+
<td><a href="#aserto.directory.writer.v4.BatchResponse">BatchResponse</a></td>
5643+
<td><p>batch a set of object and or relation based operations ((Set|Delete)|(Object|Relation)) in a single transaction</p></td>
5644+
</tr>
5645+
54855646
<tr>
54865647
<td>Import</td>
54875648
<td><a href="#aserto.directory.writer.v4.ImportRequest">ImportRequest</a> stream</td>
@@ -5567,6 +5728,16 @@ <h4>Methods with HTTP bindings</h4>
55675728
</tr>
55685729

55695730

5731+
5732+
5733+
<tr>
5734+
<td>Batch</td>
5735+
<td>DELETE</td>
5736+
<td>/api/v4/directory/batch</td>
5737+
<td></td>
5738+
</tr>
5739+
5740+
55705741
</tbody>
55715742
</table>
55725743

0 commit comments

Comments
 (0)