Skip to content

[BUG]: Incorrect secret_scanning_alert values (OpenAPI schema) #806

Closed
@zegl

Description

@zegl

What happened?

The secret_scanning_alert resolution string is defined to allow both wont_fix and wontfix as values. In practice, the value can be wont_fix but not wontfix.

    "secret_scanning_alert$resolved": {
      "$schema": "http://json-schema.org/draft-07/schema",
      "type": "object",
      "required": ["action", "alert", "repository", "sender"],
      "properties": {
        "action": { "type": "string", "enum": ["resolved"] },
        "alert": {
          "allOf": [
            { "$ref": "#/definitions/secret-scanning-alert" },
            {
              "type": "object",
              "required": ["resolution", "resolved_by", "resolved_at"],
              "properties": {
                "resolution": {
                  "type": "string",
                  "enum": [
                    "false_positive",
                    "wontfix",
                    "revoked",
                    "used_in_tests"
                  ]
                },
                "resolved_by": { "$ref": "#/definitions/user" },
                "resolved_at": { "type": "string", "format": "date-time" }
              },
              "tsAdditionalProperties": false
            }
          ]
        },
        "repository": { "$ref": "#/definitions/repository" },
        "organization": { "$ref": "#/definitions/organization" },
        "installation": { "$ref": "#/definitions/installation-lite" },
        "sender": { "$ref": "#/definitions/user" }
      },
      "additionalProperties": false,
      "title": "secret_scanning_alert resolved event"
    },
        "resolution": {
          "type": ["string", "null"],
          "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert.",
          "enum": [
            "false_positive",
            "wont_fix",
            "revoked",
            "used_in_tests",
            null
          ]
        },

Versions

v7.0.2

Relevant log output

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type: BugSomething isn't working as documentedreleased

    Type

    No type

    Projects

    Status

    ✅ Done

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions