Skip to content

Commit

Permalink
Update schema listings (#202)
Browse files Browse the repository at this point in the history 
# Problem

Various schemas did not need to be in the docs, and others did not have
enough context

Closes: #201 

# Solution

Better source of data for schemas

- Single source for the data (future it will be a package)
- Generator script for the Delegations.md table

## Testing

- `mdbook serve && open "http://0.0.0.0:3000/Delegations.html"`

### Signature Tool (Dev version)
- `cd tools/signed-request-generator`
- `npm run dev`
  • Loading branch information
@wilwade
wilwade authored Oct 24, 2024
1 parent 2b93f28 commit c390f98
Show file tree
Hide file tree
Showing 9 changed files with 16,906 additions and 3,317 deletions.
42 changes: 24 additions & 18 deletions docs/src/Delegations.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,27 @@

Staging-Testnet and Production-Mainnet have the same delegation Schema Ids available.

| Short Name and Specification Link | Description | Schema Id |
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ | --------- |
| [`dsnp.broadcast@v2`](https://spec.dsnp.org/DSNP/Types/Broadcast.html) | Create new post content | 17 |
| [`dsnp.dsnp-content-attribute-set@v1`](https://spec.dsnp.org/DSNP/Types/DSNPContentAttributeSet.html) | Create an authenticated attribute set for DSNP content | 12 |
| [`dsnp.dsnp.ext-content-attribute-set@v1`](https://spec.dsnp.org/DSNP/Types/ExternalContentAttributeSet.html) | Create an authenticated attribute set for content external to DSNP | 13 |
| [`dsnp.private-connections@v1`](https://spec.dsnp.org/DSNP/UserData.html) | Change private friendship connections | 10 |
| [`dsnp.private-follows@v1`](https://spec.dsnp.org/DSNP/UserData.html) | Change private follows | 9 |
| [`dsnp.profile-resources@v1`](https://spec.dsnp.org/DSNP/UserData.html) | User Profile Information | 15 |
| [`dsnp.profile@v1`](https://spec.dsnp.org/DSNP/Types/Profile.html)(Deprecated) | Change profile information | 6 |
| [`dsnp.public-follows@v1`](https://spec.dsnp.org/DSNP/UserData.html) | Change public follows | 8 |
| [`dsnp.public-key-assertion-method@v1`](https://spec.dsnp.org/DSNP/UserData.html) | Used to verify generic cryptographic signatures | 14 |
| [`dsnp.public-key-key-agreement@v1`](https://spec.dsnp.org/DSNP/UserData.html) | Publish new public key for the encrypted social graph | 7 |
| [`dsnp.reaction`](https://spec.dsnp.org/DSNP/Types/Reaction.html) | React to content | 4 |
| [`dsnp.reply@v2`](https://spec.dsnp.org/DSNP/Types/Reply.html) | Reply to a content | 18 |
| [`dsnp.tombstone@v2`](https://spec.dsnp.org/DSNP/Types/Tombstone.html) | Mark content for deletion | 16 |
| [`dsnp.update@v2`](https://spec.dsnp.org/DSNP/Types/Update.html) | Update an existing post or reply | 19 |
| [`dsnp.user-attribute-set@v2`](https://spec.dsnp.org/DSNP/Types/UserAttributeSet.html) | Create an authenticated attribute set for a DSNP User | 20 |
| [`frequency.default-token-address@v1`](https://github.com/frequency-chain/schemas) | List one or more default token receiving addresses | 21 |
<!---
Generate this table via root with:
npx tsx tools/signed-request-generator/generate-available-delegations.ts
-->

| Short Name and Specification Link | Description | Schema Id |
| ---------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ | --------- |
| [`dsnp.broadcast@v1`](https://spec.dsnp.org/DSNP/Types/Broadcast.html) | (Deprecated) Create new public content | 2 |
| [`dsnp.broadcast@v2`](https://spec.dsnp.org/DSNP/Types/Broadcast.html) | Create new public content | 17 |
| [`dsnp.dsnp-content-attribute@v1`](https://spec.dsnp.org/DSNP/Types/DSNPContentAttributeSet.html) | Create an authenticated attribute set for DSNP content | 12 |
| [`dsnp.ext-content-attribute@v1`](https://spec.dsnp.org/DSNP/Types/ExternalContentAttributeSet.html) | Create an authenticated attribute set for content external to DSNP | 13 |
| [`dsnp.private-connections@v1`](https://spec.dsnp.org/DSNP/UserData.html) | Update private friendship connections | 10 |
| [`dsnp.private-follows@v1`](https://spec.dsnp.org/DSNP/UserData.html) | Update private follow list | 9 |
| [`dsnp.profile-resources@v1`](https://spec.dsnp.org/DSNP/UserData.html) | Update user profile information | 15 |
| [`dsnp.profile@v1`](https://spec.dsnp.org/DSNP/Types/Profile.html) | (Deprecated) Update profile information | 6 |
| [`dsnp.public-follows@v1`](https://spec.dsnp.org/DSNP/UserData.html) | Update public follow list | 8 |
| [`dsnp.reaction@v1`](https://spec.dsnp.org/DSNP/Types/Reaction.html) | Public reaction to content | 4 |
| [`dsnp.reply@v1`](https://spec.dsnp.org/DSNP/Types/Reply.html) | (Deprecated) Public reply to content | 3 |
| [`dsnp.reply@v2`](https://spec.dsnp.org/DSNP/Types/Reply.html) | Public reply to content | 18 |
| [`dsnp.tombstone@v1`](https://spec.dsnp.org/DSNP/Types/Tombstone.html) | (Deprecated) Mark content for deletion | 1 |
| [`dsnp.tombstone@v2`](https://spec.dsnp.org/DSNP/Types/Tombstone.html) | Mark content for deletion | 16 |
| [`dsnp.update@v1`](https://spec.dsnp.org/DSNP/Types/Update.html) | (Deprecated) Update an existing post or reply | 5 |
| [`dsnp.update@v2`](https://spec.dsnp.org/DSNP/Types/Update.html) | Update an existing post or reply | 19 |
| [`dsnp.user-attribute-set@v2`](https://spec.dsnp.org/DSNP/Types/UserAttributeSet.html) | Create an authenticated attribute set for a DSNP User | 20 |
Loading

0 comments on commit c390f98

Please sign in to comment.