credit_translation_schema.json

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "$id": "https://github.com/contributorshipcollaboration/credit-translation/blob/main/credit_translation_schema.json",
    "title": "JSON schema for CRediT translation",
    "version": "1.0",
    "type": "object",
    "properties": {
        "metadata": {
            "type": "object",
            "properties": {
                "languageCode": {
                    "type": "string",
                    "pattern": "^[a-zA-Z]{2,3}$",
                    "description": "The language code of the metadata (ISO 639-2 compatible)"
                },
                "languageName": {
                    "type": "string",
                    "description": "The full name of the language"
                },
                "translators": {
                    "type": "array",
                    "items": {"$ref": "#/definitions/translator"},
                    "description": "List of identifying information on each translator"
                },
                "translationProcedure": {
                    "type": "string",
                    "description": "Free-text description of the translation procedure"
                }
            },
            "required": [
                "languageCode", "languageName", "translators", "translationProcedure"
            ]
        },
        "translations": {
            "type": "object",
            "properties": {
                "Conceptualization": {
                    "type": "object",
                    "properties": {
                        "description": {
                            "const": "Ideas; formulation or evolution of overarching research goals and aims."
                        },
                        "id": {
                            "const": "8b73531f-db56-4914-9502-4cc4d4d8ed73"
                        },
                        "translation": {
                            "$ref": "#/definitions/roleTranslation"
                        }
                    },
                    "required": [
                        "description",
                        "id",
                        "translation"
                    ]
                },
                "Data Curation": {
                    "type": "object",
                    "properties": {
                        "description": {
                            "const": "Management activities to annotate (produce metadata), scrub data and maintain research data (including software code, where it is necessary for interpreting the data itself) for initial use and later re-use."
                        },
                        "id": {
                            "const": "f93e0f44-f2a4-4ea1-824a-4e0853b05c9d"
                        },
                        "translation": {
                            "$ref": "#/definitions/roleTranslation"
                        }
                    },
                    "required": [
                        "description",
                        "id",
                        "translation"
                    ]
                },
                "Formal Analysis": {
                    "type": "object",
                    "properties": {
                        "description": {
                            "const": "Application of statistical, mathematical, computational, or other formal techniques to analyse or synthesize study data."
                        },
                        "id": {
                            "const": "95394cbd-4dc8-4735-b589-7e5f9e622b3f"
                        },
                        "translation": {
                            "$ref": "#/definitions/roleTranslation"
                        }
                    },
                    "required": [
                        "description",
                        "id",
                        "translation"
                    ]
                },
                "Funding Acquisition": {
                    "type": "object",
                    "properties": {
                        "description": {
                            "const": "Acquisition of the financial support for the project leading to this publication."
                        },
                        "id": {
                            "const": "34ff6d68-132f-4438-a1f4-fba61ccf364a"
                        },
                        "translation": {
                            "$ref": "#/definitions/roleTranslation"
                        }
                    },
                    "required": [
                        "description",
                        "id",
                        "translation"
                    ]
                },
                "Investigation": {
                    "type": "object",
                    "properties": {
                        "description": {
                            "const": "Conducting a research and investigation process, specifically performing the experiments, or data/evidence collection."
                        },
                        "id": {
                            "const": "2451924d-425e-4778-9f4c-36c848ca70c2"
                        },
                        "translation": {
                            "$ref": "#/definitions/roleTranslation"
                        }
                    },
                    "required": [
                        "description",
                        "id",
                        "translation"
                    ]
                },
                "Methodology": {
                    "type": "object",
                    "properties": {
                        "description": {
                            "const": "Development or design of methodology; creation of models."
                        },
                        "id": {
                            "const": "f21e2be9-4e38-4ab7-8691-d6f72d5d5843"
                        },
                        "translation": {
                            "$ref": "#/definitions/roleTranslation"
                        }
                    },
                    "required": [
                        "description",
                        "id",
                        "translation"
                    ]
                },
                "Project Administration": {
                    "type": "object",
                    "properties": {
                        "description": {
                            "const": "Management and coordination responsibility for the research activity planning and execution."
                        },
                        "id": {
                            "const": "a693fe76-ea33-49ad-9dcc-5e4f3ac5f938"
                        },
                        "translation": {
                            "$ref": "#/definitions/roleTranslation"
                        }
                    },
                    "required": [
                        "description",
                        "id",
                        "translation"
                    ]
                },
                "Resources": {
                    "type": "object",
                    "properties": {
                        "description": {
                            "const": "Provision of study materials, reagents, materials, patients, laboratory samples, animals, instrumentation, computing resources, or other analysis tools."
                        },
                        "id": {
                            "const": "ebd781f0-bf79-492c-ac21-b31b9c3c990c"
                        },
                        "translation": {
                            "$ref": "#/definitions/roleTranslation"
                        }
                    },
                    "required": [
                        "description",
                        "id",
                        "translation"
                    ]
                },
                "Software": {
                    "type": "object",
                    "properties": {
                        "description": {
                            "const": "Programming, software development; designing computer programs; implementation of the computer code and supporting algorithms; testing of existing code components."
                        },
                        "id": {
                            "const": "f89c5233-01b0-4778-93e9-cc7d107aa2c8"
                        },
                        "translation": {
                            "$ref": "#/definitions/roleTranslation"
                        }
                    },
                    "required": [
                        "description",
                        "id",
                        "translation"
                    ]
                },
                "Supervision": {
                    "type": "object",
                    "properties": {
                        "description": {
                            "const": "Oversight and leadership responsibility for the research activity planning and execution, including mentorship external to the core team."
                        },
                        "id": {
                            "const": "0c8ca7d4-06ad-4527-9cea-a8801fcb8746"
                        },
                        "translation": {
                            "$ref": "#/definitions/roleTranslation"
                        }
                    },
                    "required": [
                        "description",
                        "id",
                        "translation"
                    ]
                },
                "Validation": {
                    "type": "object",
                    "properties": {
                        "description": {
                            "const": "Verification, whether as a part of the activity or separate, of the overall replication/reproducibility of results/experiments and other research outputs."
                        },
                        "id": {
                            "const": "4b1bf348-faf2-4fc4-bd66-4cd3a84b9d44"
                        },
                        "translation": {
                            "$ref": "#/definitions/roleTranslation"
                        }
                    },
                    "required": [
                        "description",
                        "id",
                        "translation"
                    ]
                },
                "Visualization": {
                    "type": "object",
                    "properties": {
                        "description": {
                            "const": "Preparation, creation and/or presentation of the published work, specifically visualization/data presentation."
                        },
                        "id": {
                            "const": "76b9d56a-e430-4e0a-84c9-59c11be343ae"
                        },
                        "translation": {
                            "$ref": "#/definitions/roleTranslation"
                        }
                    },
                    "required": [
                        "description",
                        "id",
                        "translation"
                    ]
                },
                "Writing – Original Draft Preparation": {
                    "type": "object",
                    "properties": {
                        "description": {
                            "const": "Preparation, creation and/or presentation of the published work, specifically writing the initial draft (including substantive translation)."
                        },
                        "id": {
                            "const": "43ebbd94-98b4-42f1-866b-c930cef228ca"
                        },
                        "translation": {
                            "$ref": "#/definitions/roleTranslation"
                        }
                    },
                    "required": [
                        "description",
                        "id",
                        "translation"
                    ]
                },
                "Writing – Review & Editing": {
                    "type": "object",
                    "properties": {
                        "description": {
                            "const": "Preparation, creation and/or presentation of the published work by those from the original research group, specifically critical review, commentary or revision – including pre- or post-publication stages."
                        },
                        "id": {
                            "const": "d3aead86-f2a2-47f7-bb99-79de6421164d"
                        },
                        "translation": {
                            "$ref": "#/definitions/roleTranslation"
                        }
                    },
                    "required": [
                        "description",
                        "id",
                        "translation"
                    ]
                }
            },
            "required": [
                "Conceptualization",
                "Data Curation",
                "Formal Analysis",
                "Funding Acquisition",
                "Investigation",
                "Methodology",
                "Project Administration",
                "Resources",
                "Software",
                "Supervision",
                "Validation",
                "Visualization",
                "Writing – Original Draft Preparation",
                "Writing – Review & Editing"
            ]
        }
    },
    "required": [
        "metadata",
        "translations"
    ],
    "additionalProperties": false,
    "definitions": {
        "roleTranslation": {
            "type": "object",
            "properties": {
                "name": {
                    "type": "string",
                    "description": "Translation of the role name"
                },
                "description": {
                    "type": "string",
                    "description": "Translation of the role description"
                }
            },
            "required": [
                "name",
                "description"
            ]
        },
        "translator": {
            "type": "object",
            "properties": {
                "firstName": {
                    "type": "string",
                    "description": "First name of the translator"
                },
                "lastName": {
                    "type": "string",
                    "description": "Last name of the translator"
                },
                "middleName": {
                    "type": "string",
                    "description": "Middle name of the translator"
                },
                "ORCID": {
                    "type": "string",
                    "description": "ORCID of the translator"
                }
            },
            "required": ["firstName", "lastName"]
        }
    }
}