update API examples to v2 #3
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…crypto-api to https://nodejs.org/api/crypto.html#crypto since the former is "Experimental"
publisher/server_only/README.md
Outdated
| | `UID2_BASE_URL` | string | The base URL of the UID2 service. For example:</br>Testing environment: `https://integ.uidapi.com`<br/>Production environment: `https://prod.uidapi.com` | | ||
| | `UID2_API_KEY` | string | Your UID2 authentication key for the UID2 service specified in `UID2_BASE_URL`.| | | ||
| | `UID2_CLIENT_SECRET` | string | Your UID2 client secret for the UID2 service specified in `UID2_BASE_URL`.| | | ||
| | `SESSION_KEY` | string | The key to the encryption session data stored in application's session cookie.| | |
There was a problem hiding this comment.
What value are we getting from the session key? I think it can just be any arbitrary string, and unless you know that you might go hunting trying to find out what value needs to go here.
publisher/server_only/README.md
Outdated
| ``` | ||
| docker build . -t uid2-publisher-server | ||
| docker run -it --rm -p 3000:3000 \ | ||
| -e UID2_BASE_URL="https://integ.uidapi.com" \ |
There was a problem hiding this comment.
Should this default point to our integration URL? That's https://operator-integ.uidapi.com. Hopefully people won't be using production keys to try out the example app.
publisher/server_only/README.md
Outdated
| | `SESSION_KEY` | string | The key to the encryption session data stored in application's session cookie. | | ||
| | Parameter | Data Type | Description | | ||
| |:---------------------| :--- |:---------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | `UID2_BASE_URL` | string | The base URL of the UID2 service. For example:</br>Testing environment: `https://integ.uidapi.com`<br/>Production environment: `https://prod.uidapi.com` | |
Collaborator
There was a problem hiding this comment.
These are not quite correct. Suggest leaving one example and then giving link to https://github.com/UnifiedID2/uid2docs/tree/main/api/v2#environments
publisher/standard/README.md
Outdated
| | `UID2_API_KEY` | string | Your UID2 authentication key for the UID2 service specified in `UID2_BASE_URL`. | | ||
| | Parameter | Data Type | Description | | ||
| |:---------------------|:----------|:---------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | `UID2_BASE_URL` | string | The base URL of the UID2 service. For example:</br>Testing environment: `https://integ.uidapi.com`<br/>Production environment: `https://prod.uidapi.com` | |
There was a problem hiding this comment.
Another integration URL to update.
publisher/standard/README.md
Outdated
| ``` | ||
| docker build . -t uid2-publisher-standard | ||
| docker run -it --rm -p 3000:3000 \ | ||
| -e UID2_BASE_URL="https://integ.uidapi.com" \ |
There was a problem hiding this comment.
Another integration URL to update.
Updated placeholder value format for consistency with the style guide.
Contributor
|
resolved the conflicts. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.