axone-protocol / ontology

📙 The Axone Ontology
https://docs.axone.xyz/technical-documentation/ontology/the-power-of-ontologies
Creative Commons Attribution Share Alike 4.0 International
12 stars 0 forks source link

Adopt a flatten representation for generated JSON-LD schema #249

Closed ccamel closed 8 months ago

ccamel commented 8 months ago

This PR enhances the build process by adding the flag --flatten to the CLI for generating a flattened JSON-LD representation, which is better suited for the cognitarium smart contract.

By default, this flag is enabled, ensuring that classes and properties are organized at the same hierarchical level. Previously, properties were nested under the class context to which they were associated (i.e., their domain).

before:

{
  "@context": {
    "@protected": true,
    "id": "@id",
    "type": "@type",
    "DigitalResourceRightsCredential": {
      "@id": "https://w3id.org/okp4/ontology/v2/schema/credential/digital-resource/rights/DigitalResourceRightsCredential",
      "@context": {
        "@protected": true,
        "id": "@id",
        "type": "@type",
        "hasAuthor": {
          "@id": "https://w3id.org/okp4/ontology/v2/schema/credential/digital-resource/rights/hasAuthor",
          "@type": "@id"
        },
        "hasCreator": {
          "@id": "https://w3id.org/okp4/ontology/v2/schema/credential/digital-resource/rights/hasCreator",
          "@type": "@id"
        },
        "hasLicense": {
          "@id": "https://w3id.org/okp4/ontology/v2/schema/credential/digital-resource/rights/hasLicense",
          "@type": "@id"
        },
        "hasPublisher": {
          "@id": "https://w3id.org/okp4/ontology/v2/schema/credential/digital-resource/rights/hasPublisher",
          "@type": "@id"
        }
      }
    }
  }
}

now:

{
  "@context": {
    "@protected": true,
    "id": "@id",
    "type": "@type",
    "DigitalResourceRightsCredential": {
      "@id": "https://w3id.org/okp4/ontology/v2/schema/credential/digital-resource/rights/DigitalResourceRightsCredential"
    },
    "hasAuthor": {
      "@id": "https://w3id.org/okp4/ontology/v2/schema/credential/digital-resource/rights/hasAuthor",
      "@type": "@id"
    },
    "hasCreator": {
      "@id": "https://w3id.org/okp4/ontology/v2/schema/credential/digital-resource/rights/hasCreator",
      "@type": "@id"
    },
    "hasLicense": {
      "@id": "https://w3id.org/okp4/ontology/v2/schema/credential/digital-resource/rights/hasLicense",
      "@type": "@id"
    },
    "hasPublisher": {
      "@id": "https://w3id.org/okp4/ontology/v2/schema/credential/digital-resource/rights/hasPublisher",
      "@type": "@id"
    }
  }
}

While this representation is simpler and seems to be more commonly used, it leads to a reduction in type strictness because the connection between a property and its associated class is no longer explicitly stated.

Summary by CodeRabbit

coderabbitai[bot] commented 8 months ago

Walkthrough

The recent updates involve enhancing JSON-LD conversion functionality by introducing a --flatten option. This modification affects the command-line interface and the underlying conversion logic, streamlining the process of generating flattened JSON-LD outputs. The changes span across the Makefile and Python scripts, specifically targeting the conversion commands and functions to accommodate the new flattening feature.

Changes

Files Change Summary
Makefile, script/cli/cli.py, script/cli/jsonld.py Added --flatten option to JSON-LD conversion commands and functions. Adjusted related logic for flattened output.

🐇✨
In the land of code and lore,
A rabbit hopped, with changes galore.
"Let's flatten," it said, "make JSON-LD neat,
With a command so swift, it can't be beat!"
🎉📜🐾

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?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips ### Chat There are 3 ways to chat with CodeRabbit: - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit-tests for this file.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit tests for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit tests.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` 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) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - The JSON schema for the configuration file is available [here](https://coderabbit.ai/integrations/coderabbit-overrides.v2.json). - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json` ### CodeRabbit Discord Community Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback.
bot-anik commented 8 months ago

:tada: This PR is included in version 3.0.0 :tada:

The release is available on GitHub release

Your semantic-release bot :package::rocket: