Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Formalize Operation Specifications #214

Closed
11 tasks
wilwade opened this issue Nov 18, 2022 · 0 comments · Fixed by #215
Closed
11 tasks

Formalize Operation Specifications #214

wilwade opened this issue Nov 18, 2022 · 0 comments · Fixed by #215
Assignees

Comments

@wilwade
Copy link
Member

wilwade commented Nov 18, 2022

Operations

  • Identity
    • Create
    • Delegation Upsert
    • User Directed Delegation Revocation
    • Delegated Party Directed Delegation Revocation
    • DSNP Id Retire
    • Add DSNP Id Control Public Key
    • Remove DSNP Id Control Public Key
  • Announcements
    • Publishing
    • Verification

Additional Notes

  • May be able to split up some of the data definition from actions like verification and such.
@wilwade wilwade linked a pull request Nov 21, 2022 that will close this issue
3 tasks
@wilwade wilwade mentioned this issue Nov 21, 2022
3 tasks
wesbiggs pushed a commit that referenced this issue Jan 19, 2023
Problem
=======
The specification lacks formal details on the operations a compliant
implementation should provide.
Link to GitHub Issue(s): Closes #214 

Solution
========
This PR adds Operations tables to the Identity and Announcements pages
(which are the two areas where operations have thus far been specified).
For each operation, we provide a name, the principal(s) who will be
invoking the operation, the inputs, and the expected outputs or state
changes.

Note that this is not a spec version change, but rather a clarification
of the existing spec.

Change summary:
---------------
- [ ] Updated Overview page
- [ ] Updated Identity page
- [ ] Updated Announcements page

Steps to Verify:
----------------
1. Review proposed text for accuracy and clarity.
1. Generate the website book (`npm run build`) and preview in browser to
ensure there are no formatting issues.

Screenshots (optional):
-----------------------
N/A
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants