I've now gone through and analyzed the contents of the API and Operations document to determine their relevance and usefulness after the specification refactoring. The good news is that I believe we can now dispose of this document entirely, and replace it with some small additions to the spec document, complemented by the impending Authorization Agent Primer.

Specifically, I believe we can do the following:

Remove the API and Operations specification, including all references to the same from the other specification documents.
Expand the "Data Authorization" section of the specification with the following
- Definition of an Authorization Agent. Include how to lookup via Social Agent Profile Document, and how to lookup Application Registration or Social Agent Registration.
- Summary of the key authorization workflows (not the complete operations)
- Detail the application request access flow using a mermaid diagram. The other flows are only slight variations on this, and we can point out the variations without having to detail them. Do not need to detail the sub-operations (e.g. present an access grant, record grant, etc.). Can instead just link to the relevant sections of the spec.
Move the wireframes that detail authorization screens and where data is sourced from into the Authorization Agent Primer. We could probably split this out into its own issue and work on it afterwards.

Refactor API and Operations #179

Description

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions