Terms from Schema.org
Recognized properties for CodeMeta SoftwareSourceCode and SoftwareApplication includes the following terms from https://schema.org. These terms are part of the CodeMeta specification and can be used without any prefix.
| Property | Type | Versions | Description |
|---|---|---|---|
| applicationCategory | Text or URL | v2, v3 | Type of software application, e.g. 'Game, Multimedia'. |
| applicationSubCategory | Text or URL | v2, v3 | Subcategory of the application, e.g. 'Arcade Game'. |
| author | Organization or Person | v2, v3 | The author of this content or rating. Please note that author is special in that HTML 5 provides a special mechanism for indicating authorship via the rel tag. That is equivalent to this and may be used interchangeably. |
| citation | CreativeWork or URL | v2, v3 | A citation or reference to another creative work, such as another publication, web page, scholarly article, etc. |
| codeRepository | URL | v2, v3 | Link to the repository where the un-compiled, human readable code and related code is located (SVN, GitHub, CodePlex, institutional GitLab instance, etc.). |
| contributor | Organization or Person | v2, v3 | A secondary contributor to the CreativeWork or Event. |
| copyrightHolder | Organization or Person | v2, v3 | The party holding the legal copyright to the CreativeWork. |
| copyrightYear | Number | v2, v3 | The year during which the claimed copyright for the CreativeWork was first asserted. |
| dateCreated | Date | v2, v3 | The date on which the CreativeWork was created or the item was added to a DataFeed. |
| dateModified | Date | v2, v3 | The date on which the CreativeWork was most recently modified or when the item's entry was modified within a DataFeed. |
| datePublished | Date | v2, v3 | Date of first broadcast/publication. |
| description | Text | v2, v3 | A description of the item. |
| downloadUrl | URL | v2, v3 | If the file can be downloaded, URL to download the binary. |
| editor | Person | v2, v3 | Specifies the Person who edited the CreativeWork. |
| encoding | MediaObject | v2, v3 | A media object that encodes this CreativeWork. This property is a synonym for associatedMedia. Supersedes encodings. |
| fileFormat | Text or URL | v2, v3 | Media type, typically MIME format (see IANA site) of the content e.g. application/zip of a SoftwareApplication binary. In cases where a CreativeWork has several media type representations, 'encoding' can be used to indicate each MediaObject alongside particular fileFormat information. Unregistered or niche file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia entry. |
| fileSize | Text | v2, v3 | Size of the application / package (e.g. 18MB). In the absence of a unit (MB, KB etc.), KB will be assumed. |
| funder | Organization or Person | v2, v3 | A person or organization that supports (sponsors) something through some kind of financial contribution. |
| hasPart | CreativeWork | v2, v3 | Indicates a CreativeWork that is (in some sense) a part of this CreativeWork. Reverse property isPartOf |
| identifier | PropertyValue or URL | v2, v3 | The identifier property represents any kind of identifier for any kind of Thing, such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See background notes for more details. |
| installUrl | URL | v2, v3 | URL at which the app may be installed, if different from the URL of the item. |
| isAccessibleForFree | Boolean | v2, v3 | A flag to signal that the publication is accessible for free. |
| isPartOf | CreativeWork | v2, v3 | Indicates a CreativeWork that this CreativeWork is (in some sense) part of. Reverse property hasPart |
| keywords | Text | v2, v3 | Keywords or tags used to describe this content. Multiple entries in a keywords list are typically delimited by commas. |
| license | CreativeWork or URL | v2, v3 | A license document that applies to this content, typically indicated by URL. |
| memoryRequirements | Text or URL | v2, v3 | Minimum memory requirements. |
| name | Text | v2, v3 | The name of the item (software, Organization) |
| operatingSystem | Text | v2, v3 | Operating systems supported (Windows 7, OSX 10.6, Android 1.6). |
| permissions | Text | v2, v3 | Permission(s) required to run the app (for example, a mobile app may require full internet access or may run only on wifi). |
| position | Integer or Text | v2, v3 | The position of an item in a series or sequence of items. (While schema.org considers this a property of CreativeWork, it is also the way to indicate ordering in any list (e.g. the Authors list). By default arrays are unordered in JSON-LD |
| processorRequirements | Text | v2, v3 | Processor architecture required to run the application (e.g. IA64). |
| producer | Organization or Person | v2, v3 | The person or organization who produced the work (e.g. music album, movie, tv/radio series etc.). |
| programmingLanguage | ComputerLanguage or Text | v2, v3 | The computer programming language. |
| provider | Organization or Person | v2, v3 | The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller. Supersedes carrier. |
| publisher | Organization or Person | v2, v3 | The publisher of the creative work. |
| relatedLink | URL | v2, v3 | A link related to this object, e.g. related web pages |
| releaseNotes | Text or URL | v2, v3 | Description of what changed in this version. |
| review | Review | v3 | A review of the source code. |
| runtimePlatform | Text | v2, v3 | Runtime platform or script interpreter dependencies (Example - Java v1, Python2.3, .Net Framework 3.0). Supersedes runtime. |
| sameAs | URL | v2, v3 | URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website. |
| softwareHelp | CreativeWork | v2, v3 | Software application help. |
| softwareRequirements | SoftwareSourceCode | v2, v3 | Required software dependencies |
| softwareVersion | Text | v2, v3 | Version of the software instance. |
| sponsor | Organization or Person | v2, v3 | A person or organization that supports a thing through a pledge, promise, or financial contribution. e.g. a sponsor of a Medical Study or a corporate sponsor of an event. |
| storageRequirements | Text or URL | v2, v3 | Storage requirements (free space required). |
| supportingData | DataFeed | v2, v3 | Supporting data for a SoftwareApplication. |
| targetProduct | SoftwareApplication | v2, v3 | Target Operating System / Product to which the code applies. If applies to several versions, just the product name can be used. |
| url | URL | v2, v3 | URL of the item. |
| version | Number or Text | v2, v3 | The version of the CreativeWork embodied by a specified resource. |
These terms are all recognized properties of https://schema.org/SoftwareSourceCode or https://schema.org/SoftwareApplication Types. Note that while most properties take basic data types as values (Text, URL), several take other node types, such as Person, Organization, Review, or Role. Recommended fields for these node types in CodeMeta documents are given below.
| Property | Type | Versions | Description |
|---|---|---|---|
| address | PostalAddress or Text | v2, v3 | Physical address of the item. |
| affiliation | Organization | v2, v3 | An organization that this person is affiliated with. For example, a school/university |
| description | Text | v2, v3 | A description of the item. |
| Text | v2, v3 | Email address | |
| endDate | Date or Datetime | v3 | The end date and time of the item |
| familyName | Text | v2, v3 | Family name. In the U.S., the last name of an Person. This can be used along with givenName instead of the name property. |
| givenName | Text | v2, v3 | Given name. In the U.S., the first name of a Person. This can be used along with familyName instead of the name property |
| identifier | PropertyValue or URL | v2, v3 | The identifier property represents any kind of identifier for any kind of Thing, such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See background notes for more details. |
| identifier | URL | v2, v3 | URL identifier, ideally an ORCID ID for individuals, a FundRef ID for funders |
| name | Text | v2, v3 | The name of the item (software, Organization) |
| name | Text | v2, v3 | The name of an Organization, or if separate given and family names cannot be resolved for a Person |
| relatedLink | URL | v2, v3 | A link related to this object, e.g. related web pages |
| reviewAspect | Text | v3 | This Review is relevant to this part or facet of the object being review |
| reviewBody | The actual body of the review | v3 | |
| roleName | Text | v3 | URL |
| sameAs | URL | v2, v3 | URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website. |
| startDate | Date or Datetime | v3 | The start date and time of the item |
| url | URL | v2, v3 | URL of the item. |
Codemeta terms
The CodeMeta project also introduces the following additional properties, which lack clear equivalents in https://schema.org but can play an important role in software metadata records covered by the CodeMeta crosswalk.
| Property | Type | Versions | Description |
|---|---|---|---|
| buildInstructions | URL | v2, v3 | link to installation instructions/documentation |
| contIntegration | URL | v2 | link to continuous integration service |
| continuousIntegration | URL | v3 | link to continuous integration service |
| developmentStatus | Text | v2, v3 | Description of development status, e.g. Active, inactive, suspended. See repostatus.org |
| embargoDate | Date | v2 | Software may be embargoed from public access until a specified date (e.g. pending publication, 1 year from publication) |
| embargoEndDate | Date | v3 | Software may be embargoed from public access until a specified date (e.g. pending publication, 1 year from publication) |
| funding | Text | v2, v3 | Funding source (e.g. specific grant) |
| hasSourceCode | SoftwareSourceCode | v3 | Link that states where the software code is for a given software. For example a software registry may indicate that one of its software entries hasSourceCode in a GitHub repository. |
| isSourceCodeOf | SoftwareApplication | v3 | Link that states where software application is built from a given source code. This is the reverse property of 'hasSourceCode'. |
| issueTracker | URL | v2, v3 | link to software bug reporting or issue tracking system |
| maintainer | Person | v2, v3 | Individual responsible for maintaining the software (usually includes an email contact address) |
| readme | URL | v2, v3 | link to software Readme file |
| referencePublication | ScholarlyArticle | v2, v3 | An academic publication related to the software. |
| softwareSuggestions | SoftwareSourceCode | v2, v3 | Optional dependencies , e.g. for optional features, code development, etc. |
Please suggest additional terms or adjustments to this representation in the codemeta issues