sap-api-style
v2.4.1This skill provides comprehensive guidance for documenting SAP APIs following the SAP API Style Guide standards. It should be used when creating or reviewing API documentation for REST, OData, Java, JavaScript, .NET, or C/C++ APIs. The skill covers naming conventions, documentation comments, OpenAPI specifications, quality checklists, deprecation policies, and manual documentation templates. It ensures consistency with SAP API Business Hub standards and industry best practices. Keywords: SAP API, REST, OData, OpenAPI, Swagger, Javadoc, JSDoc, XML documentation, API Business Hub, API naming, API deprecation, x-sap-stateInfo, Entity Data Model, EDM, documentation tags, API quality, API templates
by Eduard JiglauGPL-3.0404updated 1 day ago
Source
git clone https://github.com/secondsky/sap-skillsClone the source, then follow the repository's marketplace instructions for your runtime. The plugin root is plugins/sap-api-style/ inside the repository.
Layout
├── .codex-plugin/plugin.json├── .claude-plugin/plugin.json└── skills/sap-api-style/SKILL.md
Skills1
This skill provides comprehensive guidance for documenting SAP APIs following the SAP API Style Guide standards. It should be used when creating or reviewing API documentation for REST, OData, Java, JavaScript, .NET, or C/C++ APIs. The skill covers naming conventions, documentation comments, OpenAPI specifications, quality checklists, deprecation policies, and manual documentation templates. It ensures consistency with SAP API Business Hub standards and industry best practices. Keywords: SAP API, REST, OData, OpenAPI, Swagger, Javadoc, JSDoc, XML documentation, API Business Hub, API naming, API deprecation, x-sap-stateInfo, Entity Data Model, EDM, documentation tags, API quality, API templates
Manifests2
{
"name": "sap-api-style",
"version": "2.4.1",
"description": "This skill provides comprehensive guidance for documenting SAP APIs following the SAP API Style Guide standards. It should be used when creating or reviewing API documentation for REST, OData, Java, JavaScript, .NET, or C/C++ APIs. The skill covers naming conventions, documentation comments, OpenAPI specifications, quality checklists, deprecation policies, and manual documentation templates. It ensures consistency with SAP API Business Hub standards and industry best practices. Keywords: SAP API, REST, OData, OpenAPI, Swagger, Javadoc, JSDoc, XML documentation, API Business Hub, API naming, API deprecation, x-sap-stateInfo, Entity Data Model, EDM, documentation tags, API quality, API templates",
"author": {
"name": "Eduard Jiglau",
"email": "hello@sap-ai-skills.com",
"url": "https://sap-ai-skills.com"
},
"homepage": "https://sap-ai-skills.com",
"repository": "https://github.com/secondsky/sap-skills",
"license": "GPL-3.0",
"keywords": [
"api",
"automation",
"cli",
"development",
"java",
"javascript",
"odata",
"productivity",
"rest",
"sap",
"sap-api-style",
"style",
"tools",
"xml"
],
"skills": "./skills/",
"interface": {
"displayName": "SAP API Style",
"shortDescription": "This skill provides comprehensive guidance for documenting SA...",
"longDescription": "This skill provides comprehensive guidance for documenting SAP APIs following the SAP API Style Guide standards. It should be used when creating or reviewing API documentation for REST, OData, Java, JavaScript, .NET, or C/C++ APIs. The skill covers naming conventions, documentation comments, OpenAPI specifications, quality checklists, deprecation policies, and manual documentation templates. It ensures consistency with SAP API Business Hub standards and industry best practices. Keywords: SAP API, REST, OData, OpenAPI, Swagger, Javadoc, JSDoc, XML documentation, API Business Hub, API naming, API deprecation, x-sap-stateInfo, Entity Data Model, EDM, documentation tags, API quality, API templates",
"developerName": "Eduard Jiglau",
"category": "Tooling",
"capabilities": [
"Interactive",
"Read",
"Write"
],
"defaultPrompt": [
"Use SAP API Style for SAP guidance."
],
"websiteURL": "https://sap-ai-skills.com"
}
}{
"name": "sap-api-style",
"description": "This skill provides comprehensive guidance for documenting SAP APIs following the SAP API Style Guide standards. It should be used when creating or reviewing API documentation for REST, OData, Java, JavaScript, .NET, or C/C++ APIs. The skill covers naming conventions, documentation comments, OpenAPI specifications, quality checklists, deprecation policies, and manual documentation templates. It ensures consistency with SAP API Business Hub standards and industry best practices. Keywords: SAP API, REST, OData, OpenAPI, Swagger, Javadoc, JSDoc, XML documentation, API Business Hub, API naming, API deprecation, x-sap-stateInfo, Entity Data Model, EDM, documentation tags, API quality, API templates",
"version": "2.4.1",
"author": {
"name": "Eduard Jiglau",
"email": "hello@sap-ai-skills.com",
"url": "https://sap-ai-skills.com"
},
"license": "GPL-3.0",
"homepage": "https://sap-ai-skills.com",
"repository": "https://github.com/secondsky/sap-skills",
"keywords": [
"api",
"automation",
"cli",
"development",
"java",
"javascript",
"odata",
"productivity",
"rest",
"sap",
"sap-api-style",
"style",
"tools",
"xml"
],
"category": "tooling",
"agents": [
"./agents/api-style-reviewer.md"
],
"commands": [
"./commands/api-style-review.md"
]
}