Merge pull request #197 from openid/fix/url-and-doc-fixes

updated spec URLs and readme/docs
openid · Jan 17, 2025 · 5c57d63 · 5c57d63
2 parents 6539011 + 3578ce6
commit 5c57d63
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 6 deletions.
diff --git a/api/authorization-api-1_0.md b/api/authorization-api-1_0.md
@@ -5,7 +5,7 @@ cat: std # Check
 submissiontype: IETF
 wg: OpenID AuthZEN
 
-docname: authorization-api-1_0_02
+docname: authorization-api-1_0
 
 title: Authorization API 1.0 – draft 02
 abbrev: azapi

diff --git a/interop/authzen-interop-website/docs/scenarios/todo-1.0-id/index.md b/interop/authzen-interop-website/docs/scenarios/todo-1.0-id/index.md
@@ -6,7 +6,7 @@ sidebar_position: 2
 
 This document lists the request and response payloads for each of the API requests in the Todo interop scenario.
 
-> Note: These payloads and corresponding interop results are for the [AuthZEN 1.0 Implementers Draft](https://openid.github.io/authzen/authorization-api-1_0_01) version of the spec.
+> Note: These payloads and corresponding interop results are for the [AuthZEN 1.0 Implementers Draft](https://openid.net/specs/authorization-api-1_0-01.html) version of the spec.
 
 :::tip
 This is a copy of the payload document defined by the AuthZEN WG. The definitive document can be found [here](https://hackmd.io/gNZBRoTfRgWh_PNM0y2wDA?view).

diff --git a/interop/authzen-interop-website/docs/scenarios/todo-1.1/index.md b/interop/authzen-interop-website/docs/scenarios/todo-1.1/index.md
@@ -6,7 +6,7 @@ sidebar_position: 3
 
 This document lists the request and response payloads for each of the API requests in the Todo interop scenario.
 
-> Note: These payloads and corresponding interop results are for the [AuthZEN 1.1 Preview 01](https://openid.github.io/authzen/authorization-api-1_1_01) version of the spec.
+> Note: These payloads and corresponding interop results are for the [AuthZEN 1.0 Draft 02](https://openid.github.io/authzen) version of the spec.
 
 :::tip
 This is a copy of the payload document defined by the AuthZEN WG. The definitive document can be found [here](https://hackmd.io/gNZBRoTfRgWh_PNM0y2wDA?view).

diff --git a/interop/authzen-interop-website/docs/scenarios/todo/index.md b/interop/authzen-interop-website/docs/scenarios/todo/index.md
@@ -6,7 +6,7 @@ sidebar_position: 1
 
 This document lists the request and response payloads for each of the API requests in the Todo interop scenario.
 
-:::danger These payloads and corresponding interop results are for the [AuthZEN 1.0 Preview 00](https://openid.github.io/authzen/authorization-api-1_0_00) version of the spec. These results are superseded by the [Implementers Draft](../todo-1.0-id/index.md) results. Once all of the implementations in this section switch over to the Implementers Draft, this section will be deleted.
+:::danger These payloads and corresponding interop results are for the [AuthZEN 1.0 Preview 00](https://openid.net/specs/authorization-api-1_0-00.html) version of the spec. These results are superseded by the [Implementers Draft](../todo-1.0-id/index.md) results. Once all of the implementations in this section switch over to the Implementers Draft, this section will be deleted.
 :::
 
 :::tip

diff --git a/interop/authzen-todo-backend/README.md b/interop/authzen-todo-backend/README.md
@@ -14,15 +14,17 @@ yarn
 
 Rename the `.env.example` file to `.env` and update the `AUTHZEN_PDP_URL` variable. The authorization middleware will send AuthZEN requests to `${AUTHZEN_PDP_URL}/access/v1/evaluation` (for the `1.0-preview` and `1.0-implementers-draft` spec variations), and to a both `${AUTHZEN_PDP_URL}/access/v1/evaluation` and `${AUTHZEN_PDP_URL}/access/v1/evaluations` (for the `1.1-preview` spec variation).
 
-Optionally, set the `AUTHZEN_PDP_API_KEY` variable if your authorizer needs an API key. You should prefix it with `basic` or `Bearer` as appropriate. If set, the authorization middleware will add the `authorization: ${AUTHZEN_PDP_API_KEY}` header to every authorization request.
+Optionally, set the `AUTHZEN_PDP_API_KEY` variable if your authorizer needs an API key. This variable expects a JSON object with the key being the same keys as you use for your PDP in `src/pdps.json`, and the value being your API key, prefixed with `Basic` or `Bearer` as appropriate. If set, the authorization middleware will add the `Authorization` header with your API key to every authorization request.
+
+Example `.env` file:
 
 ```shell
 JWKS_URI=https://citadel.demo.aserto.com/dex/keys
 ISSUER=https://citadel.demo.aserto.com/dex
 AUDIENCE=citadel-app
 
 AUTHZEN_PDP_URL=https://authorizer.domain.com
-AUTHZEN_PDP_API_KEY=basic YOUR_API_KEY
+AUTHZEN_PDP_API_KEY='{"Aserto":"Basic aserto-key","your-pdp":"Bearer your-key"}'
 ```
 
 ## Start the server in developer mode
-Original file line number
+Diff line change
@@ Expand Up / @@ -6,7 +6,7 @@ sidebar_position: 1 @@
     This document lists the request and response payloads for each of the API requests in the Todo interop scenario.
-    :::danger These payloads and corresponding interop results are for the [AuthZEN 1.0 Preview 00](https://openid.github.io/authzen/authorization-api-1_0_00) version of the spec. These results are superseded by the [Implementers Draft](../todo-1.0-id/index.md) results. Once all of the implementations in this section switch over to the Implementers Draft, this section will be deleted.
+    :::danger These payloads and corresponding interop results are for the [AuthZEN 1.0 Preview 00](https://openid.net/specs/authorization-api-1_0-00.html) version of the spec. These results are superseded by the [Implementers Draft](../todo-1.0-id/index.md) results. Once all of the implementations in this section switch over to the Implementers Draft, this section will be deleted.
     :::
     :::tip
@@ Expand Down @@