Skip to content
This repository has been archived by the owner on Jun 19, 2022. It is now read-only.

Verify all our OpenAPI schemas are correct #662

Closed
nachocano opened this issue Mar 17, 2020 · 1 comment · Fixed by #871
Closed

Verify all our OpenAPI schemas are correct #662

nachocano opened this issue Mar 17, 2020 · 1 comment · Fixed by #871
Assignees
Labels
area/api APIs kind/bug Something isn't working kind/cleanup Internal cleanup (tech debt, etc) without customer impact, but affects developer velocity. priority/2 Nice to have feature but doesn't block current release defined by release/*
Milestone

Comments

@nachocano
Copy link
Member

Problem
Until we autogenerate the schemas, we should verify that they are actually accurate with what the underlying types say, and they should be structured as well.

Persona:
Which persona is this feature for?
Developer

Exit Criteria
Well-defined schemas

Time Estimate (optional):
1-2d

Additional context (optional)
By -oyamling a CRD, I got this:

    message: '[spec.validation.openAPIV3Schema.properties[spec].properties[sink].anyOf[0].properties[uri].type:
      Forbidden: must be empty to be structural, spec.validation.openAPIV3Schema.properties[spec].properties[sink].anyOf[0].type:
      Forbidden: must be empty to be structural, spec.validation.openAPIV3Schema.properties[spec].properties[sink].anyOf[1].properties[ref].properties[apiVersion].type:
      Forbidden: must be empty to be structural, spec.validation.openAPIV3Schema.properties[spec].properties[sink].anyOf[1].properties[ref].properties[kind].type:
      Forbidden: must be empty to be structural, spec.validation.openAPIV3Schema.properties[spec].properties[sink].anyOf[1].properties[ref].properties[name].type:
      Forbidden: must be empty to be structural, spec.validation.openAPIV3Schema.properties[spec].properties[sink].anyOf[1].properties[ref].type:
      Forbidden: must be empty to be structural, spec.validation.openAPIV3Schema.properties[spec].properties[sink].anyOf[1].type:
      Forbidden: must be empty to be structural, spec.validation.openAPIV3Schema.type:
      Required value: must not be empty at the root]'
    reason: Violations
    status: "True"
    type: NonStructuralSchema
@nachocano nachocano added kind/feature-request New feature or request area/api APIs kind/bug Something isn't working kind/cleanup Internal cleanup (tech debt, etc) without customer impact, but affects developer velocity. priority/2 Nice to have feature but doesn't block current release defined by release/* release/2 and removed kind/feature-request New feature or request release/2 labels Mar 17, 2020
@grantr grantr added this to the Backlog milestone Apr 21, 2020
@Harwayne
Copy link
Contributor

/assign

I took care of most of this via #614 and #615.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area/api APIs kind/bug Something isn't working kind/cleanup Internal cleanup (tech debt, etc) without customer impact, but affects developer velocity. priority/2 Nice to have feature but doesn't block current release defined by release/*
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants