From 31877f7b8a75c5a640d333dc46981d858412f692 Mon Sep 17 00:00:00 2001 From: genwhittTTD Date: Wed, 20 Nov 2024 17:37:50 -0500 Subject: [PATCH] UID2 minor docs mods resulting from queries --- docs/endpoints/post-identity-map.md | 2 +- docs/guides/operator-guide-aws-marketplace.md | 2 ++ docs/sdks/sdk-ref-csharp-dotnet.md | 2 +- docs/sdks/sdk-ref-javascript.md | 13 +++++++------ docs/snippets/_private-operator-attest-failure.mdx | 3 +-- .../current/sdks/sdk-ref-javascript.md | 9 ++++++--- 6 files changed, 18 insertions(+), 13 deletions(-) diff --git a/docs/endpoints/post-identity-map.md b/docs/endpoints/post-identity-map.md index 183d59fb9..ca6acb075 100644 --- a/docs/endpoints/post-identity-map.md +++ b/docs/endpoints/post-identity-map.md @@ -93,7 +93,7 @@ The following are unencrypted JSON request body examples for each parameter, one Here's an encrypted identity mapping request example for a phone number: ```sh -echo '{"phone": ["+12345678901", "+441234567890"]}' | python3 uid2_request.py https://prod.uidapi.com/v2/identity/map YourTokenBV3tua4BXNw+HVUFpxLlGy8nWN6mtgMlIk= DELPabG/hsJsZk4Xm9Xr10Wb8qoKarg4ochUdY9e+Ow= +echo '{"phone": ["+12345678901", "+441234567890"]}' | python3 uid2_request.py https://prod.uidapi.com/v2/identity/map [Your-Client-API-Key] [Your-Client-Secret] ``` For details, and code examples in different programming languages, see [Encrypting Requests and Decrypting Responses](../getting-started/gs-encryption-decryption.md). diff --git a/docs/guides/operator-guide-aws-marketplace.md b/docs/guides/operator-guide-aws-marketplace.md index f2ee5afc7..56729deda 100644 --- a/docs/guides/operator-guide-aws-marketplace.md +++ b/docs/guides/operator-guide-aws-marketplace.md @@ -239,6 +239,8 @@ To check the UID2 Operator status of your Load Balancer, complete the following 1. Identify the DNS name of your load balancer by going to **EC2 > Load balancers** and looking at the **DNS name** column of your load balancer. 2. In your browser, go to `https://{dns-name-of-your-load-balancer}/ops/healthcheck`. A response of `OK` indicates good operator status. +### Private Operator Attestation Failure + ## Upgrading the UID2 Operator diff --git a/docs/sdks/sdk-ref-csharp-dotnet.md b/docs/sdks/sdk-ref-csharp-dotnet.md index 0722bcda6..a717e04fd 100644 --- a/docs/sdks/sdk-ref-csharp-dotnet.md +++ b/docs/sdks/sdk-ref-csharp-dotnet.md @@ -33,7 +33,7 @@ For details, see [API Permissions](../getting-started/gs-permissions.md). ## Version -This documentation is for the UID2 .NET SDK version 5.6.0 and above. The SDK is built for .NET Standard 2.0. +The library uses .NET Standard 2.1. unit tests. The sample app uses .NET 5.0. ## GitHub Repository/Binary diff --git a/docs/sdks/sdk-ref-javascript.md b/docs/sdks/sdk-ref-javascript.md index bc4b59cbc..24c5e395c 100644 --- a/docs/sdks/sdk-ref-javascript.md +++ b/docs/sdks/sdk-ref-javascript.md @@ -69,19 +69,20 @@ The source for this SDK is in the following open-source GitHub repository: The SDK is published in these locations: - +- NPM: [https://www.npmjs.com/package/@uid2/uid2-sdk](https://www.npmjs.com/package/@uid2/uid2-sdk) + + This is the easiest way to include the SDK in your own build. Use this if you want to bundle the SDK along with your other JavaScript or TypeScript files. + + You can also use this for TypeScript type information and still load the script via the CDN. If you do this, ensure that the version of the NPM package that you have installed matches the version in the CDN URL. - CDN: `https://cdn.prod.uidapi.com/uid2-sdk-${VERSION_ID}.js` - + + This is the easiest way to include the SDK in your site if you don't use a build pipeline to bundle your JavaScript. As of the latest update to this document, the most recent version is [3.4.5](https://cdn.prod.uidapi.com/uid2-sdk-3.4.5.js). You can also see [the list of available versions](https://cdn.prod.uidapi.com/). - CDN (Integration): `https://cdn.integ.uidapi.com/uid2-sdk-${VERSION_ID}.js` This integration URL contains un-minified code and is intended for testing purposes only. Do not use this URL for your production site. - As of the latest update to this document, the most recent version is [3.4.5](https://cdn.integ.uidapi.com/uid2-sdk-3.4.5.js). You can also see [the list of available versions](https://cdn.integ.uidapi.com/). - ## Terminology In this document, the following terms apply: diff --git a/docs/snippets/_private-operator-attest-failure.mdx b/docs/snippets/_private-operator-attest-failure.mdx index 303c40fb0..6ec70f600 100644 --- a/docs/snippets/_private-operator-attest-failure.mdx +++ b/docs/snippets/_private-operator-attest-failure.mdx @@ -1,5 +1,4 @@ -### Private Operator Attestation Failure -When a private operator fails to attest with the core service, one of the following actions happens: +When a Private Operator fails to attest with the Core service, one of the following actions happens: - HTTP 401 response. The Private Operator terminates itself immediately. - Likely Causes: API key revoked or incorrect. - Any other non-200 response code. The Private Operator continues to function for 12 hours. If the issue is not resolved in this time frame, it terminates itself. diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/sdks/sdk-ref-javascript.md b/i18n/ja/docusaurus-plugin-content-docs/current/sdks/sdk-ref-javascript.md index 540af8d16..47ac3bdba 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/sdks/sdk-ref-javascript.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/sdks/sdk-ref-javascript.md @@ -72,10 +72,13 @@ SDK が提供する特定の機能の使用許可が与えられ、そのアク この SDK は、以下のロケーションに公開されています: + + This is the easiest way to include the SDK in your own build. Use this if you want to bundle the SDK along with your other JavaScript or TypeScript files. + + You can also use this for TypeScript type information and still load the script via the CDN. If you do this, ensure that the version of the NPM package that you have installed matches the version in the CDN URL. --> - CDN: `https://cdn.prod.uidapi.com/uid2-sdk-${VERSION_ID}.js` - + + この文書の最新更新時点での最新バージョンは [3.4.5](https://cdn.prod.uidapi.com/uid2-sdk-3.4.5.js) です。[the list of available versions](https://cdn.prod.uidapi.com/) も参照してください。 - CDN (Integration): `https://cdn.integ.uidapi.com/uid2-sdk-${VERSION_ID}.js`