Skip to content

Commit 6d2a5a1

Browse files
committed
Remove locations API
fixes AB#10635
1 parent 8d95309 commit 6d2a5a1

29 files changed

Lines changed: 74 additions & 774 deletions

File tree

content/developers/api-reference/_index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@ aliases:
2323
<a href="/developers/api-reference/events-api/">Events API &rarr;</a><br>
2424
<a href="/developers/api-reference/iam-policies-api/">IAM Policies API &rarr;</a><br>
2525
<a href="/developers/api-reference/iam-subjects-api/">IAM Subjects API &rarr;</a><br>
26-
<a href="/developers/api-reference/locations-api/">Locations API &rarr;</a><br>
2726
<a href="/developers/api-reference/members-api/">Members API &rarr;</a></p>
2827
<a href="/developers/api-reference/public-assets-api/">Public Assets API &rarr;</a><br>
2928
<a href="/developers/api-reference/tenancies-api/">Tenancies API &rarr;</a><br>

content/developers/api-reference/caps-api/index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,6 @@ These are the available values for "**?service=**":
4949
* applications
5050
* assets
5151
* blobs
52-
* locations
5352
* members
5453

5554

content/developers/api-reference/iam-policies-api/index.md

Lines changed: 3 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@ menu:
1111
parent: "api-reference"
1212
weight: 115
1313
toc: true
14-
aliases:
14+
aliases:
1515
- /docs/api-reference/iam-policies-api/
1616
---
1717
{{< note >}}
18-
**Note:** This page is primarily intended for developers who will be writing applications that will use DataTrails for provenance.
19-
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.
18+
**Note:** This page is primarily intended for developers who will be writing applications that will use DataTrails for provenance.
19+
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.
2020

2121
Additional YAML examples can be found in the articles in the [Overview](/platform/overview/introduction/) section.
2222
{{< /note >}}
@@ -103,10 +103,6 @@ The response is:
103103
"display_name": "Friendly name of the policy",
104104
"description": "Description of the policy",
105105
"filters": [
106-
{"or": [
107-
"attributes.arc_home_location_identity=locations/5ea815f0-4de1-4a84-9377-701e880fe8ae",
108-
"attributes.arc_home_location_identity=locations/27eed70b-9e2b-4db1-b8c4-e36505350dcc"
109-
]},
110106
{"or": [
111107
"attributes.arc_display_type=Valve",
112108
"attributes.arc_display_type=Pump"
@@ -187,10 +183,6 @@ Each of these calls returns a list of matching IAM Access Policies records in th
187183
"display_name": "Name to display",
188184
"description": "Description of the policy",
189185
"filters": [
190-
{"or": [
191-
"attributes.arc_home_location_identity=locations/5ea815f0-4de1-4a84-9377-701e880fe8ae",
192-
"attributes.arc_home_location_identity=locations/27eed70b-9e2b-4db1-b8c4-e36505350dcc"
193-
]},
194186
{"or": [
195187
"attributes.arc_display_type=Valve",
196188
"attributes.arc_display_type=Pump"
@@ -269,10 +261,6 @@ Define the Access Policy parameters to be changed and store in `/path/to/jsonfil
269261
```json
270262
{
271263
"filters": [
272-
{"or": [
273-
"attributes.arc_home_location_identity=locations/5ea815f0-4de1-4a84-9377-701e880fe8ae",
274-
"attributes.arc_home_location_identity=locations/27eed70b-9e2b-4db1-b8c4-e36505350dcc"
275-
]},
276264
{"or": [
277265
"attributes.arc_display_type=Valve",
278266
"attributes.arc_display_type=Pump"
@@ -319,10 +307,6 @@ The response is:
319307
"display_name": "Friendly name of the policy",
320308
"description": "Description of the policy",
321309
"filters": [
322-
{"or": [
323-
"attributes.arc_home_location_identity=locations/5ea815f0-4de1-4a84-9377-701e880fe8ae",
324-
"attributes.arc_home_location_identity=locations/27eed70b-9e2b-4db1-b8c4-e36505350dcc"
325-
]},
326310
{"or": [
327311
"attributes.arc_display_type=Valve",
328312
"attributes.arc_display_type=Pump"
@@ -384,7 +368,6 @@ Each of these calls returns a list of matching Asset records in the form:
384368
"attributes": {
385369
"arc_display_type": "Pump",
386370
"arc_firmware_version": "1.0",
387-
"arc_home_location_identity": "locations/866790d8-4ed6-4cc9-8f60-07672609b331",
388371
"arc_serial_number": "vtl-x4-07",
389372
"arc_description": "Pump at A603 North East",
390373
"arc_display_name": "tcl.ccj.003",
@@ -424,10 +407,6 @@ Each of these calls returns a list of matching IAM `access_policies` records in
424407
"identity": "access_policies/6a951b62-0a26-4c22-a886-1082297b063b",
425408
"display_name": "Some description",
426409
"filters": [
427-
{ "or": [
428-
"attributes.arc_home_location_identity=locations/5ea815f0-4de1-4a84-9377-701e880fe8ae",
429-
"attributes.arc_home_location_identity=locations/27eed70b-9e2b-4db1-b8c4-e36505350dcc",
430-
]},
431410
{ "or": [
432411
"attributes.arc_display_type=Valve",
433412
"attributes.arc_display_type=Pump"

content/developers/api-reference/locations-api/index.md

Lines changed: 0 additions & 137 deletions
This file was deleted.

content/developers/developer-patterns/getting-access-tokens-using-app-registrations/index.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ date: 2021-06-16T11:12:25+01:00
66
lastmod: 2023-09-27T11:12:25+01:00
77
draft: false
88
images: []
9-
menu:
9+
menu:
1010
developers:
1111
parent: "developer-patterns"
1212
weight: 31
@@ -17,7 +17,7 @@ aliases:
1717
---
1818

1919
Non-interactive access to the DataTrails platform is managed by creating `Integrations` with either a Custom Integration or one of the built-in Integrations. This is done from the `Integrations` page in the DataTrails UI (reachable
20-
from the `Settings` page or the `Integrations` shortcut in the sidebar.) You can also do this via
20+
from the `Settings` page or the `Integrations` shortcut in the sidebar.) You can also do this via
2121
the App Registrations REST API.
2222

2323
{{< note >}}
@@ -40,7 +40,7 @@ The high level steps are:
4040
If you have already saved a `CLIENT_ID` and a `SECRET`, with the correct [permissions applied](#grant-permissions-to-custom-integration), skip to [Getting a Token With the Custom Integration](#getting-a-token-with-the-custom-integration)
4141

4242
{{< note >}}
43-
**Note:** Creating App Registrations requires **Owner** privileges.
43+
**Note:** Creating App Registrations requires **Owner** privileges.
4444
If `Settings` or `Integrations` does not appear in the navigation, see your DataTrails Administrator for access.
4545
{{< /note >}}
4646

@@ -57,17 +57,17 @@ If `Settings` or `Integrations` does not appear in the navigation, see your Data
5757
**Note:** Optionally add any `Custom claims` at this step by clicking the `+ Add` button.<br>In this context, claims are pieces of information that are asserted in a JSON Web Token (JWT). *Registered* claims are name/value pairs that are defined by the JWT standard, *Custom* claims are not defined and can have any name/value combination.
5858

5959
Ensure the `Name` *does not start* with `jit_` or `arc_` (DataTrails reserved names) or use any other well-known reserved claims.
60-
60+
6161
See [here](https://auth0.com/docs/security/tokens/json-web-tokens/json-web-token-claims#reserved-claims) for more information on JWT Claims
62-
{{< /note >}}
63-
1. If this Custom Integration should have administrator privileges, assign it the `Owner` role by
62+
{{< /note >}}
63+
1. If this Custom Integration should have administrator privileges, assign it the `Owner` role by
6464
checking that option. If you do this, ensure the client credentials are securely protected.
6565
1. Once complete, click `Confirm` to complete the custom integration
6666
1. You will then be presented with the `CLIENT_ID` and `SECRET` required by the archivist token endpoint
6767
{{< img src="RecordClientIDandSecret.png" alt="Rectangle" caption="<em>Record your Client ID and Secret</em>" class="border-0" >}}
6868
{{< caution >}}
6969
**Caution:** Save the `CLIENT_ID` and `SECRET` to a password manager or secret management service as the `SECRET` can **not** be viewed again. A new `SECRET` can be regenerated in the Integration configuration screen but this replaces and invalidates the previous `SECRET`.
70-
{{< /caution >}}
70+
{{< /caution >}}
7171

7272
### Grant Access Permissions to your Custom Integration
7373

@@ -133,7 +133,7 @@ Having completed the steps to create a [custom integration](./#creating-a-custom
133133
# in an `./datatrails/` directory
134134
mkdir -p $HOME/.datatrails
135135
chmod 0700 $HOME/.datatrails
136-
136+
137137
# Create the Bearer Token
138138
echo Authorization: Bearer $TOKEN > $HOME/.datatrails/bearer-token.txt
139139
cat $HOME/.datatrails/bearer-token.txt
@@ -178,7 +178,6 @@ If you have existing assets, the output will be similar to:
178178
"arc_description": "A shipping container being tracked",
179179
"arc_display_name": "New Shipping Container #1",
180180
"arc_display_type": "Shipping Container",
181-
"arc_home_location_identity": "locations/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
182181
"height": "8'"
183182
},
184183
"confirmation_status": "COMMITTED",

content/developers/yaml-reference/_index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@ aliases:
1919
<p><a href="/developers/yaml-reference/story-runner-components/">YAML Runner Components &rarr;</a><br>
2020
<a href="/developers/yaml-reference/assets/">Assets YAML Runner &rarr;</a><br>
2121
<a href="/developers/yaml-reference/events/">Events YAML Runner &rarr;</a><br>
22-
<a href="/developers/yaml-reference/locations/">Locations YAML Runner &rarr;</a><br>
2322
<a href="/developers/yaml-reference/subjects/">Subjects YAML Runner &rarr;</a><br>
2423
<a href="/developers/yaml-reference/estate-info/">Estate Information YAML Runner &rarr;</a></p>
2524
</div>

content/developers/yaml-reference/assets/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ aliases:
2626
Adding an `asset_label` allows your Asset to be referenced in later steps of the story.
2727
For example, when you want to add an Event to the Asset after it is created.
2828

29-
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).
29+
The `arc_namespace` is used to distinguish between Assets created between runs of the story. Usually, these field values are derived from an environment variable `ARCHIVIST_NAMESPACE` (default value is namespace).
3030

3131
The optional `confirm: true` entry means that the YAML Runner will wait for the Asset to be committed before moving on to the next step. This is beneficial if the Asset will be referenced in later steps.
3232

content/developers/yaml-reference/estate-info/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ date: 2021-06-09T11:39:03+01:00
66
lastmod: 2021-06-09T11:39:03+01:00
77
draft: false
88
images: []
9-
menu:
9+
menu:
1010
developers:
1111
parent: "yaml-reference"
1212
weight: 207
1313
toc: true
14-
aliases:
14+
aliases:
1515
- /docs/yaml-reference/estate-info/
1616
---
1717

@@ -23,7 +23,7 @@ aliases:
2323

2424
## Composite Estate Info
2525

26-
This action returns a report on the current number of Assets, Events, and locations in your DataTrails estate.
26+
This action returns a report on the current number of Assets and Events in your DataTrails estate.
2727

2828
```yaml
2929
---

content/developers/yaml-reference/events/index.md

Lines changed: 2 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ aliases:
2525

2626
The `asset_label` must match the setting when the Asset was created in an earlier step. The `asset_label` may also be specified as the Asset ID of an existing Asset, in the form `assets/<asset-id>`.
2727

28-
There are a few optional settings that can be used when creating Events. `attachments` uploads the attachment to DataTrails and the response is added to the Event before posting. `location` creates the location if it does not exist and adds it to the Event. The `sbom` setting uploads the SBOM to DataTrails and adds the response to the Event before posting.
28+
There are a few optional settings that can be used when creating Events. `attachments` uploads the attachment to DataTrails and the response is added to the Event before posting. The `sbom` setting uploads the SBOM to DataTrails and adds the response to the Event before posting.
2929

3030
`confirm: true` tells the YAML Runner to wait for the Event to be committed before moving to the next step.
3131
This is optional and only necessary if your workflow requires 3rd parties (public or other DataTrails tenancies) to immediately view the Event.
@@ -49,26 +49,13 @@ steps:
4949
arc_evidence: ARQC 0x12345678
5050
wavestone_door_name: Courts of Justice Paris Front Door
5151
wavestone_evt_type: door_open
52-
location:
53-
selector:
54-
- display_name
55-
- attributes:
56-
- namespace
57-
display_name: Paris Courts of Justice
58-
description: Public museum in the former Palais de Justice
59-
latitude: 48.855722
60-
longitude: 2.345051
61-
attributes:
62-
namespace: door entry
63-
address: 10 Boulevard du Palais, 75001 Paris, France
64-
wavestone_ext: managed
6552
attachments:
6653
- filename: functests/test_resources/doors/events/door_open.png
6754
content_type: image/png
6855
confirm: false
6956
```
7057
71-
This example creates an Event with custom Event attributes, creates and adds a location, and adds an image attachment.
58+
This example creates an Event with custom Event attributes, and adds an image attachment.
7259
7360
Events may also be used to release a software package as an SBOM, such as the example below:
7461

0 commit comments

Comments
 (0)