ConnOSS Profiles
Key to the specification tables
- Green properties are introduced by ConnOSS
- Red properties exist in schema.org
- Black properties are reused from external vocabularies (e.g. CodeMeta)
CD = Cardinality
Software Profile
Version: 1.0
Schema.org hierarchy: Thing > CreativeWork > SoftwareApplication / SoftwareSourceCode > connoss:Software
Extension to schema.org and CodeMeta to describe software source code, software applications, and software releases.
Software Required properties
| Property | Expected Type | Description | CD |
|---|---|---|---|
| name | Text | The name of the item (software, Organization). | ONE |
| description | Text | A short, clear text abstract or summary that describes what the software application does and its key features. | ONE |
| url | URL | URL of the item. | ONE |
| license | CreativeWork or URL | The legal license that governs the copying, modification, distribution, and execution of the software application, typically indicated by URL. | MANY |
| applicationDomain | DefinedTerm or Text or URL | The discipline, area, or research domain to which this software aligns or belongs to. | MANY |
Software Recommended properties
| Property | Expected Type | Description | CD |
|---|---|---|---|
| codeRepository | URL | Link to the version control system where the software is developed and maintained (e.g. SVN, GitHub, CodePlex, institutional GitLab instance, etc.). | MANY |
| programmingLanguage | ComputerLanguage or Text | The computer programming languages used to write the software or source code. | MANY |
| runtimePlatform | Text | The execution environment required to run the software, including script interpreters (e.g., Python 3.9), virtual machines (e.g., Java Virtual Machine v17), and managed frameworks (e.g. .NET Core 6.0). | MANY |
| applicationCategory | Text or URL | The high-level functional classification of the software application, indicating its primary computational purpose or technical utility (e.g., Simulation, Data Visualization, Statistical Analysis). | MANY |
| applicationSubCategory | Text or URL | A more granular technical or computational classification of the software (e.g., Agent-Based Modeling as a subcategory of Simulation & Modeling). | MANY |
| availableOnDevice | Text | The specific hardware device, architecture, or machine model required to execute the software. This property is used when the software cannot run on standard generic hardware and explicitly depends on specialized physical machinery, processors, or laboratory equipment. | MANY |
| downloadUrl | URL | The direct URL from which the software binary, compiled package, executable, or compressed distribution archive (e.g., .tar.gz, .whl, .exe, .dmg) can be downloaded. | MANY |
| memoryRequirements | Text or URL | The minimum amount of Random Access Memory (RAM) required to run the software or execute the pipeline. | ONE |
| operatingSystem | Text | The operating system(s) required to execute the software (e.g. Windows 7, OSX 10.6, Android 1.6). | MANY |
| processorRequirements | Text | Processor architecture required to run the application (e.g. IA64). | ONE |
| releaseNotes | Text or URL | Description of what changed in this version. | MANY |
| softwareHelp | CreativeWork | User guides, manuals, wikis, or help center pages that assist users in configuring and operating the software. | MANY |
| softwareRequirements | SoftwareSourceCode | External software components, libraries, frameworks, or runtime environments required for the application to function. | MANY |
| softwareVersion | Text | Version of the software instance. | ONE |
| storageRequirements | Text or URL | The minimum amount of persistent storage (disk space) required to install and execute the software. | ONE |
| author | Organization or Person | The person or organization that created the software. | MANY |
| contributor | Organization or Person | The person or organization that provided secondary contributions to the software. | MANY |
| copyrightHolder | Organization or Person | The person or organization that holds the legal copyright and intellectual property rights to the software application. | MANY |
| datePublished | Date | The date on which this specific version or release of the software application was officially made publicly available. | ONE |
| funder | Organization or Person | A person or organization that supports the development and maintenance of the software through financial contributions, grants, or sponsorships. | MANY |
| keywords | Text | Keywords, tags, or terms that describe the software application. | MANY |
| publisher | Organization or Person | The person or organization responsible for making the software application publicly available, distributing it, or managing its official archival publication. | MANY |
| identifier | PropertyValue or URL | A unique, unambiguous string, URL, or token that permanently and globally identifies the software application or a specific version of it, such as ISBNs, GTIN codes, UUIDs etc. | MANY |
| documentation | CreativeWork | Resources that describe the software's installation, usage, configuration, development, and deployment intended to support users and developers in understanding and applying the software. | MANY |
| contactPoint | ContactPoint | A contact point for this resource. | MANY |
| codemeta:buildInstructions | URL or CreativeWork | A link to the specific documentation, scripts, or instructions required to compile, build, or install the software application. | MANY |
| codemeta:developmentStatus | Text | A term describing the current maintenance and lifecycle status of the software application (e.g., active, inactive, suspended). | ONE |
| codemeta:maintainer | Person | Individual responsible for maintaining the software (usually includes an email contact address) | MANY |
| codemeta:readme | URL | link to software Readme file | MANY |
| codemeta:referencePublication | ScholarlyArticle | An academic publication related to the software. | MANY |
| intendedUse | Text | A concise summary of the primary objective or intended use case for the software. Distinct from general description; this focuses on 'why' the software exists and what problems it solves. | ONE |
| developerDocumentation | CreativeWork | Documentation for developers, maintainers, and infrastructure people. | MANY |
| userDocumentation | CreativeWork | Documentation for end users of the software. | MANY |
| softwareInterface | DefinedTerm or Text or Thing or URL | The interaction interfaces through which users or other software systems can access, execute, or integrate with software (e.g., CLI, GUI, WebUI, Notebook, API, Library). | MANY |
| input | FormalParameter | A formal specification of the data, files, or parameters that the software accepts as input, including format, type, and whether the input is required. | MANY |
| output | FormalParameter | A formal specification of the data, files, or results that the software produces, including format and type. | MANY |
| partOfCommunity | Organization or Text or URL | A (research) community, consortium, or network that this research artifact (e.g., software) is developed within or affiliated with (e.g., EOSC, NFDI). | MANY |
| latestRelease | Software or URL | Link to the latest release. | ONE |
| latestReleaseVersion | Text | Version of the latest release. | ONE |
Software Optional properties
| Property | Expected Type | Description | CD |
|---|---|---|---|
| targetProduct | SoftwareApplication | The specific operating system, platform, or parent software application to which the code or software applies, indicating compatibility or a target ecosystem (e.g., Linux, Windows 11, WordPress, MATLAB). If the software is compatible across multiple versions, the general product name can be used alone. | MANY |
| applicationSuite | Text | The name of the overarching software suite, distribution, or cohesive ecosystem to which the individual software application belongs. | MANY |
| countriesNotSupported | Text | The list of countries where the software application is not supported, cannot be legally distributed, or is technically restricted from operating. | MANY |
| countriesSupported | Text | The list of countries where the software application is explicitly supported, verified to work, or legally cleared for distribution. | MANY |
| featureList | Text or URL | A list of the core functionalities or modules provided by the software, including components that external pipelines or applications can depend upon. | MANY |
| installUrl | URL | URL at which the app may be installed, if different from the URL of the item. | MANY |
| permissions | Text | The explicit security privileges, access rights, or network authorizations required by the software to execute its functions successfully. | MANY |
| screenshot | ImageObject or URL | A URL pointing to an image demonstrating the software's user interface, command-line execution, or visual data output. | MANY |
| supportingData | DataFeed | Reference datasets, auxiliary data streams, or data feeds that are bundled with, or required by the software. | MANY |
| citation | CreativeWork or URL | A citation or reference to another creative work, such as another publication, web page, scholarly article, etc. | MANY |
| copyrightYear | Number | The year during which the claimed copyright for the software application was first asserted. | MANY |
| dateCreated | Date | The date on which the software application repository or initial source code project was first created. | ONE |
| dateModified | Date | The date on which the software application, source code repository, or specific release metadata was last updated or changed. | ONE |
| encodingFormat | Text or URL | The media type, serialization format, or specific data profile used to represent the software application or its associated packages. | MANY |
| hasPart | CreativeWork | Indicates a distinct creative work, component, or sub-module that is contained within this software application. | MANY |
| isAccessibleForFree | - | A flag to signal that the publication is accessible for free. | ONE |
| isPartOf | CreativeWork | Indicates a larger software ecosystem or overarching project that this software application is a sub-module, component, or integrated piece of. | MANY |
| sameAs | URL | 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. | MANY |
| relatedLink | URL | A link related to this object, e.g. related web pages | MANY |
| creditText | Text | Text that can be used to credit person(s) and/or organization(s) associated with a published Creative Work. | MANY |
| alternateName | Text | An alias for the resource. | ONE |
| archivedAt | URL or WebPage | A link to the archived version or archival location where the original content has been preserved (for CreativeWork, MediaReview, etc.) | ONE |
| conditionsOfAccess | Text | Conditions that affect the availability of, or method(s) of access to an item. Typically used for real world items such as an ArchiveComponent held by an ArchiveOrganization. | ONE |
| codemeta:continuousIntegration | URL | A link to the continuous integration (CI) service or build automation platform. | MANY |
| codemeta:embargoEndDate | Date | Software may be embargoed from public access until a specified date (e.g. pending publication, 1 year from publication) | ONE |
| codemeta:hasSourceCode | SoftwareSourceCode | 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. | MANY |
| codemeta:isSourceCodeOf | SoftwareApplication | Link that states where software application is built from a given source code. This is the reverse property of 'hasSourceCode'. | MANY |
| codemeta:issueTracker | URL | link to software bug reporting or issue tracking system. | MANY |
| legalConsiderations | Text | A documented concern, requirement, or consideration related to the software's design, deployment, or impact across legal and regulatory dimensions (e.g. licensing constraints, data protection, compliance requirements). Enables transparent disclosure of legal constraints and mitigation strategies. | MANY |
| ethicalSocialConsiderations | Text | A documented concern, requirement, or consideration related to the software's design, deployment, or impact across ethical and social dimensions. Enables transparent disclosure of constraints and mitigation strategies. | MANY |
| testedWith | TestAction | Links the software to a testing activity describing how the software is validated, including the test type, required inputs, and produced test results. | MANY |
| implementsSpecification | CreativeWork | A specification that a software implements, including a standard, API or legally defined level of conformance. e.g. the HTTP standard, the OpenAPI spec, OAuth2. | MANY |
| softwareContainer | URL or CreativeWork | A container image or packaged runtime environment of the software. | MANY |
TestAction Profile
Version: 1.0
Schema.org hierarchy: Thing > Action > connoss:TestAction
The act of testing the software according to its specifications, capturing the object tested, the resulting test report or outcome, and the type of test performed.
TestAction Required properties
| Property | Expected Type | Description | CD |
|---|---|---|---|
| testInput | - | Input used to performed the test. Some tests may not require any input, some may require multiple ones. If order or grouping is important in the case of multiple inputs, a ListItem could help. | MANY |
TestAction Recommended properties
| Property | Expected Type | Description | CD |
|---|---|---|---|
| testInstructions | - | Specific test instructions for testing the software. | MANY |
| testType | - | The type of test that it is performed on the object. | MANY |