chore(docs): add `docusaurus-plugin-openapi-docs` by b-long · Pull Request #110 · opentdf/docs

b-long · 2025-06-11T15:18:53Z

This PR is a recreation of #109 .

Description

The goal of this PR is to enrich our docusaurus site, by adding docusaurus-openapi-docs and using it to embed OpenAPI/Swagger generated content.

In this PR, we are vendoring the OpenAPI (YAML) files, which are found in OpenTDF ( here ).

Reviewing this PR

To generate the site for a typical deployment, build and start the site as follows:

# Set env var, or simply skip it
export BUILD_OPENAPI_SAMPLES=0
rm -rf docs/SDK-OpenAPI/ docs/SDK-Samples/ specs-processed/
npm run gen-api-docs-clean && npm run gen-api-docs-all
npm run start

To generate the site including "art of the possible" (petstore & bookstore examples), build and start the site as follows:

export BUILD_OPENAPI_SAMPLES=1 
rm -rf docs/SDK-OpenAPI/ docs/SDK-Samples/ specs-processed/
npm run gen-api-docs-clean && npm run gen-api-docs-all
npm run start

Video 2 (loom)

https://www.loom.com/share/522b0eb6b2d34793ba555b1ca3a31722

Video 1

Click to show

Screen.Recording.2025-06-11.at.12.36.53.PM.mov

### To-do

Determine if we need to run npm run gen-api-docs-all (explicitly) for CI and/or production builds. In other words, does this happen automatically?

Defer / New Jira tickets

Revert Disable false-positive machine / figure out the right way to tune Vale ➡️ recommend a new Jira ticket / PR
Use remote OpenAPI definition files? ➡️ recommend a new Jira ticket / PR

Vale

If I were king for a day, I'd just remove this tool.

It's pretty unclear (to me) how to improve the configuration quality

It's complaining about files that are untouched / unmodified in this PR

And some part of it's machinery / reviewdog thinks we have too much content to process... which seems tricky, because clearly we will have large diffs if we intend to version generated content.

…docs'

This reverts commit d228655.

Copilot

Pull Request Overview

This PR adds the docusaurus-plugin-openapi-docs and vendors OpenAPI specification files to generate API docs within the Docusaurus site.

Vendors OpenAPI YAML specs for policy, entityresolution, entity, and common components
Introduces preprocessing.ts to normalize/spec-augment the OpenAPI files before Docusaurus builds
Updates package.json and docusaurus.config.ts to install/configure the plugin and theme

Reviewed Changes

Copilot reviewed 27 out of 27 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
specs/policy/selectors.openapi.yaml	New OpenAPI schema for policy selectors
specs/entityresolution/v2/entity_resolution.openapi.yaml	New OpenAPI schema for entity resolution v2
specs/entity/entity.openapi.yaml	New OpenAPI schema for entity components
specs/common/common.openapi.yaml	New OpenAPI schema for common components
preprocessing.ts	Script to preprocess and relocate specs for plugin consumption
package.json	Added plugin/theme dependencies and scripts for API docs gen
openapi-generated-clients.ts	Defines language tabs configuration for OpenAPI client examples
docusaurus.config.ts	Configures OpenAPI plugin, theme, and language tabs in Docusaurus

cassandrabailey293 · 2025-06-12T15:01:15Z

I was able to get the site up and running with the instructions above 🎉

for these example request/response sections, maybe there is an option to either disable the "Send API request", or allow you to change the params? I wanted to try it out but it wouldnt let me edit the platform URL. @b-long lemme know your thoughts.

b-long · 2025-06-12T15:39:39Z

Good flag, I meant to fix that earlier @cassandrabailey293 .

Fixed!

Screen.Recording.2025-06-12.at.11.37.27.AM.mov

updates the api sidebars and removes unused sections, consolidates authorization and entity resolution <img width="300" alt="Screenshot 2025-06-12 at 1 11 02 PM" src="https://github.com/user-attachments/assets/9798441e-ceed-411e-aba7-d5f0d635d54e" />

changed `tag` to `info` per the openapi [docusaurus plugin config](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs?tab=readme-ov-file#sidebaroptions) and removed npm job / js script for it

Small follow-up PR to #110 Display new content on the (live) site, and rename the prefix to distinguish that these aren't _**truly**_ SDKs. <img width="2032" alt="image" src="https://github.com/user-attachments/assets/2333fc33-3795-4cbe-811e-f7c1484ab457" />

The `vale` tool was disabled in #110 , this PR reverts that change. Co-authored-by: Ryan Schumacher <jschumacher@virtru.com>

commit 3a9aa86 Author: Chris Reed <87077975+c-r33d@users.noreply.github.com> Date: Tue Aug 12 07:44:59 2025 -0500 fix(policy): Update key management docs. (#141) 1.) Update documentation around key management. Removing the idea that a root key is needed with keys of mode **remote**. --------- Co-authored-by: Jp Ayyappan <108297634+jp-ayyappan@users.noreply.github.com> commit b685b63 Author: Mike Jensen <jentfoo@users.noreply.github.com> Date: Mon Aug 11 18:44:54 2025 -0600 LICENSE as CC-BY-SA 4.0 (#137) After legal review it was determined we want to use the Creative Commons Attribution 4.0 license. This updates the license file from the template example here: https://github.com/jslicense/CC-BY-SA-4.0/blob/main/CC-BY-SA-4.0 Once approved and merged, the current plan is to remove the prior LICENSE commit through a force push of a squashed commit, this will prevent having the prior history of the docs being incorrectly licensed. commit 9f4e7b9 Author: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Date: Thu Aug 7 11:52:03 2025 -0600 chore(deps): bump form-data from 4.0.0 to 4.0.4 (#139) Bumps [form-data](https://github.com/form-data/form-data) from 4.0.0 to 4.0.4. <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/form-data/form-data/releases">form-data's releases</a>.</em></p> <blockquote> <h2>v4.0.4</h2> <h2><a href="https://github.com/form-data/form-data/compare/v4.0.3...v4.0.4">v4.0.4</a> - 2025-07-16</h2> <h3>Commits</h3> <ul> <li>[meta] add <code>auto-changelog</code> <a href="https://github.com/form-data/form-data/commit/811f68282fab0315209d0e2d1c44b6c32ea0d479"><code>811f682</code></a></li> <li>[Tests] handle predict-v8-randomness failures in node < 17 and node > 23 <a href="https://github.com/form-data/form-data/commit/1d11a76434d101f22fdb26b8aef8615f28b98402"><code>1d11a76</code></a></li> <li>[Fix] Switch to using <code>crypto</code> random for boundary values <a href="https://github.com/form-data/form-data/commit/3d1723080e6577a66f17f163ecd345a21d8d0fd0"><code>3d17230</code></a></li> <li>[Tests] fix linting errors <a href="https://github.com/form-data/form-data/commit/5e340800b5f8914213e4e0378c084aae71cfd73a"><code>5e34080</code></a></li> <li>[meta] actually ensure the readme backup isn’t published <a href="https://github.com/form-data/form-data/commit/316c82ba93fd4985af757b771b9a1f26d3b709ef"><code>316c82b</code></a></li> <li>[Dev Deps] update <code>@ljharb/eslint-config</code> <a href="https://github.com/form-data/form-data/commit/58c25d76406a5b0dfdf54045cf252563f2bbda8d"><code>58c25d7</code></a></li> <li>[meta] fix readme capitalization <a href="https://github.com/form-data/form-data/commit/2300ca19595b0ee96431e868fe2a40db79e41c61"><code>2300ca1</code></a></li> </ul> <h2>v4.0.3</h2> <h2><a href="https://github.com/form-data/form-data/compare/v4.0.2...v4.0.3">v4.0.3</a> - 2025-06-05</h2> <h3>Fixed</h3> <ul> <li>[Fix] <code>append</code>: avoid a crash on nullish values <a href="https://redirect.github.com/form-data/form-data/issues/577"><code>[#577](https://github.com/form-data/form-data/issues/577)</code></a></li> </ul> <h3>Commits</h3> <ul> <li>[eslint] use a shared config <a href="https://github.com/form-data/form-data/commit/426ba9ac440f95d1998dac9a5cd8d738043b048f"><code>426ba9a</code></a></li> <li>[eslint] fix some spacing issues <a href="https://github.com/form-data/form-data/commit/20941917f0e9487e68c564ebc3157e23609e2939"><code>2094191</code></a></li> <li>[Refactor] use <code>hasown</code> <a href="https://github.com/form-data/form-data/commit/81ab41b46fdf34f5d89d7ff30b513b0925febfaa"><code>81ab41b</code></a></li> <li>[Fix] validate boundary type in <code>setBoundary()</code> method <a href="https://github.com/form-data/form-data/commit/8d8e4693093519f7f18e3c597d1e8df8c493de9e"><code>8d8e469</code></a></li> <li>[Tests] add tests to check the behavior of <code>getBoundary</code> with non-strings <a href="https://github.com/form-data/form-data/commit/837b8a1f7562bfb8bda74f3fc538adb7a5858995"><code>837b8a1</code></a></li> <li>[Dev Deps] remove unused deps <a href="https://github.com/form-data/form-data/commit/870e4e665935e701bf983a051244ab928e62d58e"><code>870e4e6</code></a></li> <li>[meta] remove local commit hooks <a href="https://github.com/form-data/form-data/commit/e6e83ccb545a5619ed6cd04f31d5c2f655eb633e"><code>e6e83cc</code></a></li> <li>[Dev Deps] update <code>eslint</code> <a href="https://github.com/form-data/form-data/commit/4066fd6f65992b62fa324a6474a9292a4f88c916"><code>4066fd6</code></a></li> <li>[meta] fix scripts to use prepublishOnly <a href="https://github.com/form-data/form-data/commit/c4bbb13c0ef669916657bc129341301b1d331d75"><code>c4bbb13</code></a></li> </ul> <h2>v4.0.2</h2> <h2><a href="https://github.com/form-data/form-data/compare/v4.0.1...v4.0.2">v4.0.2</a> - 2025-02-14</h2> <h3>Merged</h3> <ul> <li>[Fix] set <code>Symbol.toStringTag</code> when available <a href="https://redirect.github.com/form-data/form-data/pull/573"><code>[#573](https://github.com/form-data/form-data/issues/573)</code></a></li> <li>[Fix] set <code>Symbol.toStringTag</code> when available <a href="https://redirect.github.com/form-data/form-data/pull/573"><code>[#573](https://github.com/form-data/form-data/issues/573)</code></a></li> <li>fix (npmignore): ignore temporary build files <a href="https://redirect.github.com/form-data/form-data/pull/532"><code>[#532](https://github.com/form-data/form-data/issues/532)</code></a></li> <li>fix (npmignore): ignore temporary build files <a href="https://redirect.github.com/form-data/form-data/pull/532"><code>[#532](https://github.com/form-data/form-data/issues/532)</code></a></li> </ul> <h3>Fixed</h3> <ul> <li>[Fix] set <code>Symbol.toStringTag</code> when available (<a href="https://redirect.github.com/form-data/form-data/issues/573">#573</a>) <a href="https://redirect.github.com/form-data/form-data/issues/396"><code>[#396](https://github.com/form-data/form-data/issues/396)</code></a></li> <li>[Fix] set <code>Symbol.toStringTag</code> when available (<a href="https://redirect.github.com/form-data/form-data/issues/573">#573</a>) <a href="https://redirect.github.com/form-data/form-data/issues/396"><code>[#396](https://github.com/form-data/form-data/issues/396)</code></a></li> <li>[Fix] set <code>Symbol.toStringTag</code> when available <a href="https://redirect.github.com/form-data/form-data/issues/396"><code>[#396](https://github.com/form-data/form-data/issues/396)</code></a></li> </ul> <h3>Commits</h3>  </blockquote> <p>... (truncated)</p> </details> <details> <summary>Changelog</summary> <p><em>Sourced from <a href="https://github.com/form-data/form-data/blob/master/CHANGELOG.md">form-data's changelog</a>.</em></p> <blockquote> <h2><a href="https://github.com/form-data/form-data/compare/v4.0.3...v4.0.4">v4.0.4</a> - 2025-07-16</h2> <h3>Commits</h3> <ul> <li>[meta] add <code>auto-changelog</code> <a href="https://github.com/form-data/form-data/commit/811f68282fab0315209d0e2d1c44b6c32ea0d479"><code>811f682</code></a></li> <li>[Tests] handle predict-v8-randomness failures in node < 17 and node > 23 <a href="https://github.com/form-data/form-data/commit/1d11a76434d101f22fdb26b8aef8615f28b98402"><code>1d11a76</code></a></li> <li>[Fix] Switch to using <code>crypto</code> random for boundary values <a href="https://github.com/form-data/form-data/commit/3d1723080e6577a66f17f163ecd345a21d8d0fd0"><code>3d17230</code></a></li> <li>[Tests] fix linting errors <a href="https://github.com/form-data/form-data/commit/5e340800b5f8914213e4e0378c084aae71cfd73a"><code>5e34080</code></a></li> <li>[meta] actually ensure the readme backup isn’t published <a href="https://github.com/form-data/form-data/commit/316c82ba93fd4985af757b771b9a1f26d3b709ef"><code>316c82b</code></a></li> <li>[Dev Deps] update <code>@ljharb/eslint-config</code> <a href="https://github.com/form-data/form-data/commit/58c25d76406a5b0dfdf54045cf252563f2bbda8d"><code>58c25d7</code></a></li> <li>[meta] fix readme capitalization <a href="https://github.com/form-data/form-data/commit/2300ca19595b0ee96431e868fe2a40db79e41c61"><code>2300ca1</code></a></li> </ul> <h2><a href="https://github.com/form-data/form-data/compare/v4.0.2...v4.0.3">v4.0.3</a> - 2025-06-05</h2> <h3>Fixed</h3> <ul> <li>[Fix] <code>append</code>: avoid a crash on nullish values <a href="https://redirect.github.com/form-data/form-data/issues/577"><code>[#577](https://github.com/form-data/form-data/issues/577)</code></a></li> </ul> <h3>Commits</h3> <ul> <li>[eslint] use a shared config <a href="https://github.com/form-data/form-data/commit/426ba9ac440f95d1998dac9a5cd8d738043b048f"><code>426ba9a</code></a></li> <li>[eslint] fix some spacing issues <a href="https://github.com/form-data/form-data/commit/20941917f0e9487e68c564ebc3157e23609e2939"><code>2094191</code></a></li> <li>[Refactor] use <code>hasown</code> <a href="https://github.com/form-data/form-data/commit/81ab41b46fdf34f5d89d7ff30b513b0925febfaa"><code>81ab41b</code></a></li> <li>[Fix] validate boundary type in <code>setBoundary()</code> method <a href="https://github.com/form-data/form-data/commit/8d8e4693093519f7f18e3c597d1e8df8c493de9e"><code>8d8e469</code></a></li> <li>[Tests] add tests to check the behavior of <code>getBoundary</code> with non-strings <a href="https://github.com/form-data/form-data/commit/837b8a1f7562bfb8bda74f3fc538adb7a5858995"><code>837b8a1</code></a></li> <li>[Dev Deps] remove unused deps <a href="https://github.com/form-data/form-data/commit/870e4e665935e701bf983a051244ab928e62d58e"><code>870e4e6</code></a></li> <li>[meta] remove local commit hooks <a href="https://github.com/form-data/form-data/commit/e6e83ccb545a5619ed6cd04f31d5c2f655eb633e"><code>e6e83cc</code></a></li> <li>[Dev Deps] update <code>eslint</code> <a href="https://github.com/form-data/form-data/commit/4066fd6f65992b62fa324a6474a9292a4f88c916"><code>4066fd6</code></a></li> <li>[meta] fix scripts to use prepublishOnly <a href="https://github.com/form-data/form-data/commit/c4bbb13c0ef669916657bc129341301b1d331d75"><code>c4bbb13</code></a></li> </ul> <h2><a href="https://github.com/form-data/form-data/compare/v4.0.1...v4.0.2">v4.0.2</a> - 2025-02-14</h2> <h3>Merged</h3> <ul> <li>[Fix] set <code>Symbol.toStringTag</code> when available <a href="https://redirect.github.com/form-data/form-data/pull/573"><code>[#573](https://github.com/form-data/form-data/issues/573)</code></a></li> <li>[Fix] set <code>Symbol.toStringTag</code> when available <a href="https://redirect.github.com/form-data/form-data/pull/573"><code>[#573](https://github.com/form-data/form-data/issues/573)</code></a></li> <li>fix (npmignore): ignore temporary build files <a href="https://redirect.github.com/form-data/form-data/pull/532"><code>[#532](https://github.com/form-data/form-data/issues/532)</code></a></li> <li>fix (npmignore): ignore temporary build files <a href="https://redirect.github.com/form-data/form-data/pull/532"><code>[#532](https://github.com/form-data/form-data/issues/532)</code></a></li> </ul> <h3>Fixed</h3> <ul> <li>[Fix] set <code>Symbol.toStringTag</code> when available (<a href="https://redirect.github.com/form-data/form-data/issues/573">#573</a>) <a href="https://redirect.github.com/form-data/form-data/issues/396"><code>[#396](https://github.com/form-data/form-data/issues/396)</code></a></li> <li>[Fix] set <code>Symbol.toStringTag</code> when available (<a href="https://redirect.github.com/form-data/form-data/issues/573">#573</a>) <a href="https://redirect.github.com/form-data/form-data/issues/396"><code>[#396](https://github.com/form-data/form-data/issues/396)</code></a></li> <li>[Fix] set <code>Symbol.toStringTag</code> when available <a href="https://redirect.github.com/form-data/form-data/issues/396"><code>[#396](https://github.com/form-data/form-data/issues/396)</code></a></li> </ul> <h3>Commits</h3> <ul> <li>Merge tags v2.5.3 and v3.0.3 <a href="https://github.com/form-data/form-data/commit/92613b9208556eb4ebc482fdf599fae111626fb6"><code>92613b9</code></a></li> <li>[Tests] migrate from travis to GHA <a href="https://github.com/form-data/form-data/commit/806eda77740e6e3c67c7815afb216f2e1f187ba5"><code>806eda7</code></a></li> <li>[Tests] migrate from travis to GHA <a href="https://github.com/form-data/form-data/commit/8fdb3bc6b5d001f8909a9fca391d1d1d97ef1d79"><code>8fdb3bc</code></a></li> </ul>  </blockquote> <p>... (truncated)</p> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/form-data/form-data/commit/41996f5ac73a867046d48512cab62e64fc846dad"><code>41996f5</code></a> v4.0.4</li> <li><a href="https://github.com/form-data/form-data/commit/316c82ba93fd4985af757b771b9a1f26d3b709ef"><code>316c82b</code></a> [meta] actually ensure the readme backup isn’t published</li> <li><a href="https://github.com/form-data/form-data/commit/2300ca19595b0ee96431e868fe2a40db79e41c61"><code>2300ca1</code></a> [meta] fix readme capitalization</li> <li><a href="https://github.com/form-data/form-data/commit/811f68282fab0315209d0e2d1c44b6c32ea0d479"><code>811f682</code></a> [meta] add <code>auto-changelog</code></li> <li><a href="https://github.com/form-data/form-data/commit/5e340800b5f8914213e4e0378c084aae71cfd73a"><code>5e34080</code></a> [Tests] fix linting errors</li> <li><a href="https://github.com/form-data/form-data/commit/1d11a76434d101f22fdb26b8aef8615f28b98402"><code>1d11a76</code></a> [Tests] handle predict-v8-randomness failures in node < 17 and node > 23</li> <li><a href="https://github.com/form-data/form-data/commit/58c25d76406a5b0dfdf54045cf252563f2bbda8d"><code>58c25d7</code></a> [Dev Deps] update <code>@ljharb/eslint-config</code></li> <li><a href="https://github.com/form-data/form-data/commit/3d1723080e6577a66f17f163ecd345a21d8d0fd0"><code>3d17230</code></a> [Fix] Switch to using <code>crypto</code> random for boundary values</li> <li><a href="https://github.com/form-data/form-data/commit/d8d67dc8ac79285154edf7d3f57dbab593b9a146"><code>d8d67dc</code></a> v4.0.3</li> <li><a href="https://github.com/form-data/form-data/commit/e6e83ccb545a5619ed6cd04f31d5c2f655eb633e"><code>e6e83cc</code></a> [meta] remove local commit hooks</li> <li>Additional commits viewable in <a href="https://github.com/form-data/form-data/compare/v4.0.0...v4.0.4">compare view</a></li> </ul> </details> <details> <summary>Maintainer changes</summary> <p>This version was pushed to npm by <a href="https://www.npmjs.com/~ljharb">ljharb</a>, a new releaser for form-data since your current version.</p> </details> <br /> [![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=form-data&package-manager=npm_and_yarn&previous-version=4.0.0&new-version=4.0.4)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show <dependency name> ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) You can disable automated security fix PRs for this repo from the [Security Alerts page](https://github.com/opentdf/docs/network/alerts). </details> Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> commit bec55be Author: Jeremy Haage <jeremy.haage@virtru.com> Date: Thu Aug 7 07:24:14 2025 -0700 Updates to the Getting-Started guide (#138) Includes the following updates: - Replaces deprecated `--action-standard DECRYPT` examples with `--action read` - Updates login command to match expected client-credentials arguments - Updates docker compose yaml to use generally available docker images to fix 403 forbidden errors on chainguard images - Adds support for Apple M4 chip users to the docker compose yaml - Adds a profile creation step and replaces usage of `--host` in the examples to `--profile` - Adds detailed steps for importing and trusting certificates commit 38d2951 Author: Jake Van Vorhis <83739412+jakedoublev@users.noreply.github.com> Date: Fri Aug 1 11:56:40 2025 -0700 fix(docs): cleanup auth service v2 docs (#135) Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> commit 8f43eb9 Author: Jp Ayyappan <108297634+jp-ayyappan@users.noreply.github.com> Date: Wed Jul 23 14:59:24 2025 -0400 Clarify wrapping key and root key terminology (#136) commit 75b6421 Author: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon Jul 21 09:55:21 2025 -0600 chore(deps): bump on-headers and compression (#134) Bumps [on-headers](https://github.com/jshttp/on-headers) and [compression](https://github.com/expressjs/compression). These dependencies needed to be updated together. Updates `on-headers` from 1.0.2 to 1.1.0 <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/jshttp/on-headers/releases">on-headers's releases</a>.</em></p> <blockquote> <h2>1.1.0</h2> <h2>Important</h2> <ul> <li>Fix <a href="https://www.cve.org/CVERecord?id=CVE-2025-7339">CVE-2025-7339</a> (<a href="https://github.com/jshttp/on-headers/security/advisories/GHSA-76c9-3jph-rj3q">GHSA-76c9-3jph-rj3q</a>)</li> </ul> <h2>What's Changed</h2> <ul> <li>Migrate CI pipeline to GitHub actions by <a href="https://github.com/carpasse"><code>@carpasse</code></a> in <a href="https://redirect.github.com/jshttp/on-headers/pull/12">jshttp/on-headers#12</a></li> <li>fix README.md badges by <a href="https://github.com/carpasse"><code>@carpasse</code></a> in <a href="https://redirect.github.com/jshttp/on-headers/pull/13">jshttp/on-headers#13</a></li> <li>add OSSF scorecard action by <a href="https://github.com/carpasse"><code>@carpasse</code></a> in <a href="https://redirect.github.com/jshttp/on-headers/pull/14">jshttp/on-headers#14</a></li> <li>fix: use <code>ubuntu-latest</code> as ci runner by <a href="https://github.com/UlisesGascon"><code>@UlisesGascon</code></a> in <a href="https://redirect.github.com/jshttp/on-headers/pull/19">jshttp/on-headers#19</a></li> <li>ci: apply OSSF Scorecard security best practices by <a href="https://github.com/UlisesGascon"><code>@UlisesGascon</code></a> in <a href="https://redirect.github.com/jshttp/on-headers/pull/20">jshttp/on-headers#20</a></li> <li>👷 add upstream change detection by <a href="https://github.com/ctcpip"><code>@ctcpip</code></a> in <a href="https://redirect.github.com/jshttp/on-headers/pull/31">jshttp/on-headers#31</a></li> <li>✨ add script to update known hashes by <a href="https://github.com/ctcpip"><code>@ctcpip</code></a> in <a href="https://redirect.github.com/jshttp/on-headers/pull/32">jshttp/on-headers#32</a></li> <li>💚 update CI - add newer node versions by <a href="https://github.com/ctcpip"><code>@ctcpip</code></a> in <a href="https://redirect.github.com/jshttp/on-headers/pull/33">jshttp/on-headers#33</a></li> </ul> <h2>New Contributors</h2> <ul> <li><a href="https://github.com/carpasse"><code>@carpasse</code></a> made their first contribution in <a href="https://redirect.github.com/jshttp/on-headers/pull/12">jshttp/on-headers#12</a></li> <li><a href="https://github.com/UlisesGascon"><code>@UlisesGascon</code></a> made their first contribution in <a href="https://redirect.github.com/jshttp/on-headers/pull/19">jshttp/on-headers#19</a></li> <li><a href="https://github.com/ctcpip"><code>@ctcpip</code></a> made their first contribution in <a href="https://redirect.github.com/jshttp/on-headers/pull/31">jshttp/on-headers#31</a></li> </ul> <p><strong>Full Changelog</strong>: <a href="https://github.com/jshttp/on-headers/compare/v1.0.2...v1.1.0">https://github.com/jshttp/on-headers/compare/v1.0.2...v1.1.0</a></p> </blockquote> </details> <details> <summary>Changelog</summary> <p><em>Sourced from <a href="https://github.com/jshttp/on-headers/blob/master/HISTORY.md">on-headers's changelog</a>.</em></p> <blockquote> <h1>1.1.0 / 2025-07-17</h1> <ul> <li>Fix <a href="https://www.cve.org/CVERecord?id=CVE-2025-7339">CVE-2025-7339</a> (<a href="https://github.com/jshttp/on-headers/security/advisories/GHSA-76c9-3jph-rj3q">GHSA-76c9-3jph-rj3q</a>)</li> </ul> </blockquote> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/jshttp/on-headers/commit/4b017af88f5375bbdf3ad2ee732d2c122e4f52b0"><code>4b017af</code></a> 1.1.0</li> <li><a href="https://github.com/jshttp/on-headers/commit/b636f2d08e6c1e0a784b53a13cd61e05c09bb118"><code>b636f2d</code></a> ♻️ refactor header array code</li> <li><a href="https://github.com/jshttp/on-headers/commit/3e2c2d46c3e9592f6a1c3a3a1dbe622401f95d39"><code>3e2c2d4</code></a> ✨ ignore falsy header keys, matching node behavior</li> <li><a href="https://github.com/jshttp/on-headers/commit/172eb41b99a5a290b27a2c43fe602ca33aa1c8ce"><code>172eb41</code></a> ✨ support duplicate headers</li> <li><a href="https://github.com/jshttp/on-headers/commit/c6e384908c9c6127d18831d16ab0bd96e1231867"><code>c6e3849</code></a> 🔒️ fix array handling</li> <li><a href="https://github.com/jshttp/on-headers/commit/6893518341bb4e5363285df086b3158302d3b216"><code>6893518</code></a> 💚 update CI - add newer node versions</li> <li><a href="https://github.com/jshttp/on-headers/commit/56a345d82b51a0dcb8d09f061f87b1fd1dc4c01e"><code>56a345d</code></a> ✨ add script to update known hashes</li> <li><a href="https://github.com/jshttp/on-headers/commit/175ab217155d525371a5416ff059f895a3a532a6"><code>175ab21</code></a> 👷 add upstream change detection (<a href="https://redirect.github.com/jshttp/on-headers/issues/31">#31</a>)</li> <li><a href="https://github.com/jshttp/on-headers/commit/ce0b2c8fcd313d38d3534fb731050dc16e105bf6"><code>ce0b2c8</code></a> ci: apply OSSF Scorecard security best practices (<a href="https://redirect.github.com/jshttp/on-headers/issues/20">#20</a>)</li> <li><a href="https://github.com/jshttp/on-headers/commit/1a38c543e75cd06217b449531de10b1758e35299"><code>1a38c54</code></a> fix: use <code>ubuntu-latest</code> as ci runner (<a href="https://redirect.github.com/jshttp/on-headers/issues/19">#19</a>)</li> <li>Additional commits viewable in <a href="https://github.com/jshttp/on-headers/compare/v1.0.2...v1.1.0">compare view</a></li> </ul> </details> <details> <summary>Maintainer changes</summary> <p>This version was pushed to npm by <a href="https://www.npmjs.com/~ulisesgascon">ulisesgascon</a>, a new releaser for on-headers since your current version.</p> </details> <br /> Updates `compression` from 1.7.4 to 1.8.1 <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/expressjs/compression/releases">compression's releases</a>.</em></p> <blockquote> <h2>v1.8.1</h2> <h2>What's Changed</h2> <ul> <li>fix(docs): update multiple links from http to https by <a href="https://github.com/Phillip9587"><code>@Phillip9587</code></a> in <a href="https://redirect.github.com/expressjs/compression/pull/222">expressjs/compression#222</a></li> <li>ci: add dependabot for github actions by <a href="https://github.com/bjohansebas"><code>@bjohansebas</code></a> in <a href="https://redirect.github.com/expressjs/compression/pull/207">expressjs/compression#207</a></li> <li>build(deps): bump github/codeql-action from 2.23.2 to 3.28.15 by <a href="https://github.com/dependabot"><code>@dependabot</code></a>[bot] in <a href="https://redirect.github.com/expressjs/compression/pull/228">expressjs/compression#228</a></li> <li>build(deps): bump ossf/scorecard-action from 2.3.1 to 2.4.1 by <a href="https://github.com/dependabot"><code>@dependabot</code></a>[bot] in <a href="https://redirect.github.com/expressjs/compression/pull/229">expressjs/compression#229</a></li> <li>build(deps-dev): bump eslint-plugin-import from 2.26.0 to 2.31.0 by <a href="https://github.com/dependabot"><code>@dependabot</code></a>[bot] in <a href="https://redirect.github.com/expressjs/compression/pull/230">expressjs/compression#230</a></li> <li>build(deps-dev): bump supertest from 6.2.3 to 6.3.4 by <a href="https://github.com/dependabot"><code>@dependabot</code></a>[bot] in <a href="https://redirect.github.com/expressjs/compression/pull/231">expressjs/compression#231</a></li> <li>[StepSecurity] ci: Harden GitHub Actions by <a href="https://github.com/step-security-bot"><code>@step-security-bot</code></a> in <a href="https://redirect.github.com/expressjs/compression/pull/235">expressjs/compression#235</a></li> <li>build(deps): bump github/codeql-action from 3.28.15 to 3.29.2 by <a href="https://github.com/dependabot"><code>@dependabot</code></a>[bot] in <a href="https://redirect.github.com/expressjs/compression/pull/243">expressjs/compression#243</a></li> <li>build(deps): bump actions/upload-artifact from 4.3.1 to 4.6.2 by <a href="https://github.com/dependabot"><code>@dependabot</code></a>[bot] in <a href="https://redirect.github.com/expressjs/compression/pull/239">expressjs/compression#239</a></li> <li>build(deps): bump ossf/scorecard-action from 2.4.1 to 2.4.2 by <a href="https://github.com/dependabot"><code>@dependabot</code></a>[bot] in <a href="https://redirect.github.com/expressjs/compression/pull/240">expressjs/compression#240</a></li> <li>build(deps): bump actions/checkout from 4.1.1 to 4.2.2 by <a href="https://github.com/dependabot"><code>@dependabot</code></a>[bot] in <a href="https://redirect.github.com/expressjs/compression/pull/241">expressjs/compression#241</a></li> <li>build(deps-dev): bump eslint-plugin-import from 2.31.0 to 2.32.0 by <a href="https://github.com/dependabot"><code>@dependabot</code></a>[bot] in <a href="https://redirect.github.com/expressjs/compression/pull/244">expressjs/compression#244</a></li> <li>deps: on-headers@1.1.0 by <a href="https://github.com/UlisesGascon"><code>@UlisesGascon</code></a> in <a href="https://redirect.github.com/expressjs/compression/pull/246">expressjs/compression#246</a></li> <li>Release: 1.8.1 by <a href="https://github.com/UlisesGascon"><code>@UlisesGascon</code></a> in <a href="https://redirect.github.com/expressjs/compression/pull/247">expressjs/compression#247</a></li> </ul> <h2>New Contributors</h2> <ul> <li><a href="https://github.com/dependabot"><code>@dependabot</code></a>[bot] made their first contribution in <a href="https://redirect.github.com/expressjs/compression/pull/228">expressjs/compression#228</a></li> <li><a href="https://github.com/step-security-bot"><code>@step-security-bot</code></a> made their first contribution in <a href="https://redirect.github.com/expressjs/compression/pull/235">expressjs/compression#235</a></li> </ul> <p><strong>Full Changelog</strong>: <a href="https://github.com/expressjs/compression/compare/1.8.0...v1.8.1">https://github.com/expressjs/compression/compare/1.8.0...v1.8.1</a></p> <h2>v1.8.0</h2> <h2>What's Changed</h2> <ul> <li>Refactor chunkLength function for improved readability and consistency by <a href="https://github.com/Ayoub-Mabrouk"><code>@Ayoub-Mabrouk</code></a> in <a href="https://redirect.github.com/expressjs/compression/pull/203">expressjs/compression#203</a></li> <li>Refactor toBuffer function to simplify buffer check logic by <a href="https://github.com/Ayoub-Mabrouk"><code>@Ayoub-Mabrouk</code></a> in <a href="https://redirect.github.com/expressjs/compression/pull/201">expressjs/compression#201</a></li> <li>ci: add CodeQL (SAST) by <a href="https://github.com/bjohansebas"><code>@bjohansebas</code></a> in <a href="https://redirect.github.com/expressjs/compression/pull/204">expressjs/compression#204</a></li> <li>Use headersSent instead of _header by <a href="https://github.com/maritz"><code>@maritz</code></a> in <a href="https://redirect.github.com/expressjs/compression/pull/129">expressjs/compression#129</a></li> <li>Bugfix/use write head instead of implicit header by <a href="https://github.com/Icehunter"><code>@Icehunter</code></a> in <a href="https://redirect.github.com/expressjs/compression/pull/170">expressjs/compression#170</a></li> <li>feat: add default option by <a href="https://github.com/bjohansebas"><code>@bjohansebas</code></a> in <a href="https://redirect.github.com/expressjs/compression/pull/191">expressjs/compression#191</a></li> <li>ci: update ci workflow by <a href="https://github.com/bjohansebas"><code>@bjohansebas</code></a> in <a href="https://redirect.github.com/expressjs/compression/pull/206">expressjs/compression#206</a></li> <li>feat: support for brotli by <a href="https://github.com/bjohansebas"><code>@bjohansebas</code></a> in <a href="https://redirect.github.com/expressjs/compression/pull/194">expressjs/compression#194</a></li> <li>docs: improve readme by <a href="https://github.com/bjohansebas"><code>@bjohansebas</code></a> in <a href="https://redirect.github.com/expressjs/compression/pull/209">expressjs/compression#209</a></li> <li>docs: keywords field by <a href="https://github.com/bjohansebas"><code>@bjohansebas</code></a> in <a href="https://redirect.github.com/expressjs/compression/pull/210">expressjs/compression#210</a></li> <li>refactor: simplify encoding negotiation logic by <a href="https://github.com/bjohansebas"><code>@bjohansebas</code></a> in <a href="https://redirect.github.com/expressjs/compression/pull/213">expressjs/compression#213</a></li> </ul> <h2>New Contributors</h2> <ul> <li><a href="https://github.com/Ayoub-Mabrouk"><code>@Ayoub-Mabrouk</code></a> made their first contribution in <a href="https://redirect.github.com/expressjs/compression/pull/203">expressjs/compression#203</a></li> <li><a href="https://github.com/maritz"><code>@maritz</code></a> made their first contribution in <a href="https://redirect.github.com/expressjs/compression/pull/129">expressjs/compression#129</a></li> <li><a href="https://github.com/Icehunter"><code>@Icehunter</code></a> made their first contribution in <a href="https://redirect.github.com/expressjs/compression/pull/170">expressjs/compression#170</a></li> </ul> <p><strong>Full Changelog</strong>: <a href="https://github.com/expressjs/compression/compare/1.7.5...v1.8.0">https://github.com/expressjs/compression/compare/1.7.5...v1.8.0</a></p> <h2>1.7.5</h2> <h2>What's Changed</h2> <ul> <li>chore: add support for OSSF scorecard reporting by <a href="https://github.com/inigomarquinez"><code>@inigomarquinez</code></a> in <a href="https://redirect.github.com/expressjs/compression/pull/186">expressjs/compression#186</a></li> <li>ci: fix errors in ci github action for node 8 and 9 by <a href="https://github.com/inigomarquinez"><code>@inigomarquinez</code></a> in <a href="https://redirect.github.com/expressjs/compression/pull/187">expressjs/compression#187</a></li> <li>docs: fix spelling by <a href="https://github.com/dijonkitchen"><code>@dijonkitchen</code></a> in <a href="https://redirect.github.com/expressjs/compression/pull/174">expressjs/compression#174</a></li> <li>deps: bytes@3.1.2 by <a href="https://github.com/bjohansebas"><code>@bjohansebas</code></a> in <a href="https://redirect.github.com/expressjs/compression/pull/192">expressjs/compression#192</a></li> </ul>  </blockquote> <p>... (truncated)</p> </details> <details> <summary>Changelog</summary> <p><em>Sourced from <a href="https://github.com/expressjs/compression/blob/master/HISTORY.md">compression's changelog</a>.</em></p> <blockquote> <h1>1.8.1 / 2025-07-17</h1> <ul> <li>deps: on-headers@~1.1.0 <ul> <li>Fix <a href="https://www.cve.org/CVERecord?id=CVE-2025-7339">CVE-2025-7339</a> (<a href="https://github.com/expressjs/on-headers/security/advisories/GHSA-76c9-3jph-rj3q">GHSA-76c9-3jph-rj3q</a>)</li> </ul> </li> </ul> <h1>1.8.0 / 2025-02-10</h1> <ul> <li>Use <code>res.headersSent</code> when available</li> <li>Replace <code>_implicitHeader</code> with <code>writeHead</code> property</li> <li>add brotli support for versions of node that support it</li> <li>Add the enforceEncoding option for requests without <code>Accept-Encoding</code> header</li> </ul> <h1>1.7.5 / 2024-10-31</h1> <ul> <li>deps: Replace accepts with negotiator@~0.6.4 <ul> <li>Add preference option</li> </ul> </li> <li>deps: bytes@3.1.2 <ul> <li>Add petabyte (<code>pb</code>) support</li> <li>Fix "thousandsSeparator" incorrecting formatting fractional part</li> <li>Fix return value for un-parsable strings</li> </ul> </li> <li>deps: compressible@~2.0.18 <ul> <li>Mark <code>font/ttf</code> as compressible</li> <li>Remove compressible from <code>multipart/mixed</code></li> <li>deps: mime-db@'>= 1.43.0 < 2'</li> </ul> </li> <li>deps: safe-buffer@5.2.1</li> </ul> </blockquote> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/expressjs/compression/commit/83a0c45fe190f4fcb8b515c18065db9cb9029dd1"><code>83a0c45</code></a> 1.8.1</li> <li><a href="https://github.com/expressjs/compression/commit/ce62713129f4b33eac4b833e1722410091646395"><code>ce62713</code></a> deps: on-headers@1.1.0 (<a href="https://redirect.github.com/expressjs/compression/issues/246">#246</a>)</li> <li><a href="https://github.com/expressjs/compression/commit/f4acb23985fa345318d34d4a96acf555a883efeb"><code>f4acb23</code></a> build(deps-dev): bump eslint-plugin-import from 2.31.0 to 2.32.0 (<a href="https://redirect.github.com/expressjs/compression/issues/244">#244</a>)</li> <li><a href="https://github.com/expressjs/compression/commit/6eaebe63f2ecac191d402c570bde140488435c4c"><code>6eaebe6</code></a> build(deps): bump actions/checkout from 4.1.1 to 4.2.2 (<a href="https://redirect.github.com/expressjs/compression/issues/241">#241</a>)</li> <li><a href="https://github.com/expressjs/compression/commit/37e062312fd270f84b5f50f7c6f88312609633f5"><code>37e0623</code></a> build(deps): bump ossf/scorecard-action from 2.4.1 to 2.4.2 (<a href="https://redirect.github.com/expressjs/compression/issues/240">#240</a>)</li> <li><a href="https://github.com/expressjs/compression/commit/bc436b26283c2f85a9711085dd0e4a580de50ba7"><code>bc436b2</code></a> build(deps): bump actions/upload-artifact from 4.3.1 to 4.6.2 (<a href="https://redirect.github.com/expressjs/compression/issues/239">#239</a>)</li> <li><a href="https://github.com/expressjs/compression/commit/2f9f5726751ecf12f7c46a9d1493bcd1966e09a7"><code>2f9f572</code></a> build(deps): bump github/codeql-action from 3.28.15 to 3.29.2 (<a href="https://redirect.github.com/expressjs/compression/issues/243">#243</a>)</li> <li><a href="https://github.com/expressjs/compression/commit/5f13b148d2a1a2daaa8647e03592214bb240bf18"><code>5f13b14</code></a> [StepSecurity] ci: Harden GitHub Actions (<a href="https://redirect.github.com/expressjs/compression/issues/235">#235</a>)</li> <li><a href="https://github.com/expressjs/compression/commit/76e094548125afbf8089a482d5982dc96c7ce398"><code>76e0945</code></a> build(deps-dev): bump supertest from 6.2.3 to 6.3.4 (<a href="https://redirect.github.com/expressjs/compression/issues/231">#231</a>)</li> <li><a href="https://github.com/expressjs/compression/commit/ae6ee809dc0cb40febaf2a5bff298465bd5a207f"><code>ae6ee80</code></a> build(deps-dev): bump eslint-plugin-import from 2.26.0 to 2.31.0 (<a href="https://redirect.github.com/expressjs/compression/issues/230">#230</a>)</li> <li>Additional commits viewable in <a href="https://github.com/expressjs/compression/compare/1.7.4...v1.8.1">compare view</a></li> </ul> </details> <details> <summary>Maintainer changes</summary> <p>This version was pushed to npm by <a href="https://www.npmjs.com/~ulisesgascon">ulisesgascon</a>, a new releaser for compression since your current version.</p> </details> <br /> Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show <dependency name> ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) You can disable automated security fix PRs for this repo from the [Security Alerts page](https://github.com/opentdf/docs/network/alerts). </details> Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> commit 1147327 Author: b-long <b-long@users.noreply.github.com> Date: Thu Jul 10 15:45:41 2025 -0400 chore(docs): DSPX-1267 minor updates (#129) Various updates here to support learnability and Developer Experience (DX) for a student persona, for instance: 1. [Simplify code, use 'platformEndpoint' variable](8da6e97) 1. [Set 'platformEndpoint' consistently](a168893) 1. Previously we used `platformEndpoint := "http://localhost:9002"` and `platformEndpoint := "https://opentdf.io"` in Go-lang code samples, now we only use the former. 1. **Note**: the string `opentdf.io` is used in attribute values and namespaces, but `platformEndpoint` is used for our client connection. 1. [Use dynamic namespaceID in 'create_attribute' example](e5a4257) 1. This is so that the example works (at all) 1. [Use dynamic role name in 'create_attribute' example](7b414d2) 1. This is so that the example can be run more than once, and doesn't throw an error about the attribute already existing ### Improving visual / output for learning purposes Updates to the file `code_samples/tdf/encryption_ztdf.mdx`, to assist in learning (Before) `helloworld.go` output <details><summary> Click to expand </summary> <p> ``` 2025/07/09 13:25:10 TDF Manifest: &{{{split eyJ1dWlkIjoiYWExOTIyYjQtNWNlOS0xMWYwLTg0ZDQtMzI0NmVjMmYwZmI1IiwiYm9keSI6eyJkYXRhQXR0cmlidXRlcyI6bnVsbCwiZGlzc2VtIjpudWxsfX0= [{wrapped https://platform-training.dsp-dev-green.virtru.com kas k3GLYZ9BU9mm88hkZq/Z8NCTedgyTKzgAG8aqQyO4SFNYpBU5JFPEbiXMqjwU7Atmg+DS4jDrsuxSwIb6TDpHQqfH5vkPK255uMyZMdo5oVfC5f8uPJagTXeZHLXuIAF53jS5AbU20YDXJJGFR3PeysShReP9FaWhlg/0lgNjuTCwfux65bQygHjz656i13X5BNwCDZQqB0m74gIwZUukYtbkJRPtdQzLEgOh6GFgQYu/3E6xckt3vFiPNAOEwVx9yx6PN6jzFHOaNCDGmt2hSN9nKCiet5Jpdg/k0ne82tp+CJwaJUaoTnNl98D+Cke1gogHPs6U8QB9jmuuU87wQ== {HS256 OTZhYzc2MDIxMWI4NDk5MmY3MDVmMTE4MTBmNDMyYTBkN2M2ZjBhMmI5MmZkNWY2MzUxODUxYzQwYjc3M2M4OA==} r1 1.0 }] {AES-256-GCM true} {{HS256 nhL3bOtSWCewGAhKcIs8IsyqqNUZ+Pu6bEFg3hvqf74=} GMAC 2097152 2097180 [{BG7daMHmLtQyRIrm24ntSw== 15 43}]}} {reference 0.payload zip application/octet-stream true} [] 4.3.0} 1612 {0x14000386600} [67 176 93 101 253 161 58 204 124 128 167 211 108 148 139 189 126 252 90 70 61 171 149 42 148 229 193 90 35 49 146 40]} ``` </p> </details> (After) `helloworld.go` output <details><summary> Click to expand </summary> <p> ``` 2025/07/09 13:42:27 🚀 Starting OpenTDF example... 2025/07/09 13:42:27 📡 Connecting to platform: <SOME URL> 2025/07/09 13:42:27 🔐 Initializing new SDK client... 2025/07/09 13:42:28 📝 Preparing sensitive data for encryption... 2025/07/09 13:42:28 🔒 Encrypting data... 2025/07/09 13:42:28 ✅ Data successfully encrypted 2025/07/09 13:42:28 📋 TDF Manifest details: &{{{split eyJ1dWlkIjoiMTUyNWJhNTItNWNlYy0xMWYwLTg2OGQtMzI0NmVjMmYwZmI1IiwiYm9keSI6eyJkYXRhQXR0cmlidXRlcyI6bnVsbCwiZGlzc2VtIjpudWxsfX0= [{wrapped https://platform-training.dsp-dev-green.virtru.com kas rufO6aOQAS0MM+fXcdiaR60Dr/Lnifa1MyY9vTQrIjTNzmamWPUXg4DeV8Xp6vhBIk/HYjmtqAVI9ezqXxhsIAqWR6UyLXPtV+LV5S6oq8vH9cf38E0pmFNYjPyLx9T8JcxcLta6EQz7AIWagMcudoug30vS5AOxeUieoGM4VDfPI+BTBV26fTGqwcYnVI/jcUAs5AUUt80jYm7UVlw2VyDwdEFycW8+q7KK4UxzPH8wdnq5mbMlP4Z5+4aQ70IZE2DhE1Ozn93Ow9us4rxKyjDQbSOduuDWTju8zkXssf6tPIkJrFAHhoZQ5jZM9lIiAu+CXJQrQmAaiLzGmUoE/Q== {HS256 NThjMTliZTBjOTZmNTgwNzcxYzJlNWRhZDA4NDdiODA3ZTlhYTIwY2QxNjE4NjI3MTE3NDZjMjE1M2M5MDEyYg==} r1 1.0 }] {AES-256-GCM true} {{HS256 Rp2lJRdohYmoE73TGtoPiMFRiva7ap64ho8lyCrLQUU=} GMAC 2097152 2097180 [{KDKDJhhfF+X5wa2zY/Z7MQ== 15 43}]}} {reference 0.payload zip application/octet-stream true} [] 4.3.0} 1612 {0x140003ef200} [17 193 64 131 155 245 242 186 7 60 143 124 129 246 245 173 219 122 77 217 87 48 93 39 198 91 188 150 31 115 30 74]} 2025/07/09 13:42:28 🔓 Decrypting data... 2025/07/09 13:42:28 📤 Decrypted content: Sensitive data! 2025/07/09 13:42:28 ✅ Example complete! ``` </p> </details> commit 9072372 Author: Ryan Yanulites <ryanulites@virtru.com> Date: Tue Jul 8 15:19:10 2025 -0600 feat(policy): Registered Resource docs (#130) Adds OpenTDF documentation for Registered Resources commit 81380d4 Author: b-long <b-long@users.noreply.github.com> Date: Tue Jul 8 16:38:22 2025 -0400 chore(docs): DSPX-1408 Correct `.gitignore` file (#132) Correct `.gitignore` file, relating to `_category_.json` files. See: #130 (comment) commit 45c1f4a Author: b-long <b-long@users.noreply.github.com> Date: Tue Jul 8 16:20:32 2025 -0400 chore(docs): DSPX-1408 Enable sharing OpenAPI clients URL (#131) Enable sharing OpenAPI clients URL This change allows a user to bookmark or share the URL to ( `/OpenAPI-clients` ). Previously there was no route / page for an end-user to bookmark or share. ![image](https://github.com/user-attachments/assets/7512a82a-f58f-4e4b-9415-1ebcb42dc94c) commit 5a4ea3e Author: Chris Reed <87077975+c-r33d@users.noreply.github.com> Date: Wed Jul 2 11:26:55 2025 -0500 fix(core): Update key management docs. (#128) - Update key management guide docs --------- Co-authored-by: Jp Ayyappan <108297634+jp-ayyappan@users.noreply.github.com> Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> commit 3aecafd Author: Sean Trantalis <18211470+strantalis@users.noreply.github.com> Date: Tue Jul 1 09:59:31 2025 -0400 chore(docs): kas grant migration docs (#124) Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Co-authored-by: Jp Ayyappan <108297634+jp-ayyappan@users.noreply.github.com> Co-authored-by: jp-ayyappan <jp@as2max.com> commit ec8b9de Author: Jake Van Vorhis <83739412+jakedoublev@users.noreply.github.com> Date: Mon Jun 30 15:32:52 2025 -0700 feat(policy): add and update docs for `actions` within entitlement decisioning (#126) commit 456711d Author: Jake Van Vorhis <83739412+jakedoublev@users.noreply.github.com> Date: Mon Jun 30 13:09:49 2025 -0700 chore: remove reviewdog languagetool since gemini reviews are much higher signal to noise (#127) commit b07ad5d Author: b-long <b-long@users.noreply.github.com> Date: Mon Jun 30 13:36:33 2025 -0400 chore: re-enable 'vale' (#119) The `vale` tool was disabled in #110 , this PR reverts that change. Co-authored-by: Ryan Schumacher <jschumacher@virtru.com>

b-long added 10 commits June 11, 2025 11:12

Disable false-positive machine

d228655

Run 'npm add docusaurus-plugin-openapi-docs docusaurus-theme-openapi-…

dd072fc

…docs'

Vendor spec files

0388399

Vendor spec files (samples)

25e18af

Add generated files to .gitignore

a00df29

Add 'npm run' commands

2a6ce91

Initial 'docusaurus-plugin-openapi-docs' code

abee6bd

Cleanup / simplify code

cf0745d

Cleanup

8467eee

[MANUAL REVERT] onBrokenLinks: "throw"

a52efbf

b-long requested a review from Copilot June 11, 2025 16:40

Sort languages, rename file

09ad3e6

This comment was marked as outdated.

Sign in to view

b-long mentioned this pull request Jun 11, 2025

chore(docs): add docusaurus-plugin-openapi-docs and docusaurus-theme-openapi-docs #109

Closed

4 tasks

b-long added 3 commits June 11, 2025 17:24

Address copilot code review

86ccfa4

Fix copilot review: use string literal

71c3985

Clarify commented languages

49181a9

b-long requested a review from Copilot June 11, 2025 21:31

This comment was marked as outdated.

Sign in to view

b-long added 3 commits June 11, 2025 17:48

Conditionally build, using BUILD_OPENAPI_SAMPLES env var

18cbaf5

Revert "Disable false-positive machine"

22785c3

This reverts commit d228655.

Remove vendored swagger (JSON)

d01867c

b-long marked this pull request as ready for review June 11, 2025 21:58

b-long requested review from a team as code owners June 11, 2025 21:58

b-long requested review from cassandrabailey293 and Copilot June 11, 2025 21:58

Copilot AI reviewed Jun 11, 2025

View reviewed changes

Comment thread preprocessing.ts Outdated

Comment thread docusaurus.config.ts Outdated

Add 'entityresolution_v2'

46f2799

b-long commented Jun 12, 2025

View reviewed changes

Comment thread .gitignore

b-long added 2 commits June 12, 2025 10:14

Remove unused import

64f8283

Disable false-positive machine

e56e95a

b-long added 2 commits June 12, 2025 11:39

Allow users to specify OpenAPI URL

41a8431

Merge branch 'main' into chore/add-docusaurus-openapi-docs

ad459c9

b-long requested a review from jp-ayyappan June 12, 2025 17:57

Merge branch 'main' into chore/add-docusaurus-openapi-docs

8e4f65c

b-long enabled auto-merge (squash) June 12, 2025 18:24

cassandrabailey293 and others added 5 commits June 12, 2025 15:25

Add 'npm run postbuild' process

2511d9e

move intro removal into docusaurus config (#116)

ea8140d

changed `tag` to `info` per the openapi [docusaurus plugin config](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs?tab=readme-ov-file#sidebaroptions) and removed npm job / js script for it

Package 'glob' unused since ea8140d

5f45934

Cleanup

759dbab

cassandrabailey293 approved these changes Jun 13, 2025

View reviewed changes

b-long merged commit 8e11db4 into main Jun 13, 2025
2 checks passed

b-long deleted the chore/add-docusaurus-openapi-docs branch June 13, 2025 15:16

b-long mentioned this pull request Jun 13, 2025

chore(docs): add docusaurus-plugin-openapi-docs , part 2 #118

Merged

b-long mentioned this pull request Jun 16, 2025

Re-enable 'vale' #119

Merged

jrschumacher added a commit that referenced this pull request Jun 30, 2025

chore: re-enable 'vale' (#119)

b07ad5d

The `vale` tool was disabled in #110 , this PR reverts that change. Co-authored-by: Ryan Schumacher <jschumacher@virtru.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

chore(docs): add `docusaurus-plugin-openapi-docs`#110

chore(docs): add `docusaurus-plugin-openapi-docs`#110
b-long merged 28 commits into
mainfrom
chore/add-docusaurus-openapi-docs

b-long commented Jun 11, 2025 •

edited

Loading

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cassandrabailey293 commented Jun 12, 2025

Uh oh!

b-long commented Jun 12, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

b-long commented Jun 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Reviewing this PR

Video 2 (loom)

Video 1

Defer / New Jira tickets

Vale

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cassandrabailey293 commented Jun 12, 2025

Uh oh!

b-long commented Jun 12, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

b-long commented Jun 11, 2025 •

edited

Loading