[Schema Inaccuracy] minimal-repository.license.url may be null

[chohner]

Schema Inaccuracy

While using ajv to validate against the provided JSON Schema, I have found one repository where the url field of license is null - the JSON schema however insists on string.

Expected

I expect the data to match the provided schema, so either update minimal-repository.properties.license.properties.url to be type: ["string", "null"] or update the response to return "" on missing license URL.

Reproduction Steps

$ curl https://api.github.com/repos/digitalservicebund/AusweisApp2Wrapper-iOS-SPM

(...)
    "license": {
      "key": "other",
      "name": "Other",
      "spdx_id": "NOASSERTION",
      "url": null,
      "node_id": "MDc6TGljZW5zZTA="
    },
(...)

[MORTEZAMIRSALI]

Hello, don't be tired, my dear service, thank you for the good follow-up, I will update در تاریخ جمعه ۲۲ نوامبر ۲۰۲۴،‏ ۱۷:۱۳ chris ***@***.***> نوشت:

…

Schema Inaccuracy While using ajv to validate against the provided JSON Schema, I have found one repository where the url field of license is null - the JSON schema however insists on string. Expected I expect the data to match the provided schema, so either update minimal-repository.properties.license.properties.url to be type: ["string", "null"] or update the response to return "" on missing license URL. Reproduction Steps $ curl https://api.github.com/repos/digitalservicebund/AusweisApp2Wrapper-iOS-SPM (...) "license": { "key": "other", "name": "Other", "spdx_id": "NOASSERTION", "url": null, "node_id": "MDc6TGljZW5zZTA=" }, (...) — Reply to this email directly, view it on GitHub <#4310>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/BKQVIIYF67XGR7S2KL4YMHL2B4YGVAVCNFSM6AAAAABSJMIXF2VHI2DSMVQWIX3LMV43ASLTON2WKOZSGY4DGMRVHE2TAMY> . You are receiving this because you are subscribed to this thread.Message ID: ***@***.***>

[jchuerva]

👋 Hi,

The API doc mention the license url field can be null:

[chohner]

The image seems to be broken but I assume you are referring to the schema from GET /repos/{owner}/{repo}.

The schema referenced there is the full-respository schema, which indeed includes the correct sub-schema for license (with a nullable url field):

"license": {
  "anyOf": [
    {
      "type": "null"
    },
    {
      "title": "License Simple",
      "description": "License Simple",
      "type": "object",
      "properties": {
        (...)
        "url": {
          "type": [
            "string",
            "null"
          ],
          "format": "uri",
          "examples": [
            "https://api.github.com/licenses/mit"
          ]
        },
        (...)
      }
    }
  ]
}

The minimal-repository schema as returned by GET /orgs/{org}/repos does not