publiccode.yml RESTful validator API

API reference

Usage

go run main.go

Validate a publiccode.yml file

curl -X POST "http://localhost:3000/v1/validate" --data-binary "@./publiccode.yml"

curl -X QUERY "http://localhost:3000/v1/validate" \
--data-binary $'publiccodeYmlVersion: "0.5"\ndevelopmentStatus: stable\n [...]\n'

Run external validation checks

curl -X POST "http://localhost:3000/v1/validate?external-checks=true" \
--data-binary "@./publiccode.yml"

Example response (valid publiccode.yml)

{
  "valid": true,
  "normalized": "publiccodeYmlVersion: \"0\"\nname: Medusa\nurl: https://github.com/example/project.git\nreleaseDate: null\nplatforms:\n- web\ncategories:\n- cloud-management\ndevelopmentStatus: development\nsoftwareType: standalone/other\ndescription:\n  en-GB:\n    localisedName: Medusa\n    genericName: \"\"\n    shortDescription: |\n      A rather short description which is probably useless\n    longDescription: |\n      Very long description of this software, also split on multiple rows. You should note what the software is and why one should need it. This is 158 characters. Very long description of this software, also split on multiple rows. You should note what the software is and why one should need it. This is 316 characters. Very long description of this software, also split on multiple rows. You should note what the software is and why one should need it. This is 474 characters. Very long description of this software, also split on multiple rows. You should note what the software is and why one should need it. This is 632 characters.\n    features:\n    - Just one feature\nlegal:\n  license: AGPL-3.0-or-later\nmaintenance:\n  type: community\n  contacts:\n  - name: Francesco Rossi\nlocalisation:\n  localisationReady: true\n  availableLanguages:\n  - en\n",
  "results": []
}

Example response (with errors / warnings)

{
  "valid": false,
  "normalized": null,
  "results": [
    {
      "file": "",
      "key": "publiccodeYmlVersion",
      "description": "v0.2 is not the latest version, use '0'. Parsing this file as v0.8.",
      "line": 1,
      "column": 1,
      "type": "warning"
    },
    {
      "file": "",
      "key": "legal.license",
      "description": "license must be a valid license (see https://spdx.org/licenses)",
      "line": 39,
      "column": 3,
      "type": "error"
    }
  ]
}

Example error response

HTTP/1.1 400 Bad Request
Content-Type: application/problem+json

{
  "title": "empty body",
  "detail": "need a body to validate",
  "status": 400
}

Contributing

Maintainers

License