[Schema Inaccuracy] example seemingly used as a pseudo-discriminator

[masklinn]

.components.schemas.environment.properties.protection_rules (and some other places I think) is defined as:

    "anyOf": [
      {
        "type": "object",
        "properties": {
          "id": { "type": "integer", "example": 3515 },
          "node_id": { "type": "string", "example": "MDQ6R2F0ZTM1MTU=" },
          "type": { "type": "string", "example": "wait_timer" },
          "wait_timer": { "$ref": "#/components/schemas/wait-timer" }
        },
        "required": [ "id", "node_id", "type" ]
      },
      {
        "type": "object",
        "properties": {
          "id": { "type": "integer", "example": 3515 },
          "node_id": { "type": "string", "example": "MDQ6R2F0ZTM1MTU=" },
          "type": { "type": "string", "example": "required_reviewers" },
          "reviewers": { ... }
        },
        "required": [ "id", "node_id", "type" ]
      },
      {
        "type": "object",
        "properties": {
          "id": { "type": "integer", "example": 3515 },
          "node_id": { "type": "string", "example": "MDQ6R2F0ZTM1MTU=" },
          "type": { "type": "string", "example": "branch_policy" }
        },
        "required": [ "id", "node_id", "type" ]
      }

The examples associated with the type property seem to be used as discriminator values (although without that being spelled out explicitely anywhere).

I understand OpenAPIv3 has a discriminator feature for exactly that use case.

[nickfloyd]

Please let us know if this work is still needed. We're trying to follow up on any older issues to make sure they get properly routed.

[masklinn]

Please let us know if this work is still needed. We're trying to follow up on any older issues to make sure they get properly routed.

As far as I can see the definition is still what I quoted originally: the type field of each "variant" has an example which seems to be used as (but is not documented as) a discriminator field. That is,

• the first object has a type with an example wait_timer, and references #/components/schemas/wait-timer
• the second object has a type with an example required_reviewers, and various reviewer-related exclusive properties
• the third object has a type with an example branch_policy (and that's it)

as it did back then, this strongly suggests type is an enum discriminator in disguise.

[nickfloyd]

@masklinn I have routed this issue to the internal owning API team for them to have a look.