Invalid Syntax in securityLevels

[datsirul]

The file beaconConfigurationSchema.yaml contains invalid OpenAPI syntax in it's default value.

Existing Syntax:

securityLevels:
    description: All access levels supported by the Beacon. Any combination is
      valid, as every option would apply to different parts of the Beacon.
    type: array
    items:
      enum:
        - PUBLIC
        - REGISTERED
        - CONTROLLED
      default:
        - CONTROLLED

Corrected Syntax:
The default value should be defined at the same level as the other properties under securityLevels:

securityLevels:
  description: All access levels supported by the Beacon. Any combination is
    valid, as every option would apply to different parts of the Beacon.
  type: array
  items:
    type: string
    enum:
      - PUBLIC
      - REGISTERED
      - CONTROLLED
  default:
    - CONTROLLED

Reference:
OpenAPI Specification - Describing Parameters - Default Parameter Values

Note:
After fixing the .yaml files, the .json should be fixed as well by running the schema conversion script located in the bin folder.

[jrambla]

Seems fine to me. PR, please

[mbaudis]

+1

[redmitry]

I am confused...
beaconConfigurationSchema.yaml is a Json Schema and has nothing with OpenAPI.
Although the "default" is just an annotation that doesn't interfere the validation, it's recommended to be valid against the schema. Unlike its Json counterpart:
beaconConfigurationSchema.json, yaml defaults to String and not an array of Strings, so IMHO this could be the root of the problem with the OpenAPI's tool.

I would add the "uniqueItems": true as it is wrong to have ["PUBLIC", "PUBLIC"].

    type: array
    items:
      enum:
        - PUBLIC
        - REGISTERED
        - CONTROLLED
    default:
        - [CONTROLLED]
    uniqueItems: true

CORRECTED!
Yeah! Of course default: [] and uniqueItems should be on the array level...

[mbaudis]

• the default parameter is at the root level of the object as @datsirul pointed out (it is not a default for the items...)
• it is correct in the JSON version which emphasizes the correct way to do the code editing as @datsirul always adds to his issues (+1):

Note: After fixing the .yaml files, the .json should be fixed as well by running the schema conversion script located in the bin folder.

    type: array
    default:
      - CONTROLLED
    items:
      enum:
        - PUBLIC
        - REGISTERED
        - CONTROLLED

[datsirul]

I've reviewed the syntax again and it seem that these two options are valid and similar:

        default:
          - CONTROLLED

        default: [CONTROLLED]

And after running the beacon yamler, both of them outputted the expected json default array with one value.

When using this syntax - - CONTROLLED it generated an array of an array: "default": [["CONTROLLED"]].
I'll create a PR with - CONTROLLED to keep a cohesive structure with the rest of the code.

[mbaudis]

@datsirul Oh well, yes. I got confused by @redmitry ╮(╯▽╰)╭ because this was the issue in another discussion (the lists of lists in examples where this would be the case). Fixed my comment above.