Update schemas.mdx #856
Update schemas.mdx #856
Conversation
Updating the schemas page to reflect the introduction of organizations
WalkthroughThe changes involve the renaming of the "Project Identifier" section to "Project and Organization Identifier," expanding its scope to include organizations. A new "Organization Metadata" section has been added, detailing the schema for associating metadata with organizations. Minor adjustments have been made to the existing "Project Metadata" and "Retro Funding Application Approval/Rejection" sections. The original "Project Identifier" schema is retained for historical projects created before August 23, 2024. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant System
User->>System: Create Project/Organization
System-->>User: Provide Identifier
User->>System: Request Metadata
System-->>User: Return Metadata
Recent review detailsConfiguration used: .coderabbit.yaml Files selected for processing (1)
Additional context usedPath-based instructions (1)
LanguageTool
Additional comments not posted (5)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add Documentation and Community
|
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
@C-Emily-Furlong reviewing... |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
| | farcasterID | The Farcaster id of the individual who published the organization metadata | | ||
| | name | The name of the organization | | ||
| | projects | The array of projects that belong to this organization | | ||
| | parentOrgUID | The attestation UID of this organizations's parent, in case it has one | |
There was a problem hiding this comment.
Correct grammatical error.
Change "this organizations's" to "these organizations'".
Apply this diff to fix the grammatical error:
- | parentOrgUID | The attestation UID of this organizations's parent, in case it has one |
+ | parentOrgUID | The attestation UID of these organizations' parent, in case it has one |Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| | parentOrgUID | The attestation UID of this organizations's parent, in case it has one | | |
| | parentOrgUID | The attestation UID of these organizations' parent, in case it has one | |
Tools
LanguageTool
[grammar] ~42-~42: The singular determiner ‘this’ may not agree with the plural noun ‘organizations’. Did you mean “these”?
Context: ...| parentOrgUID | The attestation UID of this organizations's parent, in case it has ...(THIS_NNS)
|
|
||
| ### [Project Identifier](https://optimism.easscan.org/schema/view/0x7ae9f4adabd9214049df72f58eceffc48c4a69e920882f5b06a6c69a3157e5bd) | ||
|
|
||
| Used as the unique identifier for projects created in the Collective before 23 August 2024. Attestations issued from this schema prior to 23 August 2024 are still used as the unique identifier for projects. New projects created after 23 August 2024 use the new entity identifier (see above). |
There was a problem hiding this comment.
Improve readability.
Replace "prior to" with "before".
Apply this diff to improve readability:
- Attestations issued from this schema prior to 23 August 2024 are still used as the unique identifier for projects.
+ Attestations issued from this schema before 23 August 2024 are still used as the unique identifier for projects.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Used as the unique identifier for projects created in the Collective before 23 August 2024. Attestations issued from this schema prior to 23 August 2024 are still used as the unique identifier for projects. New projects created after 23 August 2024 use the new entity identifier (see above). | |
| Used as the unique identifier for projects created in the Collective before 23 August 2024. Attestations issued from this schema before 23 August 2024 are still used as the unique identifier for projects. New projects created after 23 August 2024 use the new entity identifier (see above). |
Tools
LanguageTool
[style] ~142-~142: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...4. Attestations issued from this schema prior to 23 August 2024 are still used as the un...(EN_WORDINESS_PREMIUM_PRIOR_TO)
Updating the schemas page to reflect the introduction of organizations
Description
Updating the schemas page to reflect the introduction of organizations
Tests
none
Additional context
Add any other context about the problem you're solving.
Metadata