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

Modification to software source code schema #100

Open
Castronova opened this issue Apr 2, 2024 · 0 comments
Open

Modification to software source code schema #100

Castronova opened this issue Apr 2, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@Castronova
Copy link
Collaborator

Below are comments from an outstanding PR on software source code. Moving these to an issue so we can merge the PR and consolidate repositories.

  1. Consider changing to something like the following:

To classify a record as a computer programming source code, "@type: "SoftwareSourceCode" should be used in the json schema. This will classify the record such as compile ready solutions, code snippet samples, scripts, etc. as a specific Schema.Org type called SoftwareSourceCode for which the metadata should be described using the core metadata, as well as the software-source-code-specific properties for the Schema:SoftwareSourceCode class. The following table outlines the required and optional properties selected from Schema.Org vocabulary to design the I-GUIDE software source code metadata schema. These properties are encoded as 1 or 1+ for required and 0,1 or 0+ for optional in the Cardinality column of the table below.

to

To classify a record as a computer programming source code, use "@type: "SoftwareSourceCode" in the json schema. This is appropriate for records including code snippet samples, scripts, notebooks, etc. The following table outlines the required and optional properties to sufficiently describe software source code objects. Required properties have a cardinality of 1 or 1+ and optional properties have a cardinalities of 0, 0+, 1.

  1. I'm not sure that we want to embed source code within the schema. I wonder if this could have security implications. See:
| [text](https://schema.org/text) | CreativeWork | Text | 0,1 | The textual content of the source code. |
@Castronova Castronova added the enhancement New feature or request label Apr 2, 2024
@Castronova Castronova transferred this issue from I-GUIDE/data-catalog-archive Apr 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant