Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API ref pages update #787

Merged
merged 3 commits into from
Mar 11, 2024
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions content/developers/api-reference/attachments-api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,3 +79,4 @@ The response will include basic information about the attachment:
## Attachment OpenAPI Docs

{{< openapi url="https://raw.githubusercontent.com/datatrails/datatrails-openapi/master/doc/attachmentsv2.swagger.json" >}}
{{< openapi url="https://raw.githubusercontent.com/datatrails/datatrails-openapi/master/doc/publicattachmentsv2.swagger.json" >}}
58 changes: 58 additions & 0 deletions content/developers/api-reference/caps-api/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
title: "Caps API"
description: "Caps API Reference"
lead: "Caps API Reference"
date: 2024-03-05T11:30:29Z
lastmod: 2024-03-05T11:30:29Z
draft: false
images: []
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.

Additional YAML examples can be found in the articles in the [Overview](/platform/overview/introduction/) section.
{{< /note >}}
## Caps API Examples

The Caps API enables you to check the resource limits remaining under your Tenancy subscription.

### Retrieve a Cap

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"
```

The response is:

```json
{
"caps": [
{
"resource_type": "AccessPolicies",
"resource_remaining": "6"
}
]
}
```
These are the available values for "**?service=**":
* access_policies
* applications
* assets
* blobs
* compliance_policies
* locations
* tenancies/users


## Caps OpenAPI Docs
{{< openapi url="https://raw.githubusercontent.com/datatrails/datatrails-openapi/master/doc/capsv1.swagger.json" >}}
134 changes: 0 additions & 134 deletions content/developers/api-reference/invites-api/index.md

This file was deleted.

172 changes: 0 additions & 172 deletions content/developers/api-reference/tls-ca-certificates-api/index.md

This file was deleted.