Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[openapi spec] All objects keyed by DestinyGender enum in schema are keyed by string instead. #1575

Open
paranoiacblack opened this issue Jan 4, 2022 · 0 comments

Comments

@paranoiacblack
Copy link

Similar to #1573, which mentions DestinyRecordTitleBlock.titlesByGender being incorrectly keyed according to the spec.

There are two additional objects in the schema that share this bug:

"Destiny.Definitions.DestinyRaceDefinition": {
        "type": "object",
        "properties": {
          "displayProperties": {
            "$ref": "#/components/schemas/Destiny.Definitions.Common.DestinyDisplayPropertiesDefinition"
          },
          "raceType": {
            "type": "integer",
            "description": "An enumeration defining the existing, known Races/Species for player characters. This value will be the enum value matching this definition.",
            "format": "int32",
            "x-enum-reference": {
              "$ref": "#/components/schemas/Destiny.DestinyRace"
            },
            "x-enum-is-bitmask": false
          },
          "genderedRaceNames": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            },
            "description": "A localized string referring to the singular form of the Race's name when referred to in gendered form. Keyed by the DestinyGender.",
            "x-dictionary-key": {
              "type": "integer",
              "format": "int32",
              "x-enum-reference": {
                "$ref": "#/components/schemas/Destiny.DestinyGender"
              },
              "x-enum-is-bitmask": false
            }
          },
...
}
"Destiny.Definitions.DestinyClassDefinition": {
        "type": "object",
        "properties": {
          "classType": {
            "type": "integer",
            "description": "In Destiny 1, we added a convenience Enumeration for referring to classes. We've kept it, though mostly for posterity. This is the enum value for this definition's class.",
            "format": "int32",
            "x-enum-reference": {
              "$ref": "#/components/schemas/Destiny.DestinyClass"
            },
            "x-enum-is-bitmask": false
          },
          "displayProperties": {
            "$ref": "#/components/schemas/Destiny.Definitions.Common.DestinyDisplayPropertiesDefinition"
          },
          "genderedClassNames": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            },
            "description": "A localized string referring to the singular form of the Class's name when referred to in gendered form. Keyed by the DestinyGender.",
            "x-dictionary-key": {
              "type": "integer",
              "format": "int32",
              "x-enum-reference": {
                "$ref": "#/components/schemas/Destiny.DestinyGender"
              },
              "x-enum-is-bitmask": false
            }
          },
...
}

Please update the schema by changing x-dictionary-key to string.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant