Repository

An open source repository

Dialect2020-12

Typeobject

Eigenschappen

Eigenschappen van het JSON Schema
Eigenschap	Type	Verplicht	Beschrijving en details
archived	`boolean`	Nee	Whether the repository is archived and hidden from default repository listings.
forkType	`string`	Nee	Fork classification of the repository, derived from the fork flag of the code hosting platform and the `url` and `isBasedOn` keys in its publiccode.yml: - `TECHNICAL_FORK`: a fork created to contribute changes back to the original software. Its publiccode.yml still describes the original: the `url` points to the original repository. - `VARIANT_FORK`: a fork that is maintained as separate software. Its publiccode.yml has its own `url` and refers to the original software in `isBasedOn`. - `GIT_FORK`: marked as a fork by the code hosting platform, without publiccode.yml metadata that identifies it as a technical fork or a variant. - `URL_MISTAKE`: not marked as a fork, but the `url` in its publiccode.yml points to a different repository. The repository is either an unmarked fork, or the `url` was filled in incorrectly. Enum: TECHNICAL_FORK, VARIANT_FORK, GIT_FORK, URL_MISTAKE
lastActivityAt	`string`	Nee	- Format: date-time
longDescription	`string`	Nee	Long description of the repository, typically from publiccode.yml.
name	`string`	Nee	Name of the repository from the git hosting. Used as a fallback when no publiccode.yml is available.
organisation	`$ref`	Ja	- $ref: organisation
publiccode	`object`	Nee	Mandatory and conditionally mandatory fields extracted from publiccode.yml v0.5.0.
publiccode.dependsOn	`object`	Nee	-
publiccode.dependsOn.hardware	`array`	Nee	- Items type: object
publiccode.dependsOn.hardware[].name	`string`	Ja	-
publiccode.dependsOn.open	`array`	Nee	- Items type: object
publiccode.dependsOn.open[].name	`string`	Ja	-
publiccode.dependsOn.proprietary	`array`	Nee	- Items type: object
publiccode.dependsOn.proprietary[].name	`string`	Ja	-
publiccode.description	`object`	Ja	Localized description blocks keyed by language tag.
publiccode.developmentStatus	`string`	Ja	Development status from publiccode.yml. Enum: concept, development, beta, stable, obsolete
publiccode.fundedBy	`array`	Nee	- Items type: object
publiccode.fundedBy[].name	`string`	Nee	-
publiccode.landingURL	`string`	Nee	Landing page URL from publiccode.yml. Format: uri
publiccode.legal	`object`	Ja	-
publiccode.legal.license	`string`	Ja	SPDX license expression.
publiccode.localisation	`object`	Ja	-
publiccode.localisation.availableLanguages	`array`	Ja	- Items type: string
publiccode.localisation.localisationReady	`boolean`	Ja	-
publiccode.maintenance	`object`	Ja	This section provides information on the maintenance status of the software, useful to evaluate whether the software is actively developed or not.
publiccode.maintenance.contacts	`array`	Nee	- Items type: object
publiccode.maintenance.contacts[].name	`string`	Ja	-
publiccode.maintenance.contractors	`array`	Nee	- Items type: object
publiccode.maintenance.contractors[].name	`string`	Ja	-
publiccode.maintenance.contractors[].until	`string`	Ja	- Format: date
publiccode.maintenance.type	`string`	Ja	- Enum: internal, contract, community, none
publiccode.name	`string`	Ja	Software name from publiccode.yml.
publiccode.organisation	`object`	Nee	-
publiccode.organisation.uri	`string`	Ja	The unique identifier for an organisation Format: uri
publiccode.platforms	`array`	Ja	Supported platforms. Items type: string
publiccode.publiccodeYmlVersion	`string`	Ja	Version of the publiccode.yml schema. Enum: 0, 0.2, 0.2.0, 0.2.1, 0.2.2, 0.3, 0.3.0, 0.4, 0.4.0, 0.5, 0.5.0
publiccode.softwareType	`string`	Ja	Software type from publiccode.yml. Enum: standalone/mobile, standalone/iot, standalone/desktop, standalone/web, standalone/backend, standalone/other, addon, library, configurationFiles
publiccode.url	`string`	Ja	Repository or project URL from publiccode.yml. Format: uri
publiccodeUrl	`string`	Nee	URL of publiccode.yml in the repository.
shortDescription	`string`	Nee	Description of the repository from the git hosting (e.g. the repository description). Used as a fallback when no publiccode.yml is available.
url	`string`	Ja	URL of the source code repository. Format: uri

JSON Schema

{
  "$id": "https://schemas.developer.overheid.nl/schemas/don/repository",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "An open source repository",
  "properties": {
    "archived": {
      "description": "Whether the repository is archived and hidden from default repository listings.",
      "examples": [
        false,
        true
      ],
      "type": "boolean"
    },
    "forkType": {
      "description": "Fork classification of the repository, derived from the fork flag of the code hosting platform and the `url` and `isBasedOn` keys in its publiccode.yml:\n\n- `TECHNICAL_FORK`: a fork created to contribute changes back to the original software. Its publiccode.yml still describes the original: the `url` points to the original repository.\n- `VARIANT_FORK`: a fork that is maintained as separate software. Its publiccode.yml has its own `url` and refers to the original software in `isBasedOn`.\n- `GIT_FORK`: marked as a fork by the code hosting platform, without publiccode.yml metadata that identifies it as a technical fork or a variant.\n- `URL_MISTAKE`: not marked as a fork, but the `url` in its publiccode.yml points to a different repository. The repository is either an unmarked fork, or the `url` was filled in incorrectly.",
      "enum": [
        "TECHNICAL_FORK",
        "VARIANT_FORK",
        "GIT_FORK",
        "URL_MISTAKE"
      ],
      "examples": [
        "GIT_FORK",
        "VARIANT_FORK"
      ],
      "type": "string"
    },
    "lastActivityAt": {
      "examples": [
        "2026-10-14T09:01:52Z",
        "2026-09-30T15:42:10+02:00"
      ],
      "format": "date-time",
      "type": "string"
    },
    "longDescription": {
      "description": "Long description of the repository, typically from publiccode.yml.",
      "examples": [
        "The OAS Generator creates an OpenAPI document from a short configuration that complies with the Dutch API Design Rules. The document serves as a starting point for developing government APIs.",
        "Application for residents of The Hague to apply for and manage parking permits."
      ],
      "type": "string"
    },
    "name": {
      "description": "Name of the repository from the git hosting. Used as a fallback when no publiccode.yml is available.",
      "examples": [
        "oas-generator",
        "parkeren"
      ],
      "type": "string"
    },
    "organisation": {
      "$ref": "organisation"
    },
    "publiccode": {
      "additionalProperties": false,
      "description": "Mandatory and conditionally mandatory fields extracted from publiccode.yml v0.5.0.",
      "properties": {
        "dependsOn": {
          "additionalProperties": false,
          "properties": {
            "hardware": {
              "items": {
                "additionalProperties": false,
                "properties": {
                  "name": {
                    "examples": [
                      "Raspberry Pi",
                      "NVIDIA GPU"
                    ],
                    "type": "string"
                  }
                },
                "required": [
                  "name"
                ],
                "type": "object"
              },
              "type": "array"
            },
            "open": {
              "items": {
                "additionalProperties": false,
                "properties": {
                  "name": {
                    "examples": [
                      "PostgreSQL",
                      "Node.js"
                    ],
                    "type": "string"
                  }
                },
                "required": [
                  "name"
                ],
                "type": "object"
              },
              "type": "array"
            },
            "proprietary": {
              "items": {
                "additionalProperties": false,
                "properties": {
                  "name": {
                    "examples": [
                      "Microsoft SQL Server",
                      "Oracle Database"
                    ],
                    "type": "string"
                  }
                },
                "required": [
                  "name"
                ],
                "type": "object"
              },
              "type": "array"
            }
          },
          "type": "object"
        },
        "description": {
          "additionalProperties": {
            "additionalProperties": false,
            "properties": {
              "features": {
                "items": {
                  "examples": [
                    "OpenAPI-document genereren uit een korte configuratie",
                    "Invoer valideren tegen een schema"
                  ],
                  "type": "string"
                },
                "type": "array"
              },
              "longDescription": {
                "examples": [
                  "De OAS Generator maakt op basis van een korte configuratie een OpenAPI-document dat voldoet aan de API Design Rules. Het document dient als startpunt voor het ontwikkelen van API's voor de overheid.",
                  "The OAS Generator creates an OpenAPI document from a short configuration that complies with the Dutch API Design Rules. The document serves as a starting point for developing government APIs."
                ],
                "maxLength": 10000,
                "minLength": 150,
                "type": "string"
              },
              "shortDescription": {
                "examples": [
                  "Genereert een OpenAPI-document dat voldoet aan de API Design Rules.",
                  "Generates an OpenAPI document that complies with the API Design Rules."
                ],
                "maxLength": 150,
                "type": "string"
              }
            },
            "required": [
              "shortDescription"
            ],
            "type": "object"
          },
          "description": "Localized description blocks keyed by language tag.",
          "type": "object"
        },
        "developmentStatus": {
          "description": "Development status from publiccode.yml.",
          "enum": [
            "concept",
            "development",
            "beta",
            "stable",
            "obsolete"
          ],
          "examples": [
            "beta",
            "stable"
          ],
          "type": "string"
        },
        "fundedBy": {
          "items": {
            "additionalProperties": false,
            "properties": {
              "name": {
                "examples": [
                  "Ministerie van Binnenlandse Zaken en Koninkrijksrelaties",
                  "Gemeente Den Haag"
                ],
                "type": "string"
              }
            },
            "type": "object"
          },
          "type": "array"
        },
        "landingURL": {
          "description": "Landing page URL from publiccode.yml.",
          "examples": [
            "https://developer-overheid-nl.github.io/oas-generator/",
            "https://www.denhaag.nl/parkeren"
          ],
          "format": "uri",
          "type": "string"
        },
        "legal": {
          "additionalProperties": false,
          "properties": {
            "license": {
              "description": "SPDX license expression.",
              "examples": [
                "EUPL-1.2",
                "MIT"
              ],
              "type": "string"
            }
          },
          "required": [
            "license"
          ],
          "type": "object"
        },
        "localisation": {
          "additionalProperties": false,
          "properties": {
            "availableLanguages": {
              "items": {
                "examples": [
                  "nl",
                  "en"
                ],
                "type": "string"
              },
              "type": "array"
            },
            "localisationReady": {
              "examples": [
                true,
                false
              ],
              "type": "boolean"
            }
          },
          "required": [
            "localisationReady",
            "availableLanguages"
          ],
          "type": "object"
        },
        "maintenance": {
          "additionalProperties": false,
          "description": "This section provides information on the maintenance status of the software, useful to evaluate whether the software is actively developed or not.",
          "properties": {
            "contacts": {
              "items": {
                "additionalProperties": false,
                "properties": {
                  "name": {
                    "examples": [
                      "Developer Overheid",
                      "Team Parkeren"
                    ],
                    "type": "string"
                  }
                },
                "required": [
                  "name"
                ],
                "type": "object"
              },
              "type": "array"
            },
            "contractors": {
              "items": {
                "additionalProperties": false,
                "properties": {
                  "name": {
                    "examples": [
                      "Geonovum",
                      "Logius"
                    ],
                    "type": "string"
                  },
                  "until": {
                    "examples": [
                      "2027-12-31",
                      "2026-06-30"
                    ],
                    "format": "date",
                    "type": "string"
                  }
                },
                "required": [
                  "name",
                  "until"
                ],
                "type": "object"
              },
              "type": "array"
            },
            "type": {
              "enum": [
                "internal",
                "contract",
                "community",
                "none"
              ],
              "examples": [
                "internal",
                "contract"
              ],
              "type": "string"
            }
          },
          "required": [
            "type"
          ],
          "type": "object"
        },
        "name": {
          "description": "Software name from publiccode.yml.",
          "examples": [
            "OAS Generator",
            "Parkeren"
          ],
          "type": "string"
        },
        "organisation": {
          "additionalProperties": false,
          "properties": {
            "uri": {
              "description": "The unique identifier for an organisation",
              "examples": [
                "https://identifier.overheid.nl/tooi/id/gemeente/gm0518",
                "https://identifier.overheid.nl/tooi/id/gemeente/gm0142"
              ],
              "format": "uri",
              "type": "string"
            }
          },
          "required": [
            "uri"
          ],
          "type": "object"
        },
        "platforms": {
          "description": "Supported platforms.",
          "items": {
            "examples": [
              "web",
              "linux"
            ],
            "type": "string"
          },
          "type": "array"
        },
        "publiccodeYmlVersion": {
          "description": "Version of the publiccode.yml schema.",
          "enum": [
            "0",
            "0.2",
            "0.2.0",
            "0.2.1",
            "0.2.2",
            "0.3",
            "0.3.0",
            "0.4",
            "0.4.0",
            "0.5",
            "0.5.0"
          ],
          "examples": [
            "0.5",
            "0.4"
          ],
          "type": "string"
        },
        "softwareType": {
          "description": "Software type from publiccode.yml.",
          "enum": [
            "standalone/mobile",
            "standalone/iot",
            "standalone/desktop",
            "standalone/web",
            "standalone/backend",
            "standalone/other",
            "addon",
            "library",
            "configurationFiles"
          ],
          "examples": [
            "standalone/web",
            "library"
          ],
          "type": "string"
        },
        "url": {
          "description": "Repository or project URL from publiccode.yml.",
          "examples": [
            "https://github.com/developer-overheid-nl/oas-generator",
            "https://gitlab.com/gemeente-den-haag/parkeren"
          ],
          "format": "uri",
          "type": "string"
        }
      },
      "required": [
        "publiccodeYmlVersion",
        "name",
        "url",
        "platforms",
        "developmentStatus",
        "softwareType",
        "description",
        "legal",
        "maintenance",
        "localisation"
      ],
      "type": "object"
    },
    "publiccodeUrl": {
      "description": "URL of publiccode.yml in the repository.",
      "examples": [
        "https://github.com/developer-overheid-nl/oas-generator/blob/main/publiccode.yml",
        "https://gitlab.com/gemeente-den-haag/parkeren/-/blob/main/publiccode.yml"
      ],
      "type": "string"
    },
    "shortDescription": {
      "description": "Description of the repository from the git hosting (e.g. the repository description). Used as a fallback when no publiccode.yml is available.",
      "examples": [
        "Generator for OpenAPI documents that comply with the API Design Rules",
        "Parking permits for residents"
      ],
      "type": "string"
    },
    "url": {
      "description": "URL of the source code repository.",
      "examples": [
        "https://github.com/developer-overheid-nl/oas-generator",
        "https://gitlab.com/gemeente-den-haag/parkeren"
      ],
      "format": "uri",
      "type": "string"
    }
  },
  "required": [
    "url",
    "organisation"
  ],
  "title": "Repository",
  "type": "object"
}

Schema gebruiken

JSON Schema

Bundled JSON Schema

Open in JSON Schema Viewer

Dependencies

Gebruikt door dit schema
Schema	Locatie
Organisation	`/properties/organisation/$ref`

Dit schema wordt niet door andere schema's gebruikt.

Health issues

Health issues
Message	Pointer
Set a non-empty examples array at the top level of the schema to illustrate the expected data
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/archived/description`
Setting `type` alongside `enum` is considered an anti-pattern, as the enumeration choices already imply their respective types	`/properties/forkType/enum – /properties/forkType/type`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/forkType/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/longDescription/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/name/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/publiccode/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/publiccode/properties/description/description`
Setting `type` alongside `enum` is considered an anti-pattern, as the enumeration choices already imply their respective types	`/properties/publiccode/properties/developmentStatus/enum – /properties/publiccode/properties/developmentStatus/type`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/publiccode/properties/developmentStatus/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/publiccode/properties/landingURL/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/publiccode/properties/legal/properties/license/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/publiccode/properties/maintenance/description`
Setting `type` alongside `enum` is considered an anti-pattern, as the enumeration choices already imply their respective types	`/properties/publiccode/properties/maintenance/properties/type/enum – /properties/publiccode/properties/maintenance/properties/type/type`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/publiccode/properties/name/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/publiccode/properties/platforms/description`
Setting `type` alongside `enum` is considered an anti-pattern, as the enumeration choices already imply their respective types	`/properties/publiccode/properties/publiccodeYmlVersion/enum – /properties/publiccode/properties/publiccodeYmlVersion/type`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/publiccode/properties/publiccodeYmlVersion/description`
Setting `type` alongside `enum` is considered an anti-pattern, as the enumeration choices already imply their respective types	`/properties/publiccode/properties/softwareType/enum – /properties/publiccode/properties/softwareType/type`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/publiccode/properties/softwareType/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/publiccode/properties/url/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/publiccodeUrl/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/shortDescription/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/url/description`

Schema-register: Repository

Details van JSON Schema: Repository

Details van JSON Schema: Repository

Beschrijving