Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ We'll happily review any suggestions!
1. To begin, pull the latest DataTrails docs from Github.

```bash
git clone git@github.com/datatrails/datatrails-docs.git
git clone git@github.com:datatrails/datatrails-docs.git
```

2. Move into the directory.
Expand All @@ -33,7 +33,7 @@ npm install
4. To run a local DataTrails Docs Server, it is advisable to use the `rkvst-doks` wrapper.

```bash
rkvst-doks start
./rkvst-doks start
```

This will build a local version of the server that can be accessed at [http://localhost:1313](https://localhost:1313).
Expand Down
1 change: 0 additions & 1 deletion content/developers/api-reference/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ aliases:
<a href="/developers/api-reference/asset-events-api/">Asset-Events API &rarr;</a><br>
<a href="/developers/api-reference/attachments-api/">Attachments API &rarr;</a><br>
<a href="/developers/api-reference/blobs-api/">Blobs API &rarr;</a><br>
<a href="/developers/api-reference/compliance-api/">Compliance API &rarr;</a><br>
<a href="/developers/api-reference/events-api/">Events API &rarr;</a><br>
<a href="/developers/api-reference/iam-policies-api/">IAM Policies API &rarr;</a><br>
<a href="/developers/api-reference/iam-subjects-api/">IAM Subjects API &rarr;</a><br>
Expand Down
9 changes: 4 additions & 5 deletions content/developers/api-reference/caps-api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@ date: 2024-03-05T11:30:29Z
lastmod: 2024-03-05T11:30:29Z
draft: false
images: []
menu:
menu:
developers:
parent: "api-reference"
weight: 999
toc: true
---
{{< note >}}
**Note:** This page is primarily intended for developers who will be writing applications that will use DataTrails for provenance.
If you are looking for a simple way to test our API you might prefer our [Postman collection](https://www.postman.com/datatrails-inc/workspace/datatrails-public/overview), the [YAML runner](/developers/yaml-reference/story-runner-components/) or the [Developers](https://app.datatrails.ai) section of the web UI.
**Note:** This page is primarily intended for developers who will be writing applications that will use DataTrails for provenance.
If you are looking for a simple way to test our API you might prefer our [Postman collection](https://www.postman.com/datatrails-inc/workspace/datatrails-public/overview), the [YAML runner](/developers/yaml-reference/story-runner-components/) or the [Developers](https://app.datatrails.ai) section of the web UI.

Additional YAML examples can be found in the articles in the [Overview](/platform/overview/introduction/) section.
{{< /note >}}
Expand All @@ -29,7 +29,7 @@ Retrieve the number of remaining Access Policies:
```bash
curl -g -v -X GET \
-H "@$HOME/.datatrails/bearer-token.txt" \
"https://app.datatrails.ai/archivist/v1/caps?service=access_policies"
"https://app.datatrails.ai/archivist/v1/caps?service=access_policies"
```

The response is:
Expand All @@ -49,7 +49,6 @@ These are the available values for "**?service=**":
* applications
* assets
* blobs
* compliance_policies
* locations
* members

Expand Down
276 changes: 0 additions & 276 deletions content/developers/api-reference/compliance-api/index.md

This file was deleted.

3 changes: 1 addition & 2 deletions content/developers/yaml-reference/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ draft: false
images: []
weight: 999
toc: true
aliases:
aliases:
- /docs/yaml-reference/
---
<div class= "row justify-content-center">
Expand All @@ -21,7 +21,6 @@ aliases:
<a href="/developers/yaml-reference/events/">Events YAML Runner &rarr;</a><br>
<a href="/developers/yaml-reference/locations/">Locations YAML Runner &rarr;</a><br>
<a href="/developers/yaml-reference/subjects/">Subjects YAML Runner &rarr;</a><br>
<a href="/developers/yaml-reference/compliance/">Compliance Policies YAML Runner &rarr;</a><br>
<a href="/developers/yaml-reference/estate-info/">Estate Information YAML Runner &rarr;</a></p>
</div>
</div>
7 changes: 4 additions & 3 deletions content/developers/yaml-reference/assets/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ date: 2021-06-09T11:39:03+01:00
lastmod: 2021-06-09T11:39:03+01:00
draft: false
images: []
menu:
menu:
developers:
parent: "yaml-reference"
weight: 202
toc: true
aliases:
aliases:
- /docs/yaml-reference/assets/
---

Expand All @@ -23,7 +23,8 @@ aliases:

## Assets Create

Adding an `asset_label` allows your Asset to be referenced in later steps of the story. For example, if you want to add a Compliance Policy for the Asset after it is created.
Adding an `asset_label` allows your Asset to be referenced in later steps of the story.
For example, when you want to add an Event to the Asset after it is created.

The `arc_namespace` (for the Asset) and the `namespace` (for the location) are used to distinguish between Assets and Locations created between runs of the story. Usually, these field values are derived from an environment variable `ARCHIVIST_NAMESPACE` (default value is namespace).

Expand Down
Loading