Skip to content

Commit 670b4bb

Browse files
committed
typo
1 parent 9c706b5 commit 670b4bb

File tree

3 files changed

+20
-1
lines changed

3 files changed

+20
-1
lines changed

source/_static/img/export-example.png

56.3 KB
Loading

source/key-concepts.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,10 @@ The current policy that is applied to any subscriber of a channel is Read/Write.
126126

127127
For a more granular management of permissions, a policy management plugin is required for each channel to ensure that they have policies-based accesses by its subscribers.
128128

129+
.. note::
130+
131+
This subsection describes functionality that has not yet been implemented in the OSS DBoM Gateway
132+
129133
The plugin will provide a framework for governance of information and attestations.
130134
Policies will be enforced on channels that are created by the Designated Repository Owner (DRO).
131135

source/tutorials.rst

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ When a transfer occurs, the metadata required to find the transfer destination a
100100
Using the REST API
101101
^^^^^^^^^^^^^^^^^^
102102

103-
Import the `Postman files for the Gateway <https://github.com/DBOMproject/api-specs/tree/master/gateway/postman>`__ to experiment with the REST API.
103+
Import the `postman files for the Gateway <https://github.com/DBOMproject/api-specs/tree/master/gateway/postman>`__ to experiment with the REST API.
104104

105105
Open up the postman collection and navigate to the "Transfer an Asset" request. Enter your parameters for repo ID, channel ID and asset ID (source) into the http parameters tab
106106

@@ -159,4 +159,19 @@ This is where transfer policies come in. They allow you to set channel wide or a
159159
Channels will have a default transfer policy, which will apply to all assets that don't have an explicit channel policy specified, however if the asset references a specific policy as part of the asset metadata, that policy will override the default policy set at the channel level
160160

161161

162+
Export API
163+
------------
164+
165+
The export api lets you retrieve an entire asset tree from the DBoM (i.e. including all parent and child assets). This could be useful if you are moving an asset and all associated sub assets into another system for processing
166+
167+
Take an example where you create a bunch of assets and attach them as shown below.
168+
169+
.. image:: _static/img/export-example.png
170+
:width: 300px
171+
:align: center
172+
:alt: Example export scenario
173+
174+
If you wanted to export these assets out at once into another system, you can run export on any of these assets and the entire tree will be returned as JSON.
162175

176+
For instance, let's say we try exporting `ExportTestA1`, we will get a JSON payload with all its children upto the leaf level (i.e `ExportTestA2`, `ExportTestA3` and `ExportTestA4`).
177+
However, if we try to export `ExportTestA2`, we will get all children and direct ancestors (i.e `ExportTestA1` and `ExportTestA4`)

0 commit comments

Comments
 (0)