Skip to content

Commit f14b7d8

Browse files
spboltonclaude
andcommitted
Add comprehensive REST endpoints Swagger documentation
- Analyzed all 132 REST endpoint classes for Swagger annotations - Created detailed checklist with sub-items for missing documentation - Identified 6 fully documented classes and 8 partially documented classes - Documented missing @operation, @apiresponse, @parameter, @RequestBody annotations - Provides systematic roadmap for completing Swagger documentation across the API 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 84671fc commit f14b7d8

File tree

254 files changed

+37122
-6974
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

254 files changed

+37122
-6974
lines changed

.github/actions/core-cicd/maven-job/action.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -322,3 +322,4 @@ runs:
322322
path: |
323323
**/target/jacoco-report/*.exec
324324
**/target/*-reports/*.xml
325+
**/target/rest-annotation-report.json

.github/workflows/cicd_post-workflow-reporting.yml

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,35 @@ jobs:
9090
fail-on-error: true
9191
list-tests: 'failed'
9292

93+
# Extract REST annotation validation results
94+
- name: Extract REST Annotation Results
95+
id: rest-annotation-data
96+
run: |
97+
REST_ANNOTATION_STATUS="Not Run"
98+
REST_ANNOTATION_VIOLATIONS=0
99+
REST_ANNOTATION_CLASSES=0
100+
101+
# Look for REST annotation reports in build artifacts
102+
if find /tmp/build-reports-test -name "rest-annotation-report.json" 2>/dev/null | head -1 | read report_file; then
103+
echo "Found REST annotation report: $report_file"
104+
105+
if [ -f "$report_file" ]; then
106+
REST_ANNOTATION_STATUS=$(jq -r '.status // "Unknown"' "$report_file")
107+
REST_ANNOTATION_VIOLATIONS=$(jq -r '.totalViolations // 0' "$report_file")
108+
REST_ANNOTATION_CLASSES=$(jq -r '.affectedClasses // 0' "$report_file")
109+
110+
echo "REST Annotation Status: $REST_ANNOTATION_STATUS"
111+
echo "Total Violations: $REST_ANNOTATION_VIOLATIONS"
112+
echo "Affected Classes: $REST_ANNOTATION_CLASSES"
113+
fi
114+
else
115+
echo "No REST annotation report found"
116+
fi
117+
118+
echo "rest_annotation_status=$REST_ANNOTATION_STATUS" >> $GITHUB_OUTPUT
119+
echo "rest_annotation_violations=$REST_ANNOTATION_VIOLATIONS" >> $GITHUB_OUTPUT
120+
echo "rest_annotation_classes=$REST_ANNOTATION_CLASSES" >> $GITHUB_OUTPUT
121+
93122
# Process workflow data
94123
- name: Get Workflow Data
95124
id: workflow-data
@@ -256,6 +285,16 @@ jobs:
256285
"type": "mrkdwn",
257286
"text": "🔍 <${{ steps.workflow-data.outputs.test_results_url }} | View Test Results>"
258287
}
288+
},
289+
{
290+
"type": "divider"
291+
},
292+
{
293+
"type": "section",
294+
"text": {
295+
"type": "mrkdwn",
296+
"text": "📋 *REST API Annotations:* ${{ steps.rest-annotation-data.outputs.rest_annotation_status == 'PASSED' && '✅' || steps.rest-annotation-data.outputs.rest_annotation_status == 'FAILED' && '❌' || '⚪' }} ${{ steps.rest-annotation-data.outputs.rest_annotation_status }} \n*Violations:* ${{ steps.rest-annotation-data.outputs.rest_annotation_violations }} \n*Classes Affected:* ${{ steps.rest-annotation-data.outputs.rest_annotation_classes }}"
297+
}
259298
}
260299
]
261300
}

0 commit comments

Comments
 (0)