Add validation for Basics example metadata. (#70)

Author: Laren-AWS

aws_doc_sdk_examples_tools/metadata.py

@@ -320,6 +320,7 @@ def from_yaml(
         if category == "":
             category = "Api" if len(parsed_services) == 1 else "Cross"
         is_action = category == "Api"
+        is_basics = category == "Basics"
 
         if is_action:
             svc_actions = []
@@ -337,6 +338,10 @@ def from_yaml(
             if is_action:
                 if title or title_abbrev or synopsis or synopsis_list:
                     errors.append(metadata_errors.APICannotHaveTitleFields())
+            elif is_basics:
+                # Basics examples can have custom titles or no titles (in this case they're generated).
+                if not (synopsis or synopsis_list):
+                    errors.append(metadata_errors.BasicsMustHaveSynopsisField())
             else:
                 if not (title and title_abbrev and (synopsis or synopsis_list)):
                     errors.append(metadata_errors.NonAPIMustHaveTitleFields())

aws_doc_sdk_examples_tools/metadata_errors.py

@@ -281,6 +281,15 @@ def message(self):
         )
 
 
+@dataclass
+class BasicsMustHaveSynopsisField(MetadataParseError):
+    def message(self):
+        return (
+            "is a Basics example and does not define synopsis or synopsis_list. "
+            "Basics examples must define one of these fields."
+        )
+
+
 @dataclass
 class MissingSnippetTag(SdkVersionError):
     tag: str = ""

aws_doc_sdk_examples_tools/metadata_test.py

@@ -348,6 +348,20 @@ def test_parse_strict_titles():
                  - test.excerpt
    services:
      medical-imaging: {BadOne}
+medical-imaging_BadBasics:
+   category: Basics
+   languages:
+     C++:
+       versions:
+         - sdk_version: 1
+           github: cpp/example_code/medical-imaging
+           sdkguide: sdkguide/link
+           excerpts:
+             - description: test excerpt description
+               snippet_tags:
+                 - test.excerpt
+   services:
+     medical-imaging: {BadOne}
 """
 
 
@@ -374,6 +388,10 @@ def test_parse_strict_title_errors():
             file=Path("test_cpp.yaml"),
             id="medical-imaging_BadScenario",
         ),
+        metadata_errors.BasicsMustHaveSynopsisField(
+            file=Path("test_cpp.yaml"),
+            id="medical-imaging_BadBasics",
+        ),
     ]
     assert expected == [*errors]