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

DSNP Operations #215

Merged
merged 1 commit into from
Jan 19, 2023
Merged

DSNP Operations #215

merged 1 commit into from
Jan 19, 2023

Conversation

wilwade
Copy link
Member

@wilwade wilwade commented Nov 21, 2022

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.
  2. Generate the website book (npm run build) and preview in browser to ensure there are no formatting issues.

Screenshots (optional):

N/A

@wilwade wilwade linked an issue Nov 21, 2022 that may be closed by this pull request
11 tasks
@wesbiggs wesbiggs force-pushed the chore/operation-specfication-214 branch from f11d247 to 53c371e Compare November 28, 2022 20:41
@wesbiggs wesbiggs force-pushed the chore/operation-specfication-214 branch 3 times, most recently from 032891e to 3ce5b21 Compare December 8, 2022 22:02
@wesbiggs wesbiggs requested a review from shannonwells December 8, 2022 22:05
@wesbiggs wesbiggs self-assigned this Dec 8, 2022
@wesbiggs wesbiggs marked this pull request as ready for review December 8, 2022 22:06
Copy link
Member Author

@wilwade wilwade left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Few notes and discussion questions

pages/DSNP/Announcements.md Outdated Show resolved Hide resolved
pages/DSNP/Identity.md Outdated Show resolved Hide resolved
pages/DSNP/Announcements.md Outdated Show resolved Hide resolved
pages/DSNP/Identity.md Outdated Show resolved Hide resolved
pages/DSNP/Identity.md Outdated Show resolved Hide resolved
pages/DSNP/Identity.md Outdated Show resolved Hide resolved
@wesbiggs wesbiggs force-pushed the chore/operation-specfication-214 branch 3 times, most recently from 6e9f9bc to 2b6c14a Compare January 5, 2023 18:43
pages/DSNP/Identity.md Outdated Show resolved Hide resolved
pages/DSNP/Overview.md Outdated Show resolved Hide resolved
@wesbiggs wesbiggs force-pushed the chore/operation-specfication-214 branch from 2b6c14a to e1dde24 Compare January 6, 2023 19:48
pages/DSNP/Operations.md Outdated Show resolved Hide resolved
@wesbiggs wesbiggs force-pushed the chore/operation-specfication-214 branch from ed5fb35 to 5c605f2 Compare January 11, 2023 17:30
@wesbiggs
Copy link
Member

Incorporated suggestions from @jeanettedepatie.

Copy link
Collaborator

@shannonwells shannonwells left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will re-review after discussed changes

Copy link
Member Author

@wilwade wilwade left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Apparently I created the initial PR @wesbiggs, but I approve it!

@wesbiggs wesbiggs force-pushed the chore/operation-specfication-214 branch from e186969 to 0ce7b4d Compare January 19, 2023 23:11
"blockchain",
"archiveEntryID",
"asynchronously",
"(a )?blockchain",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Non-blocking, but this line should be removed.

Suggested change
"(a )?blockchain",

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You would think so, right? I actually filed a bug for yaspeller on this: hcodes/yaspeller#187 (unfortunately yaspeller as a project seems to have gone dark about the same time Russia invaded Ukraine).

Copy link
Member

@wesbiggs wesbiggs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a Freaky Friday-style Wil approval.

@wesbiggs wesbiggs merged commit cb7d677 into main Jan 19, 2023
@wesbiggs wesbiggs deleted the chore/operation-specfication-214 branch January 19, 2023 23:43
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 this pull request may close these issues.

Formalize Operation Specifications
5 participants