Skip to content

Releases: gosqasorg/asset-provenance-tracking

API v0.2-α

03 Nov 13:35
@paulErdos paulErdos
API-v0.2-α
fa533d0
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

Choose a tag to compare

View all tags
API v0.2-α Latest
Latest

API v0.2 alpha: Release, Quickstart, and Walkthrough

The GOSQAS Collaboration are excited to release a major update. Our API is more real than ever.

final draft 4

Disclaimer

This release contains production-ready example code to help users get started using the GDT API. These examples are not intended to be exhaustive, and are intended rather to illustrate concepts to help orgs understand how to create internal tooling to meet their bespoke needs.

The unofficial community SDK is here.

Features + Scope

Our fundamental source of truth are our tests. They are here.

Supported Features

Creating

  • New Device ID Keys
  • Records, with: Name, Description, Tags
  • Groups, with: Name, Description, Tags

Updating

  • Records + Individual Group Member Record History Updates, with: Description, Tags

Reading

  • Records, with: Name, Description, Tags
  • Individual Group Member Records, with: : Name, Description, Tags

Notes

  • Bulk creation of groups is limited to 500 items. Contact us if you need more.

Quickstart

Fork and clone the community sdk.

How To Write Code That Uses The GDT API.

The best way to use our API is to follow our tests. These are our primary source of truth. Notice the similarity here between one of the record creation tests and the Community SDK's createSimpleRecord function.

Most of the heavy lifting has already been done, and nearly all of our test code can be lifted and used to create tools that perform the same operations validated by our tests. Of course, some adjustment is needed, e.g., test-specific functions like expect(), describe(), and it() are part of the vitest library and are not needed to use our API.

Screenshot 2025-11-03 at 05 12 26

If there's something you want to do, the first thing to do is look it up in our tests.

Assets 2
Loading

API v0.1-α

11 Oct 00:39
@paulErdos paulErdos
API-v0.1-α
b0415dd
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

Choose a tag to compare

View all tags
API v0.1-α

API v0.1 alpha: Release, Quickstart, and Walkthrough

GOSQAS Engineering are proud to announce the the very first preview of our GDT API. We have a lot in store for our next several releases, broader documentation, and code examples.

This quickstart guide and walkthrough is intended to be accessible by a broad audience. Some computer literacy is assumed: being able to open a terminal, and create a text document using the editor of your choice is all that's needed. Node is assumed to be installed.

Key takeaways intended are the classic API notes: how to use our API, and what the output data will look like. To make this preview extra special we've bundled it in an example kit you can use for real.

Screenshot_2025-10-20_16_47_54

Quickstart Guide

To get started, follow these steps. For visual learners, the screenshot below shows these steps.

  1. Open a terminal, create a new text document, copy the code below, paste, save as "read-record.js", quit.
  2. Make executable by chmod +x read-record.js
  3. If you run it wrong it will tell you how to use it, so run it wrong by ./read-record.js
  4. The example it prints is a real record id that we actively use in API testing. Copy and paste that.
  5. Peruse the data. You will see friendly log messages from our excellent devs.
#!/usr/bin/env node

if (process.argv.length !== 3) {
    console.error('Usage: ./read-record.js <record_id>');
    console.info('Example: ./read-record.js Ra1rnStUK7CctNehGVWtDa')
    process.exit(1);
}

const recordId = process.argv[2];

async function main(recordId) {
    var response = await fetch(`https://gdtprodbackend.azurewebsites.net/api/provenance/${recordId}`)
    return await response.json();
}

var data = await main(recordId)
console.info(data)

Visual Quickstart

503428313-6e6735de-7d1c-41be-8f74-56b7455c2cf4-1

Final Thoughts

This script will read any GDT record; all that's needed is the key. Use it in testing or in production.

What's Changed

Read more

Contributors

devhawk, RobertLRead, and 18 other contributors
Loading