x-readiness-mcp 0.3.0 → 0.5.0

package/templates/master_template.json

@@ -1,524 +0,0 @@
-{
-  "name": "Siemens X API Readiness",
-  "version": "2.5.0",
-  "last_updated": "2026-01-28",
-  "description": "Master template for X-API readiness validation based on Siemens API Guidelines",
-  
-  "sources": [
-    {
-      "id": "common-index",
-      "area": "common",
-      "name": "Common API Guidelines - Overview",
-      "url": "https://developer.siemens.com/guidelines/api-guidelines/common/index.html",
-      "priority": "medium"
-    },
-    {
-      "id": "common-api-lifecycle-phases",
-      "area": "common",
-      "name": "API Lifecycle Phases",
-      "url": "https://developer.siemens.com/guidelines/api-guidelines/common/api-lifecycle-phases.html",
-      "priority": "medium"
-    },
-    {
-      "id": "common-api-specification",
-      "area": "common",
-      "name": "API Specification",
-      "url": "https://developer.siemens.com/guidelines/api-guidelines/common/api-specification.html",
-      "priority": "high"
-    },
-    {
-      "id": "common-api-documentation",
-      "area": "common",
-      "name": "API Documentation",
-      "url": "https://developer.siemens.com/guidelines/api-guidelines/common/api-documentation.html",
-      "priority": "medium"
-    },
-    {
-      "id": "common-api-versioning",
-      "area": "common",
-      "name": "API Versioning",
-      "url": "https://developer.siemens.com/guidelines/api-guidelines/common/api-versioning.html",
-      "priority": "high"
-    },
-    {
-      "id": "common-json-property-naming",
-      "area": "common",
-      "name": "JSON Property Naming",
-      "url": "https://developer.siemens.com/guidelines/api-guidelines/common/json-property-naming.html",
-      "priority": "medium"
-    },
-    {
-      "id": "common-http-api-protection",
-      "area": "common",
-      "name": "HTTP API Protection",
-      "url": "https://developer.siemens.com/guidelines/api-guidelines/common/http-api-protection.html",
-      "priority": "critical"
-    },
-    {
-      "id": "common-changelog",
-      "area": "common",
-      "name": "Common Guidelines Changelog",
-      "url": "https://developer.siemens.com/guidelines/api-guidelines/common/changelog.html",
-      "priority": "low"
-    },
-    {
-      "id": "rest-index",
-      "area": "rest",
-      "name": "REST API Guidelines - Overview",
-      "url": "https://developer.siemens.com/guidelines/api-guidelines/rest/index.html",
-      "priority": "medium"
-    },
-    {
-      "id": "rest-media-type",
-      "area": "rest",
-      "name": "Media Types",
-      "url": "https://developer.siemens.com/guidelines/api-guidelines/rest/media-type.html",
-      "priority": "high"
-    },
-    {
-      "id": "rest-versioning",
-      "area": "rest",
-      "name": "REST Versioning",
-      "url": "https://developer.siemens.com/guidelines/api-guidelines/rest/versioning.html",
-      "priority": "high"
-    },
-    {
-      "id": "rest-error",
-      "area": "rest",
-      "name": "Error Handling",
-      "url": "https://developer.siemens.com/guidelines/api-guidelines/rest/error.html",
-      "priority": "critical"
-    },
-    {
-      "id": "rest-common-operations",
-      "area": "rest",
-      "name": "Common Operations",
-      "url": "https://developer.siemens.com/guidelines/api-guidelines/rest/common-operations.html",
-      "priority": "high"
-    },
-    {
-      "id": "rest-bulk-operations",
-      "area": "rest",
-      "name": "Bulk Operations",
-      "url": "https://developer.siemens.com/guidelines/api-guidelines/rest/bulk-operations.html",
-      "priority": "medium"
-    },
-    {
-      "id": "rest-sparse-fieldsets",
-      "area": "rest",
-      "name": "Sparse Fieldsets",
-      "url": "https://developer.siemens.com/guidelines/api-guidelines/rest/sparse-fieldsets.html",
-      "priority": "medium"
-    },
-    {
-      "id": "rest-filtering",
-      "area": "rest",
-      "name": "Filtering",
-      "url": "https://developer.siemens.com/guidelines/api-guidelines/rest/filtering.html",
-      "priority": "medium"
-    },
-    {
-      "id": "rest-pagination",
-      "area": "rest",
-      "name": "Pagination",
-      "url": "https://developer.siemens.com/guidelines/api-guidelines/rest/pagination.html",
-      "priority": "high"
-    },
-    {
-      "id": "rest-sorting",
-      "area": "rest",
-      "name": "Sorting",
-      "url": "https://developer.siemens.com/guidelines/api-guidelines/rest/sorting.html",
-      "priority": "medium"
-    },
-    {
-      "id": "rest-security",
-      "area": "rest",
-      "name": "Security",
-      "url": "https://developer.siemens.com/guidelines/api-guidelines/rest/security.html",
-      "priority": "critical"
-    },
-    {
-      "id": "rest-best-practices",
-      "area": "rest",
-      "name": "Best Practices",
-      "url": "https://developer.siemens.com/guidelines/api-guidelines/rest/best-practices.html",
-      "priority": "medium"
-    },
-    {
-      "id": "rest-tools",
-      "area": "rest",
-      "name": "Tools",
-      "url": "https://developer.siemens.com/guidelines/api-guidelines/rest/tools.html",
-      "priority": "low"
-    },
-    {
-      "id": "rest-appendix-datatypes",
-      "area": "rest",
-      "name": "Appendix: Data Types",
-      "url": "https://developer.siemens.com/guidelines/api-guidelines/rest/appendix-datatypes.html",
-      "priority": "low"
-    },
-    {
-      "id": "rest-changelog",
-      "area": "rest",
-      "name": "REST Guidelines Changelog",
-      "url": "https://developer.siemens.com/guidelines/api-guidelines/rest/changelog.html",
-      "priority": "low"
-    }
-  ],
-  
-  "scopes": {
-    "x_api_readiness": {
-      "description": "Full X-API readiness check covering all common and REST guidelines",
-      "include_ids": ["common-*", "rest-*"]
-    },
-    "pagination_ready": {
-      "description": "Pagination readiness including related query operations",
-      "include_ids": [
-        "rest-pagination",
-        "rest-sorting",
-        "rest-filtering",
-        "rest-sparse-fieldsets",
-        "rest-common-operations",
-        "rest-error",
-        "rest-security",
-        "common-json-property-naming"
-      ]
-    },
-    "security_ready": {
-      "description": "Security readiness for API protection",
-      "include_ids": [
-        "rest-security",
-        "common-http-api-protection",
-        "rest-error"
-      ]
-    },
-    "error_handling_ready": {
-      "description": "Error handling and status code compliance",
-      "include_ids": [
-        "rest-error",
-        "rest-media-type",
-        "common-json-property-naming"
-      ]
-    },
-    "versioning_ready": {
-      "description": "API versioning compliance",
-      "include_ids": [
-        "common-api-versioning",
-        "rest-versioning",
-        "rest-media-type"
-      ]
-    },
-    "media_types_ready": {
-      "description": "Media types and naming conventions",
-      "include_ids": [
-        "rest-media-type",
-        "common-json-property-naming"
-      ]
-    },
-    "operations_ready": {
-      "description": "CRUD and bulk operations compliance",
-      "include_ids": [
-        "rest-common-operations",
-        "rest-bulk-operations",
-        "rest-error"
-      ]
-    },
-    "query_ready": {
-      "description": "Query capabilities: filtering, sorting, sparse fieldsets",
-      "include_ids": [
-        "rest-filtering",
-        "rest-sorting",
-        "rest-sparse-fieldsets",
-        "rest-pagination"
-      ]
-    }
-  },
-  
-  "categories": {
-    "PAGINATION": {
-      "id": "pagination",
-      "name": "Pagination",
-      "description": "Rules for implementing pagination in collection endpoints",
-      "guideline_url": "https://developer.siemens.com/guidelines/api-guidelines/rest/pagination.html",
-      "rule_id_range": "600-699",
-      "applies_to": ["GET endpoints", "Collection responses"],
-      "keywords": ["pagination", "paging", "offset", "limit", "cursor", "page", "size", "next", "prev", "first", "last"],
-      "related_categories": ["MEDIA_TYPES"],
-      "priority": "high",
-      "expected_rules": {
-        "600": "Pagination links",
-        "601": "Pagination strategies",
-        "601.1": "Cursor based strategy",
-        "601.1.1": "Server MAY provide pagination meta information",
-        "601.2": "Offset based strategy",
-        "601.2.1": "Offset pagination meta information",
-        "601.3": "Index based strategy",
-        "601.3.1": "Index pagination meta information"
-      }
-    },
-    "ERROR_HANDLING": {
-      "id": "error-handling",
-      "name": "Error Handling",
-      "description": "Rules for consistent and secure error response handling",
-      "guideline_url": "https://developer.siemens.com/guidelines/api-guidelines/rest/error.html",
-      "rule_id_range": "300-399",
-      "applies_to": ["Error responses", "HTTP status codes", "Error objects"],
-      "keywords": ["error", "error handling", "status code", "4xx", "5xx", "errors object", "error reporting"],
-      "related_categories": ["MEDIA_TYPES", "SECURITY"],
-      "priority": "critical",
-      "expected_rules": {
-        "300": "API MUST use official HTTP status codes as intended",
-        "301": "API SHOULD only use most common HTTP status codes",
-        "301.3": "Client Error 4xx Status Codes",
-        "301.4": "Server Error 5xx Status Codes",
-        "302": "API SHOULD use most specific HTTP status code for error",
-        "303": "API SHOULD not expose stack traces of the error",
-        "304": "API SHOULD report problems with an errors object",
-        "305": "Error object SHOULD be represented according to defined structure",
-        "305.1": "The values of the code field SHOULD be unique",
-        "305.2": "All error codes SHOULD be documented",
-        "305.3": "The values of title and detail fields SHOULD be in English"
-      }
-    },
-    "MEDIA_TYPES": {
-      "id": "media-types",
-      "name": "Media Types",
-      "description": "Rules for content type negotiation and document structure",
-      "guideline_url": "https://developer.siemens.com/guidelines/api-guidelines/rest/media-type.html",
-      "rule_id_range": "100-199",
-      "applies_to": ["JSON documents", "Response structure", "Field naming", "Resource objects"],
-      "keywords": ["media type", "content type", "json", "application/json", "UTF-8", "document structure", "data", "links", "meta"],
-      "related_categories": ["NAMING_CONVENTIONS", "PAGINATION", "ERROR_HANDLING"],
-      "priority": "high",
-      "expected_rules": {
-        "100": "API SHOULD use JSON-based media types",
-        "101": "API SHOULD use the following document structure",
-        "101.1": "API SHOULD use a top-level JSON object",
-        "101.2": "API SHOULD use the defined document structure",
-        "101.3": "The primary data MUST be represented by resource objects",
-        "101.4": "API MUST represent resources with resource objects",
-        "101.4.1": "Fields MUST follow the naming convention",
-        "101.5": "A links object SHOULD contain one or more links",
-        "101.6": "A link SHOULD be represented according to defined structure",
-        "101.6.1": "A link object SHOULD have defined structure fields",
-        "101.7": "A JSON document MAY provide meta information",
-        "101.7.1": "A meta field MUST contain meta information",
-        "101.7.2": "meta MUST be represented as JSON object",
-        "101.7.3": "meta fields SHOULD consider common field semantics",
-        "101.8": "Field names SHOULD apply naming conventions",
-        "101.8.1": "Field names MUST use allowed characters only",
-        "101.9": "Resource names SHOULD be in lowercase with hyphens",
-        "102": "Collection resource names SHOULD pluralize single resource"
-      }
-    },
-    "NAMING_CONVENTIONS": {
-      "id": "naming-conventions",
-      "name": "Naming Conventions",
-      "description": "Rules for consistent naming of resources, endpoints, and JSON properties",
-      "guideline_url": "https://developer.siemens.com/guidelines/api-guidelines/common/json-property-naming.html",
-      "rule_id_range": "101.8.x",
-      "applies_to": ["JSON properties", "URL paths", "Resource names", "Query parameters"],
-      "keywords": ["naming", "camelCase", "kebab-case", "field names", "property names", "resource names"],
-      "related_categories": ["MEDIA_TYPES"],
-      "priority": "medium",
-      "expected_rules": {
-        "naming_01": "Names MUST start with a lower case letter",
-        "naming_02": "Names MUST use camelCase for multi-word concatenation",
-        "naming_03": "Abbreviations and acronyms MUST be treated as words",
-        "naming_04": "Names MUST only consist of ASCII characters",
-        "naming_05": "Words in names SHOULD use American English",
-        "naming_06": "Names SHOULD be kept short and concise",
-        "naming_07": "Resource names SHOULD use kebab-case",
-        "naming_08": "Abbreviations SHOULD NOT be used except commonly used forms"
-      }
-    },
-    "SECURITY": {
-      "id": "security",
-      "name": "Security",
-      "description": "Security best practices and authentication requirements",
-      "guideline_url": "https://developer.siemens.com/guidelines/api-guidelines/rest/security.html",
-      "additional_url": "https://developer.siemens.com/guidelines/api-guidelines/common/http-api-protection.html",
-      "rule_id_range": "N/A",
-      "applies_to": ["Authentication", "Authorization", "HTTPS/TLS", "JWT tokens", "OAuth 2.0"],
-      "keywords": ["security", "auth", "oauth", "jwt", "https", "bearer token", "authentication", "authorization"],
-      "related_categories": ["ERROR_HANDLING"],
-      "priority": "critical",
-      "expected_rules": {
-        "sec_01": "REST APIs MUST be secured with OAuth 2.0 Bearer Token",
-        "sec_02": "APIs MUST use TLS for HTTP protection",
-        "sec_03": "Token format SHOULD be JWT",
-        "sec_04": "API implementation MUST check token signature",
-        "sec_05": "API implementation MUST check token expiry",
-        "sec_06": "API implementation MUST check token issuer",
-        "sec_07": "API implementation MUST check scope",
-        "sec_08": "API implementation SHOULD check token audience",
-        "sec_09": "Authorization header with Bearer token SHOULD be present"
-      }
-    },
-    "VERSIONING": {
-      "id": "versioning",
-      "name": "API Versioning",
-      "description": "Rules for semantic versioning and version management",
-      "guideline_url": "https://developer.siemens.com/guidelines/api-guidelines/common/api-versioning.html",
-      "additional_url": "https://developer.siemens.com/guidelines/api-guidelines/rest/versioning.html",
-      "rule_id_range": "200-299",
-      "applies_to": ["API versioning", "URI paths", "HTTP headers", "Semantic versioning"],
-      "keywords": ["versioning", "version", "v1", "v2", "semantic versioning", "api-version"],
-      "related_categories": [],
-      "priority": "medium",
-      "expected_rules": {
-        "200": "API version in HTTP requests",
-        "200.1": "Option 1 - API version in URI path",
-        "200.2": "Option 2 - API version in custom request header",
-        "201": "API Version in HTTP Responses",
-        "ver_01": "Version number MUST be expressed as MAJOR.MINOR.PATCH",
-        "ver_02": "MUST increment MAJOR for incompatible changes",
-        "ver_03": "MUST increment MINOR for backward compatible additions",
-        "ver_04": "MUST increment PATCH for backward compatible fixes"
-      }
-    },
-    "COMMON_OPERATIONS": {
-      "id": "common-operations",
-      "name": "Common Operations",
-      "description": "Standard REST operations (GET, POST, PUT, PATCH, DELETE)",
-      "guideline_url": "https://developer.siemens.com/guidelines/api-guidelines/rest/common-operations.html",
-      "rule_id_range": "800-899",
-      "applies_to": ["HTTP methods", "CRUD operations"],
-      "keywords": ["get", "post", "put", "patch", "delete", "crud", "operations"],
-      "related_categories": ["ERROR_HANDLING"],
-      "priority": "high",
-      "expected_rules": {
-        "ops_01": "Use appropriate HTTP methods for operations",
-        "ops_02": "GET requests MUST be safe and idempotent",
-        "ops_03": "PUT and DELETE MUST be idempotent",
-        "ops_04": "POST creates new resources",
-        "ops_05": "Use PATCH for partial updates"
-      }
-    },
-    "BULK_OPERATIONS": {
-      "id": "bulk-operations",
-      "name": "Bulk Operations",
-      "description": "Rules for handling multiple operations in single request",
-      "guideline_url": "https://developer.siemens.com/guidelines/api-guidelines/rest/bulk-operations.html",
-      "rule_id_range": "900-999",
-      "applies_to": ["Batch processing", "Multiple resource operations"],
-      "keywords": ["bulk", "batch", "multiple", "operations"],
-      "related_categories": ["ERROR_HANDLING"],
-      "priority": "medium",
-      "expected_rules": {
-        "bulk_01": "Support bulk operations for efficiency",
-        "bulk_02": "Provide partial success reporting"
-      }
-    },
-    "FILTERING": {
-      "id": "filtering",
-      "name": "Filtering",
-      "description": "Query parameter-based filtering of collection resources",
-      "guideline_url": "https://developer.siemens.com/guidelines/api-guidelines/rest/filtering.html",
-      "rule_id_range": "400-499",
-      "applies_to": ["Collection endpoints", "Query parameters"],
-      "keywords": ["filter", "filtering", "query", "search"],
-      "related_categories": ["PAGINATION"],
-      "priority": "medium",
-      "expected_rules": {
-        "400": "API MAY support filtering",
-        "filter_01": "Use query parameters for filtering",
-        "filter_02": "Support common filter operations"
-      }
-    },
-    "SORTING": {
-      "id": "sorting",
-      "name": "Sorting",
-      "description": "Query parameter-based sorting of collection resources",
-      "guideline_url": "https://developer.siemens.com/guidelines/api-guidelines/rest/sorting.html",
-      "rule_id_range": "700-799",
-      "applies_to": ["Collection endpoints", "Query parameters"],
-      "keywords": ["sort", "sorting", "order", "orderby"],
-      "related_categories": ["PAGINATION"],
-      "priority": "low",
-      "expected_rules": {
-        "700": "API MAY provide sorting of collections",
-        "700.1": "Parameter sort MUST specify sort fields",
-        "700.2": "API MAY support multiple sort fields",
-        "700.3": "API MAY support defining sort order per field"
-      }
-    },
-    "SPARSE_FIELDSETS": {
-      "id": "sparse-fieldsets",
-      "name": "Sparse Fieldsets",
-      "description": "Client-specified field selection for resource responses",
-      "guideline_url": "https://developer.siemens.com/guidelines/api-guidelines/rest/sparse-fieldsets.html",
-      "rule_id_range": "500-599",
-      "applies_to": ["Resource responses", "Query parameters"],
-      "keywords": ["fields", "sparse", "projection", "select"],
-      "related_categories": ["MEDIA_TYPES"],
-      "priority": "low",
-      "expected_rules": {
-        "500": "API MAY support sparse fieldsets",
-        "fields_01": "Use fields parameter for field selection"
-      }
-    }
-  },
-  "metadata": {
-    "total_categories": 11,
-    "total_rules_estimated": 80,
-    "compliance_levels": {
-      "basic": {
-        "name": "Basic Compliance",
-        "description": "MUST requirements only for critical categories",
-        "includes": ["SECURITY", "ERROR_HANDLING"],
-        "required_rules": 9,
-        "expected_score": "30%"
-      },
-      "recommended": {
-        "name": "Recommended Compliance",
-        "description": "All MUST and SHOULD requirements",
-        "includes": ["SECURITY", "ERROR_HANDLING", "MEDIA_TYPES", "PAGINATION", "NAMING_CONVENTIONS", "VERSIONING"],
-        "required_rules": 60,
-        "expected_score": "80%"
-      },
-      "full_x_readiness": {
-        "name": "Full X-Readiness",
-        "description": "All standards including MAY considerations",
-        "includes": ["PAGINATION", "ERROR_HANDLING", "MEDIA_TYPES", "NAMING_CONVENTIONS", "SECURITY", "VERSIONING", "COMMON_OPERATIONS", "BULK_OPERATIONS", "FILTERING", "SORTING", "SPARSE_FIELDSETS"],
-        "required_rules_estimated": 80,
-        "expected_score": "100%"
-      }
-    },
-    "intent_keywords": {
-      "pagination": ["PAGINATION"],
-      "paging": ["PAGINATION"],
-      "page": ["PAGINATION"],
-      "error": ["ERROR_HANDLING"],
-      "error handling": ["ERROR_HANDLING"],
-      "media type": ["MEDIA_TYPES"],
-      "content type": ["MEDIA_TYPES"],
-      "json": ["MEDIA_TYPES"],
-      "naming": ["NAMING_CONVENTIONS"],
-      "camelCase": ["NAMING_CONVENTIONS"],
-      "security": ["SECURITY"],
-      "auth": ["SECURITY"],
-      "oauth": ["SECURITY"],
-      "jwt": ["SECURITY"],
-      "versioning": ["VERSIONING"],
-      "version": ["VERSIONING"],
-      "rest": ["REST_API_GUIDELINES"],
-      "http": ["REST_API_GUIDELINES"],
-      "sorting": ["SORTING"],
-      "sort": ["SORTING"],
-      "filtering": ["FILTERING"],
-      "filter": ["FILTERING"],
-      "bulk": ["BULK_OPERATIONS"],
-      "batch": ["BULK_OPERATIONS"],
-      "sparse": ["SPARSE_FIELDSETS"],
-      "fields": ["SPARSE_FIELDSETS"],
-      "operations": ["COMMON_OPERATIONS"],
-      "crud": ["COMMON_OPERATIONS"],
-      "x-readiness": ["PAGINATION", "ERROR_HANDLING", "MEDIA_TYPES", "NAMING_CONVENTIONS", "SECURITY", "VERSIONING", "COMMON_OPERATIONS"],
-      "full check": ["PAGINATION", "ERROR_HANDLING", "MEDIA_TYPES", "NAMING_CONVENTIONS", "SECURITY", "VERSIONING", "COMMON_OPERATIONS", "BULK_OPERATIONS", "FILTERING", "SORTING", "SPARSE_FIELDSETS"],
-      "api readiness": ["PAGINATION", "ERROR_HANDLING", "MEDIA_TYPES", "NAMING_CONVENTIONS", "SECURITY", "VERSIONING", "COMMON_OPERATIONS"]
-    }
-  }
-}