search

ConsumerDataStandardsAustralia / standards-maintenance

This repository houses the interactions, consultations and work management to support the maintenance of baselined components of the Consumer Data Right API Standards and Information Security profile.
41 stars 9 forks source link

DCR APIs non-normative examples would benefit from clarification #487

Closed CDR-API-Stream closed 1 year ago

CDR-API-Stream commented 2 years ago

Description

The DCR API non-normative examples are a bit misleading as to how the registration endpoints are used.

Within the OIDC Provider Configuration Endpoint, the registration_endpoint is the url for the Client Registration End Point.

This endpoint applies to all the registration flows: POST /register GET /register/{clientID} PUT /register/{clientID} DELETE /register/{clientID}

The /register used in the documentation and non-normative example is a proxy for the registration_endpoint.

image

This isn't clearly articulated in the non-normative examples where the path contains duplicate register strings:

image

Area Affected

DCR APIs non-normative examples

Change Proposed

Removing the duplication of /register/register and providing reference the the registration_endpoint would make this clearer

CDR-API-Stream commented 2 years ago

This issue was discussed in the Maintenance Iteration 11 call. It was agreed to incorporate this change request into this maintenance iteration.

CDR-API-Stream commented 2 years ago

This issue has been staged for review: https://github.com/ConsumerDataStandardsAustralia/standards-staging/compare/maintenance/511..maintenance/487