Skip to content

Commit 73c1728

Browse files
authored
Merge pull request #762 from IABTechLab/gwh-APIDOCS-2688-08-minor-edits-parity
UID2 minor docs mods resulting from queries
2 parents d33b2ec + 31877f7 commit 73c1728

File tree

6 files changed

+18
-13
lines changed

6 files changed

+18
-13
lines changed

docs/endpoints/post-identity-map.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ The following are unencrypted JSON request body examples for each parameter, one
9393
Here's an encrypted identity mapping request example for a phone number:
9494

9595
```sh
96-
echo '{"phone": ["+12345678901", "+441234567890"]}' | python3 uid2_request.py https://prod.uidapi.com/v2/identity/map YourTokenBV3tua4BXNw+HVUFpxLlGy8nWN6mtgMlIk= DELPabG/hsJsZk4Xm9Xr10Wb8qoKarg4ochUdY9e+Ow=
96+
echo '{"phone": ["+12345678901", "+441234567890"]}' | python3 uid2_request.py https://prod.uidapi.com/v2/identity/map [Your-Client-API-Key] [Your-Client-Secret]
9797
```
9898

9999
For details, and code examples in different programming languages, see [Encrypting Requests and Decrypting Responses](../getting-started/gs-encryption-decryption.md).

docs/guides/operator-guide-aws-marketplace.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -239,6 +239,8 @@ To check the UID2 Operator status of your Load Balancer, complete the following
239239
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.
240240
2. In your browser, go to `https://{dns-name-of-your-load-balancer}/ops/healthcheck`. A response of `OK` indicates good operator status.
241241

242+
### Private Operator Attestation Failure
243+
242244
<AttestFailure />
243245

244246
## Upgrading the UID2 Operator

docs/sdks/sdk-ref-csharp-dotnet.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ For details, see [API Permissions](../getting-started/gs-permissions.md).
3333

3434
## Version
3535

36-
This documentation is for the UID2 .NET SDK version 5.6.0 and above. The SDK is built for .NET Standard 2.0.
36+
The library uses .NET Standard 2.1. unit tests. The sample app uses .NET 5.0.
3737

3838
## GitHub Repository/Binary
3939

docs/sdks/sdk-ref-javascript.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -69,19 +69,20 @@ The source for this SDK is in the following open-source GitHub repository:
6969

7070
The SDK is published in these locations:
7171

72-
<!-- - NPM: [https://www.npmjs.com/package/@uid2/uid2-sdk](https://www.npmjs.com/package/@uid2/uid2-sdk)
73-
- 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.
74-
- 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 NPM package you have installed matches the version in the CDN url. LP_TODO: Looking at the NPM package, I don't believe it's ready for use - it just includes the source and doesn't seem to include a ready-to-deploy build. LP 12 Sep 2023 -->
72+
- NPM: [https://www.npmjs.com/package/@uid2/uid2-sdk](https://www.npmjs.com/package/@uid2/uid2-sdk)
73+
74+
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.
75+
76+
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.
7577
- CDN: `https://cdn.prod.uidapi.com/uid2-sdk-${VERSION_ID}.js`
76-
<!-- - This is the easiest way to include the SDK in your site if you don't use a build pipeline to bundle your JavaScript. LP_TODO: This doesn't make sense until we add the NPM option above. -->
78+
79+
This is the easiest way to include the SDK in your site if you don't use a build pipeline to bundle your JavaScript.
7780

7881
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/).
7982
- CDN (Integration): `https://cdn.integ.uidapi.com/uid2-sdk-${VERSION_ID}.js`
8083

8184
This integration URL contains un-minified code and is intended for testing purposes only. Do not use this URL for your production site.
8285

83-
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/).
84-
8586
## Terminology
8687

8788
In this document, the following terms apply:

docs/snippets/_private-operator-attest-failure.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
### Private Operator Attestation Failure
2-
When a private operator fails to attest with the core service, one of the following actions happens:
1+
When a Private Operator fails to attest with the Core service, one of the following actions happens:
32
- HTTP 401 response. The Private Operator terminates itself immediately.
43
- Likely Causes: API key revoked or incorrect.
54
- 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.

i18n/ja/docusaurus-plugin-content-docs/current/sdks/sdk-ref-javascript.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -72,10 +72,13 @@ SDK が提供する特定の機能の使用許可が与えられ、そのアク
7272
この SDK は、以下のロケーションに公開されています:
7373

7474
<!-- - NPM: [https://www.npmjs.com/package/@uid2/uid2-sdk](https://www.npmjs.com/package/@uid2/uid2-sdk)
75-
- 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.
76-
- 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 NPM package you have installed matches the version in the CDN url. LP_TODO: Looking at the NPM package, I don't believe it's ready for use - it just includes the source and doesn't seem to include a ready-to-deploy build. LP 12 Sep 2023 -->
75+
76+
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.
77+
78+
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. -->
7779
- CDN: `https://cdn.prod.uidapi.com/uid2-sdk-${VERSION_ID}.js`
78-
<!-- - This is the easiest way to include the SDK in your site if you don't use a build pipeline to bundle your JavaScript. LP_TODO: This doesn't make sense until we add the NPM option above. -->
80+
81+
<!-- This is the easiest way to include the SDK in your site if you don't use a build pipeline to bundle your JavaScript. -->
7982

8083
この文書の最新更新時点での最新バージョンは [3.4.5](https://cdn.prod.uidapi.com/uid2-sdk-3.4.5.js) です。[the list of available versions](https://cdn.prod.uidapi.com/) も参照してください。
8184
- CDN (Integration): `https://cdn.integ.uidapi.com/uid2-sdk-${VERSION_ID}.js`

0 commit comments

Comments
 (0)