fix spec violations found by the validator

- File object had a badly named field - remove an extension example entry; see #22 for details Signed-off-by: mimir-d <[email protected]>
opencomputeproject · Oct 12, 2024 · 639cce7 · 639cce7
1 parent 52e3314
commit 639cce7
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 10 deletions.
diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml
@@ -93,4 +93,4 @@ jobs:
               cargo run --manifest-path $ROOT/Cargo.toml --example {} |
               tee /dev/stderr |
               go run . -schema ../../json_spec/output/root.json -
-            "
+            "
diff --git a/examples/extensions.rs b/examples/extensions.rs
@@ -16,7 +16,7 @@ enum ExtensionType {
 }
 
 #[derive(Serialize)]
-struct ComplexExtension {
+struct Extension {
     #[serde(rename = "@type")]
     ext_type: ExtensionType,
 
@@ -25,13 +25,11 @@ struct ComplexExtension {
 }
 
 async fn step0(s: tv::ScopedTestStep) -> Result<TestStatus, tv::OcptvError> {
-    s.add_extension("simple", "extension_identifier").await?;
-
     s.add_extension(
-        "complex",
-        ComplexExtension {
+        "ext0",
+        Extension {
             ext_type: ExtensionType::Example,
-            field: "demo".to_owned(),
+            field: "example".to_owned(),
             subtypes: vec![1, 42],
         },
     )

diff --git a/src/spec.rs b/src/spec.rs
@@ -875,7 +875,7 @@ pub struct Diagnosis {
 #[derive(Debug, Serialize, PartialEq, Clone)]
 #[serde(rename = "file")]
 pub struct File {
-    #[serde(rename = "name")]
+    #[serde(rename = "displayName")]
     pub name: String,
 
     #[serde(rename = "uri")]

diff --git a/tests/output/file.rs b/tests/output/file.rs
@@ -22,7 +22,7 @@ async fn test_step_with_file() -> Result<()> {
             "testStepArtifact": {
                 "testStepId": "step0",
                 "file": {
-                    "name": "name",
+                    "displayName": "name",
                     "uri": uri.clone().as_str().to_owned(),
                     "isSnapshot": false
                 }
@@ -53,7 +53,7 @@ async fn test_step_with_file_builder() -> Result<()> {
             "testStepArtifact": {
                 "testStepId": "step0",
                 "file": {
-                    "name": "name",
+                    "displayName": "name",
                     "uri": uri.clone().as_str().to_owned(),
                     "isSnapshot": false,
                     "contentType": "text/plain",