Skip to content

Specification has inconsistencies in multiple different places #149

@Silvanoc

Description

@Silvanoc

Description

There are multiple places in the specification with overlapping elements that are incompatibles, this also affects other Margo parts (like the reference implementation sandbox).

The main reason for this is that:

  1. There is no data model that simplifies extensions/additions to the specification.
  2. There is no source of truth being used for consistency with whatever artifacts get created (HTML documentation, OpenAPI specifications, examples,...).

Associated requirements

Derived from the above mentioned reasons for this issue following requirements can be defined:

  1. Create a complete, well-documented and intuitive data model.
  2. Use the data model as source of truth for the creation of artifacts and validation of manually created ones.

Impacted Margo components

Workload Fleet Manager

Location

No response

Use cases/scenarios

  1. Specification (HTML) gets created from data-model.
  2. Validation schemas and rules are created from data-model and made available for implementations.
  3. Provided examples (in the specification, in the sandbox,...) are validated against the data-model.

Reference links

No response

Sub-issues

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions