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

[Feature]: Evolve specification and add JSON schema #91

Open
svrnm opened this issue Jan 9, 2025 · 1 comment
Open

[Feature]: Evolve specification and add JSON schema #91

svrnm opened this issue Jan 9, 2025 · 1 comment
Labels
enhancement New feature or request

Comments

@svrnm
Copy link
Member

svrnm commented Jan 9, 2025

Problem Statement

The specification for the config files (https://github.com/cisco-open/app-simulator/tree/main/docs/specification) is still work in progress, it needs much more details and we need to revisit some of the attributes that APM game has, that we either want to take or remove.

I also think we should add a JSON schema (https://json-schema.org/) that allows verification of config files to follow the spec.

@svrnm svrnm added enhancement New feature or request triage This issue or pull request requires triaging and removed triage This issue or pull request requires triaging labels Jan 9, 2025
@svrnm
Copy link
Member Author

svrnm commented Jan 9, 2025

Two more thoughts:

  • We might want to introduce a top level version, which is 0 right now. If needed we can have major/minor as well, but overall the idea would be to bump the version to 1 (or greater) if we introduce breaking changes.
  • We should normalize some attributes like imageNamePrefix, imageVersion, serviceAnnotation, etc. to image.namePrefix and image.version and k8s.annotations.service, etc.

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

No branches or pull requests

1 participant