Skip to content

[#26] Perform a comprehensive review of KZOP validations vs those called for in the specification#208

Open
andylowry wants to merge 1 commit intomasterfrom
task/26
Open

[#26] Perform a comprehensive review of KZOP validations vs those called for in the specification#208
andylowry wants to merge 1 commit intomasterfrom
task/26

Conversation

@andylowry
Copy link
Copy Markdown
Contributor

Steps:

  1. Catalog all validations in a YAML document
  2. Generate reports and whatever code may be helpful from the catalog (e.g. creating a means of ensuring that every level-3 validation is represented in the code).
  3. Remove explicit "required" property checks by incorporating requiredness into the types model and automating them (except where requiredness is contextual, e.g. in SecurityScheme).
  4. Correct existing validations as needed, tag them with validation ids, and add missing validations.
  5. (Hopefully in coordination with the OAS compliance initiative) Develop tests of all level-3 validations, and representative level-2 validations (assuming they are all automated), checking both for false negatives and false positives.

Not all the above will necessarily be done as part of this PR.

YAML file produced from a careful review of the 3.0.2 specification,
capturing level-2 validations in model object & field specifications.
Level-3 validations appear in free text blocks attached to object
defintions. Those not appearing in the specification but seemingly
needed, are marked with "inSpecification: false". There are also
"notes", mostly attached to object definitions, describing issues that
maybe ought to be addressed in future revisions of the specification.
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

Successfully merging this pull request may close these issues.

1 participant