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

Insistences between Spec and manifest/yaml Validation #288

Open
aaranmcguire opened this issue Feb 14, 2024 · 2 comments
Open

Insistences between Spec and manifest/yaml Validation #288

aaranmcguire opened this issue Feb 14, 2024 · 2 comments
Labels
bug Something isn't working

Comments

@aaranmcguire
Copy link
Contributor

aaranmcguire commented Feb 14, 2024

Summary

I've been reading the spec, and noticed within the SLO type, the docs say timeWindow is optional. This is echoed in the OpenAPI spec.

OpenSLO Spec

However, oslo has the field as required within the manifest.

I'm happy to fix this, however I don't know which should be considered as correct. Any guidance?

PS, have we ever thought of OpenAPI to Golang Generators so updating the OpenAPI spec would automatically update the Go structs?

@aaranmcguire aaranmcguire added the bug Something isn't working label Feb 14, 2024
@nieomylnieja
Copy link
Member

The Markdown README spec is the source of truth right now.
We're trying to change this and over many discussions and a few community meetings we agreed upon defining the spec as Go structs. From there we'll generate the OpenAPI spec as best as we can.

@thisisibrahimd
Copy link

Hey @nieomylnieja,
I have taken some time to define in openapi (https://github.com/thisisibrahimd/openslo/blob/feature/add-budget-adjustment-spec/schemas/v1/schema.yaml) and generated gocode with openapi-generator with custom configs at https://github.com/thisisibrahimd/openslo-go.

Please let me know if this is helpful.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

3 participants