octocode-cli 1.2.5 → 1.2.7

package/skills/octocode-documentation-writer/schemas/analysis-schema.json

@@ -0,0 +1,886 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://octocode-documentation-writer.v3/analysis.json",
+  "title": "Repository Analysis Output",
+  "description": "Complete analysis output from Discovery+Analysis Agent",
+  "type": "object",
+  "required": [
+    "metadata",
+    "discovery",
+    "architecture",
+    "flows",
+    "apis"
+  ],
+  "properties": {
+    "metadata": {
+      "type": "object",
+      "required": [
+        "version",
+        "generated_at",
+        "repository_path"
+      ],
+      "properties": {
+        "version": {
+          "type": "string",
+          "const": "3.0"
+        },
+        "generated_at": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "repository_path": {
+          "type": "string"
+        },
+        "agent": {
+          "type": "string",
+          "const": "discovery-analysis"
+        }
+      }
+    },
+    "discovery": {
+      "type": "object",
+      "required": [
+        "primary_language",
+        "is_monorepo",
+        "project_type",
+        "components"
+      ],
+      "properties": {
+        "primary_language": {
+          "type": "string",
+          "description": "Primary programming language (e.g. typescript, python, go, rust, java, etc.)"
+        },
+        "language_distribution": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "integer",
+            "minimum": 0
+          }
+        },
+        "is_monorepo": {
+          "type": "boolean"
+        },
+        "package_count": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "packages": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "project_type": {
+          "type": "string",
+          "description": "Type of project (e.g. web-app, api-server, cli-tool, library, microservice, etc.)"
+        },
+        "framework": {
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "entry_points": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "components": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "required": [
+              "path",
+              "type"
+            ],
+            "properties": {
+              "path": {
+                "type": "string"
+              },
+              "name": {
+                "type": "string"
+              },
+              "type": {
+                "type": "string",
+                "description": "Component type (e.g. authentication, api-layer, data-layer, etc.)"
+              },
+              "file_count": {
+                "type": "integer",
+                "minimum": 0
+              }
+            }
+          }
+        },
+        "test_framework": {
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "has_tests": {
+          "type": "boolean"
+        }
+      }
+    },
+    "architecture": {
+      "type": "object",
+      "required": [
+        "layers",
+        "dependencies"
+      ],
+      "properties": {
+        "layers": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          }
+        },
+        "dependencies": {
+          "type": "object",
+          "properties": {
+            "internal": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "required": [
+                  "from",
+                  "to"
+                ],
+                "properties": {
+                  "from": {
+                    "type": "string"
+                  },
+                  "to": {
+                    "type": "string"
+                  },
+                  "import_count": {
+                    "type": "integer",
+                    "minimum": 0
+                  }
+                }
+              }
+            },
+            "external": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          }
+        },
+        "tech_stack": {
+          "type": "object",
+          "properties": {
+            "runtime": {
+              "type": [
+                "string",
+                "null"
+              ]
+            },
+            "framework": {
+              "type": [
+                "string",
+                "null"
+              ]
+            },
+            "database": {
+              "type": [
+                "string",
+                "null"
+              ]
+            },
+            "testing": {
+              "type": [
+                "string",
+                "null"
+              ]
+            }
+          }
+        }
+      }
+    },
+    "flows": {
+      "type": "object",
+      "required": [
+        "strategy",
+        "flows"
+      ],
+      "properties": {
+        "strategy": {
+          "type": "string",
+          "description": "Flow discovery strategy used"
+        },
+        "flows": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "required": [
+              "id",
+              "name",
+              "entry_point",
+              "steps"
+            ],
+            "properties": {
+              "id": {
+                "type": "string"
+              },
+              "name": {
+                "type": "string"
+              },
+              "type": {
+                "type": "string",
+                "enum": [
+                  "sequence",
+                  "data-flow",
+                  "state",
+                  "event",
+                  "other"
+                ]
+              },
+              "entry_point": {
+                "type": "object",
+                "required": [
+                  "file",
+                  "function"
+                ],
+                "properties": {
+                  "file": {
+                    "type": "string"
+                  },
+                  "line": {
+                    "type": "integer",
+                    "minimum": 1
+                  },
+                  "function": {
+                    "type": "string"
+                  }
+                }
+              },
+              "steps": {
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "required": [
+                    "step",
+                    "file",
+                    "function",
+                    "action"
+                  ],
+                  "properties": {
+                    "step": {
+                      "type": "integer",
+                      "minimum": 1
+                    },
+                    "file": {
+                      "type": "string"
+                    },
+                    "line": {
+                      "type": "integer",
+                      "minimum": 1
+                    },
+                    "function": {
+                      "type": "string"
+                    },
+                    "action": {
+                      "type": "string"
+                    },
+                    "calls": {
+                      "type": "array",
+                      "items": {
+                        "type": "string"
+                      }
+                    }
+                  }
+                }
+              },
+              "diagram": {
+                "type": "string"
+              }
+            }
+          }
+        }
+      }
+    },
+    "apis": {
+      "type": "object",
+      "required": [
+        "components"
+      ],
+      "properties": {
+        "total_apis": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "components": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "required": [
+              "component",
+              "apis"
+            ],
+            "properties": {
+              "component": {
+                "type": "string"
+              },
+              "apis": {
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "required": [
+                    "name",
+                    "signature",
+                    "type"
+                  ],
+                  "properties": {
+                    "name": {
+                      "type": "string"
+                    },
+                    "signature": {
+                      "type": "string"
+                    },
+                    "type": {
+                      "type": "string",
+                      "enum": [
+                        "function",
+                        "class",
+                        "method",
+                        "interface",
+                        "type",
+                        "variable",
+                        "constant",
+                        "enum",
+                        "module",
+                        "endpoint",
+                        "other"
+                      ]
+                    },
+                    "file": {
+                      "type": "string"
+                    },
+                    "line": {
+                      "type": "integer",
+                      "minimum": 1
+                    },
+                    "description": {
+                      "type": [
+                        "string",
+                        "null"
+                      ]
+                    },
+                    "params": {
+                      "type": "array",
+                      "items": {
+                        "type": "object",
+                        "properties": {
+                          "name": {
+                            "type": "string"
+                          },
+                          "type": {
+                            "type": "string"
+                          },
+                          "description": {
+                            "type": [
+                              "string",
+                              "null"
+                            ]
+                          }
+                        }
+                      }
+                    },
+                    "returns": {
+                      "type": [
+                        "string",
+                        "null"
+                      ]
+                    },
+                    "example": {
+                      "type": [
+                        "string",
+                        "null"
+                      ]
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "errors": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": [
+          "phase",
+          "message"
+        ],
+        "properties": {
+          "phase": {
+            "type": "string"
+          },
+          "message": {
+            "type": "string"
+          },
+          "severity": {
+            "type": "string",
+            "enum": [
+              "critical",
+              "warning",
+              "info"
+            ]
+          }
+        }
+      }
+    },
+    "devops_infrastructure": {
+      "type": "object",
+      "properties": {
+        "containerization": {
+          "type": "object",
+          "properties": {
+            "docker": {
+              "type": "object",
+              "properties": {
+                "dockerfile": { "type": ["string", "null"] },
+                "compose_files": { "type": "array", "items": { "type": "string" } }
+              }
+            },
+            "base_images": { "type": "array", "items": { "type": "string" } }
+          }
+        },
+        "ci_cd": {
+          "type": "object",
+          "properties": {
+            "platform": { "type": "string" },
+            "pipeline_files": { "type": "array", "items": { "type": "string" } },
+            "stages": { "type": "array", "items": { "type": "string" } }
+          }
+        },
+        "orchestration": {
+          "type": "object",
+          "properties": {
+            "type": { "type": "string" },
+            "manifests": { "type": "array", "items": { "type": "string" } },
+            "helm_charts": { "type": "array", "items": { "type": "string" } }
+          }
+        },
+        "infrastructure": {
+          "type": "object",
+          "properties": {
+            "tool": { "type": "string" },
+            "files": { "type": "array", "items": { "type": "string" } },
+            "providers": { "type": "array", "items": { "type": "string" } }
+          }
+        },
+        "deployment_scripts": { "type": "array", "items": { "type": "string" } },
+        "environment_configs": { "type": "array", "items": { "type": "string" } }
+      }
+    },
+    "data_models": {
+      "type": "object",
+      "properties": {
+        "orm": {
+          "type": "object",
+          "properties": {
+            "type": { "type": "string" },
+            "schema_files": { "type": "array", "items": { "type": "string" } },
+            "entities": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "name": { "type": "string" },
+                  "file": { "type": "string" },
+                  "fields": { "type": "array", "items": { "type": "string" } },
+                  "relationships": { "type": "array", "items": { "type": "string" } }
+                }
+              }
+            }
+          }
+        },
+        "migrations": {
+          "type": "object",
+          "properties": {
+            "tool": { "type": "string" },
+            "directory": { "type": "string" },
+            "count": { "type": "integer" },
+            "latest": { "type": ["string", "null"] }
+          }
+        },
+        "api_schemas": {
+          "type": "object",
+          "properties": {
+            "graphql": { "type": "array", "items": { "type": "string" } },
+            "protobuf": { "type": "array", "items": { "type": "string" } },
+            "openapi": { "type": "array", "items": { "type": "string" } }
+          }
+        },
+        "validation": {
+          "type": "object",
+          "properties": {
+            "library": { "type": "string" },
+            "schema_files": { "type": "array", "items": { "type": "string" } }
+          }
+        }
+      }
+    },
+    "observability": {
+      "type": "object",
+      "properties": {
+        "logging": {
+          "type": "object",
+          "properties": {
+            "library": { "type": "string" },
+            "config_file": { "type": ["string", "null"] },
+            "log_levels": { "type": "array", "items": { "type": "string" } },
+            "outputs": { "type": "array", "items": { "type": "string" } },
+            "structured": { "type": "boolean" }
+          }
+        },
+        "monitoring": {
+          "type": "object",
+          "properties": {
+            "platform": { "type": "string" },
+            "config_files": { "type": "array", "items": { "type": "string" } },
+            "custom_metrics": { "type": "array", "items": { "type": "string" } }
+          }
+        },
+        "tracing": {
+          "type": "object",
+          "properties": {
+            "library": { "type": "string" },
+            "config_file": { "type": ["string", "null"] },
+            "instrumentation": { "type": "array", "items": { "type": "string" } }
+          }
+        },
+        "health_endpoints": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "path": { "type": "string" },
+              "file": { "type": "string" },
+              "checks": { "type": "array", "items": { "type": "string" } }
+            }
+          }
+        },
+        "error_tracking": {
+          "type": "object",
+          "properties": {
+            "platform": { "type": "string" },
+            "config_file": { "type": ["string", "null"] }
+          }
+        },
+        "alerting": {
+          "type": "object",
+          "properties": {
+            "platforms": { "type": "array", "items": { "type": "string" } },
+            "alert_rules": { "type": "array", "items": { "type": "string" } }
+          }
+        }
+      }
+    },
+    "testing": {
+      "type": "object",
+      "properties": {
+        "test_framework": {
+          "type": "object",
+          "properties": {
+            "name": { "type": "string" },
+            "config_file": { "type": ["string", "null"] },
+            "version": { "type": ["string", "null"] }
+          }
+        },
+        "test_files": {
+          "type": "object",
+          "properties": {
+            "unit": {
+              "type": "object",
+              "properties": {
+                "count": { "type": "integer" },
+                "pattern": { "type": "string" },
+                "directories": { "type": "array", "items": { "type": "string" } }
+              }
+            },
+            "integration": {
+              "type": "object",
+              "properties": {
+                "count": { "type": "integer" },
+                "directories": { "type": "array", "items": { "type": "string" } }
+              }
+            },
+            "e2e": {
+              "type": "object",
+              "properties": {
+                "count": { "type": "integer" },
+                "framework": { "type": "string" },
+                "directories": { "type": "array", "items": { "type": "string" } }
+              }
+            }
+          }
+        },
+        "coverage": {
+          "type": "object",
+          "properties": {
+            "tool": { "type": "string" },
+            "config_file": { "type": ["string", "null"] },
+            "threshold": {
+              "type": "object",
+              "properties": {
+                "lines": { "type": "number" },
+                "branches": { "type": "number" },
+                "functions": { "type": "number" }
+              }
+            }
+          }
+        },
+        "mocking": {
+          "type": "object",
+          "properties": {
+            "libraries": { "type": "array", "items": { "type": "string" } },
+            "mock_directories": { "type": "array", "items": { "type": "string" } }
+          }
+        },
+        "quality_tools": {
+          "type": "object",
+          "properties": {
+            "linter": {
+              "type": "object",
+              "properties": {
+                "name": { "type": "string" },
+                "config": { "type": ["string", "null"] }
+              }
+            },
+            "formatter": {
+              "type": "object",
+              "properties": {
+                "name": { "type": "string" },
+                "config": { "type": ["string", "null"] }
+              }
+            },
+            "type_checking": {
+              "type": "object",
+              "properties": {
+                "strict": { "type": "boolean" },
+                "config": { "type": ["string", "null"] }
+              }
+            }
+          }
+        }
+      }
+    },
+    "patterns": {
+      "type": "object",
+      "properties": {
+        "dependency_injection": {
+          "type": "object",
+          "properties": {
+            "framework": { "type": "string" },
+            "container_file": { "type": ["string", "null"] },
+            "injectable_count": { "type": "integer" }
+          }
+        },
+        "design_patterns": {
+          "type": "object",
+          "properties": {
+            "factory": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "file": { "type": "string" } } } },
+            "repository": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "file": { "type": "string" } } } },
+            "singleton": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "file": { "type": "string" } } } },
+            "adapter": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "file": { "type": "string" } } } },
+            "strategy": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "file": { "type": "string" } } } },
+            "observer": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "file": { "type": "string" } } } }
+          }
+        },
+        "caching": {
+          "type": "object",
+          "properties": {
+            "type": { "type": "string" },
+            "library": { "type": "string" },
+            "cache_files": { "type": "array", "items": { "type": "string" } }
+          }
+        },
+        "event_driven": {
+          "type": "object",
+          "properties": {
+            "event_emitters": { "type": "array", "items": { "type": "string" } },
+            "message_queues": {
+              "type": "object",
+              "properties": {
+                "type": { "type": "string" },
+                "files": { "type": "array", "items": { "type": "string" } }
+              }
+            }
+          }
+        }
+      }
+    },
+    "state_management": {
+      "type": "object",
+      "properties": {
+        "library": { "type": "string" },
+        "store_files": { "type": "array", "items": { "type": "string" } },
+        "state_machines": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "name": { "type": "string" },
+              "file": { "type": "string" },
+              "states": { "type": "array", "items": { "type": "string" } }
+            }
+          }
+        }
+      }
+    },
+    "security": {
+      "type": "object",
+      "properties": {
+        "authentication": {
+          "type": "object",
+          "properties": {
+            "method": { "type": "string" },
+            "library": { "type": "string" },
+            "provider": { "type": "string" },
+            "files": { "type": "array", "items": { "type": "string" } }
+          }
+        },
+        "authorization": {
+          "type": "object",
+          "properties": {
+            "model": { "type": "string" },
+            "implementation_files": { "type": "array", "items": { "type": "string" } },
+            "roles_defined": { "type": "array", "items": { "type": "string" } }
+          }
+        },
+        "security_middleware": {
+          "type": "object",
+          "properties": {
+            "helmet": { "type": "boolean" },
+            "cors": {
+              "type": "object",
+              "properties": {
+                "enabled": { "type": "boolean" },
+                "config_file": { "type": ["string", "null"] }
+              }
+            },
+            "rate_limiting": {
+              "type": "object",
+              "properties": {
+                "enabled": { "type": "boolean" },
+                "library": { "type": ["string", "null"] },
+                "config": { "type": "object" }
+              }
+            },
+            "csrf": { "type": "boolean" }
+          }
+        },
+        "input_validation": {
+          "type": "object",
+          "properties": {
+            "library": { "type": "string" },
+            "sanitization": { "type": "array", "items": { "type": "string" } }
+          }
+        },
+        "encryption": {
+          "type": "object",
+          "properties": {
+            "password_hashing": { "type": "string" },
+            "data_encryption": { "type": "boolean" },
+            "files": { "type": "array", "items": { "type": "string" } }
+          }
+        },
+        "secret_management": {
+          "type": "object",
+          "properties": {
+            "method": { "type": "string" },
+            "config_file": { "type": ["string", "null"] }
+          }
+        },
+        "compliance": {
+          "type": "object",
+          "properties": {
+            "gdpr": {
+              "type": "object",
+              "properties": {
+                "detected": { "type": "boolean" },
+                "markers": { "type": "array", "items": { "type": "string" } }
+              }
+            },
+            "soc2": {
+              "type": "object",
+              "properties": {
+                "detected": { "type": "boolean" },
+                "markers": { "type": "array", "items": { "type": "string" } }
+              }
+            },
+            "pci": {
+              "type": "object",
+              "properties": {
+                "detected": { "type": "boolean" },
+                "markers": { "type": "array", "items": { "type": "string" } }
+              }
+            }
+          }
+        }
+      }
+    },
+    "contributing": {
+      "type": "object",
+      "properties": {
+        "documentation": {
+          "type": "object",
+          "properties": {
+            "contributing": { "type": ["string", "null"] },
+            "code_of_conduct": { "type": ["string", "null"] },
+            "development_guide": { "type": ["string", "null"] }
+          }
+        },
+        "git_workflow": {
+          "type": "object",
+          "properties": {
+            "pr_template": { "type": ["string", "null"] },
+            "issue_templates": { "type": "array", "items": { "type": "string" } },
+            "branch_naming": { "type": ["string", "null"] }
+          }
+        },
+        "commit_conventions": {
+          "type": "object",
+          "properties": {
+            "tool": { "type": "string" },
+            "config_file": { "type": ["string", "null"] },
+            "convention": { "type": "string" }
+          }
+        },
+        "git_hooks": {
+          "type": "object",
+          "properties": {
+            "tool": { "type": "string" },
+            "hooks": { "type": "array", "items": { "type": "string" } }
+          }
+        },
+        "code_style": {
+          "type": "object",
+          "properties": {
+            "editorconfig": { "type": "boolean" },
+            "linter_config": { "type": ["string", "null"] },
+            "formatter_config": { "type": ["string", "null"] }
+          }
+        },
+        "versioning": {
+          "type": "object",
+          "properties": {
+            "changelog": { "type": ["string", "null"] },
+            "tool": { "type": "string" },
+            "config_file": { "type": ["string", "null"] }
+          }
+        }
+      }
+    }
+  }
+}