Merge pull request #1545 from folio-org/FOLIO-873-improve-docs-248

Add mod-consortia-keycloak, mod-scheduler api doc; update software map
folio-org · Dec 29, 2023 · 6dff5e8 · 6dff5e8
2 parents 191ab96 + ec56a2d
commit 6dff5e8
Show file tree

Hide file tree

Showing 2 changed files with 63 additions and 4 deletions.
diff --git a/_data/apigroup.yml b/_data/apigroup.yml
@@ -129,13 +129,15 @@ other:
   description: Not yet grouped.
   modules:
     - mod-consortia
+    - mod-consortia-keycloak
     - mod-dcb
     - edge-dcb
     - mod-eusage-reports
     - mod-fqm-manager
     - edge-fqm
     - mod-lists
     - mod-ldp
+    - mod-scheduler
     - folio-custom-fields
     - folio-query-tool-metadata
     - folio-spring-support

diff --git a/_data/repos.json b/_data/repos.json
@@ -1,6 +1,6 @@
 {
   "metadata": {
-    "generatedDateTime": "2023-12-18T22:23:04.715652+00:00"
+    "generatedDateTime": "2023-12-28T01:50:25.797629+00:00"
   },
   "repos": [
     {
@@ -667,6 +667,16 @@
       "repoType": "other",
       "snippetIntro": "<p>Liquibase schema migration utilities.</p>"
     },
+    {
+      "defaultBranch": "master",
+      "description": null,
+      "docDirName": "doc",
+      "name": "folio-module-sidecar",
+      "org": "folio-org",
+      "repoLanguageHint": "java",
+      "repoType": "other",
+      "snippetIntro": "<p><code>folio-module-sidecar</code> provides following functionality:</p>"
+    },
     {
       "defaultBranch": "master",
       "description": "Website for FOLIO open source development dev.folio.org",
@@ -1224,6 +1234,19 @@
         "api-schema-lint.yml"
       ]
     },
+    {
+      "defaultBranch": "master",
+      "description": null,
+      "docDirName": "docs",
+      "hintOas": true,
+      "isSpringway": true,
+      "name": "mod-consortia-keycloak",
+      "org": "folio-org",
+      "ramlDirName": null,
+      "repoLanguageHint": "java",
+      "repoType": "backend-mod",
+      "snippetIntro": "<p>APIs for Consortia module.</p>"
+    },
     {
       "apiTypes": "RAML",
       "defaultBranch": "master",
@@ -2536,15 +2559,28 @@
       ]
     },
     {
+      "apiTypes": "OAS",
       "defaultBranch": "master",
       "description": "Mediated requests back-end module",
       "docDirName": null,
+      "hintOas": true,
+      "isSpringway": true,
       "name": "mod-requests-mediated",
       "org": "folio-org",
       "ramlDirName": null,
-      "repoLanguageHint": "other",
+      "repoLanguageHint": "java",
       "repoType": "backend-mod",
-      "snippetIntro": "<p>FOLIO compatible mediated requests functionality, including secure requests.</p>"
+      "snippetIntro": "<p>FOLIO compatible mediated requests functionality, including secure requests.</p>",
+      "workflows": [
+        "api-doc.yml",
+        "api-lint.yml",
+        "api-schema-lint.yml"
+      ],
+      "workflowsFolio": [
+        "api-doc.yml",
+        "api-lint.yml",
+        "api-schema-lint.yml"
+      ]
     },
     {
       "apiTypes": "OAS",
@@ -2632,6 +2668,19 @@
         "api-schema-lint.yml"
       ]
     },
+    {
+      "defaultBranch": "master",
+      "description": null,
+      "docDirName": null,
+      "hintOas": true,
+      "isSpringway": true,
+      "name": "mod-scheduler",
+      "org": "folio-org",
+      "ramlDirName": null,
+      "repoLanguageHint": "java",
+      "repoType": "backend-mod",
+      "snippetIntro": "<p><code>mod-scheduler</code> provides following functionality:</p>"
+    },
     {
       "apiTypes": "OAS",
       "defaultBranch": "master",
@@ -5095,7 +5144,15 @@
       "org": "folio-org",
       "repoLanguageHint": "node",
       "repoType": "ui",
-      "snippetIntro": ""
+      "snippetIntro": "<p>This UI Workflow Module, <code>ui-workflow</code>, is a Stripes UI Module providing a way to build workflows for use in automating processes.</p>",
+      "workflows": [
+        "build-npm-release.yml",
+        "build-npm.yml"
+      ],
+      "workflowsFolio": [
+        "build-npm-release.yml",
+        "build-npm.yml"
+      ]
     },
     {
       "defaultBranch": "master",