#99 - Allow any entity scoring (Breaking changes)

app-config.yaml

@@ -49,6 +49,12 @@ scorecards:
   jsonDataUrl: http://localhost:8090/plugins/score-card/sample-data/ #this is being served via http-server
   wikiLinkTemplate: https://link-to-wiki/{id}
 
+  # useEntityRef
+  # When true, use entity ref in URL when fetching its file, ex: {jsonDataUrl}/{entityRef.namespace}/{entityRef.kind}/{entityRef.name}
+  # When false, use system name in URL when fetching its file, ex: {jsonDataUrl}/{systemEntityName}
+  # default: false
+  useEntityRef: true
+
 catalog:
   rules:
     - allow: [Component, System, API, Group, User, Resource, Location, Template]

packages/app/src/components/catalog/EntityPage.tsx

@@ -94,6 +94,16 @@ const apiPage = (
         <Grid item md={6}>
           <EntityAboutCard />
         </Grid>
+        <Grid item md={6}>
+          <EntityScoreCardContent />
+        </Grid>
+      </Grid>
+    </EntityLayout.Route>
+    <EntityLayout.Route path="/score" title="Score">
+      <Grid container spacing={3} alignItems="stretch">
+        <Grid item xs={12}>
+          <EntityScoreCardContent />
+        </Grid>
       </Grid>
     </EntityLayout.Route>
   </EntityLayout>

plugins/score-card/config.d.ts

@@ -29,5 +29,12 @@ export interface Config {
      * @visibility frontend
      */
      wikiLinkTemplate?: string;
+     /**
+      *
+      * When true, use entity ref in URL when fetching its file, ex: {jsonDataUrl}/{entityRef.namespace}/{entityRef.kind}/{entityRef.name}
+      * When false, use system name in URL when fetching its file, ex: {jsonDataUrl}/{systemEntityName}
+      * @visibility frontend
+      */
+      useEntityRef?: boolean;
   };
 }

plugins/score-card/sample-data/all.json

@@ -1,4 +1,46 @@
 [
+  {
+    "entityRef": {
+      "kind": "api",
+      "name": "api.foo"
+    },
+    "scorePercent": 50,
+    "scoreLabel": "Yellow",
+    "scoringReviewDate": "2022-01-01T08:00:00Z",
+    "scoreSuccess": "almost-failure",
+    "areaScores": [
+      {
+        "title": "Extensibility",
+        "scorePercent": 50,
+        "scoreLabel": "Yellow",
+        "scoreSuccess": "almost-failure"
+      },
+      {
+        "title": "Code",
+        "scorePercent": 100,
+        "scoreLabel": "Green",
+        "scoreSuccess": "success"
+      },
+      {
+        "title": "Quality",
+        "scorePercent": 25,
+        "scoreLabel": "Red",
+        "scoreSuccess": "failure"
+      },
+      {
+        "title": "Documentation",
+        "scorePercent": 100,
+        "scoreLabel": "Green",
+        "scoreSuccess": "success"
+      },
+      {
+        "title": "Operations",
+        "scorePercent": 50,
+        "scoreLabel": "Yellow",
+        "scoreSuccess": "almost-failure"
+      }
+    ]
+  },
   {
     "systemEntityName": "non-valid-system",
     "systemTier": "B",

plugins/score-card/sample-data/api.foo.json

@@ -0,0 +1 @@
+default/api/api.foo.json