Add openapi-zudoku-review skill#8
Open
mosch wants to merge 1 commit into
Open
Conversation
Adds a skill for reviewing OpenAPI 3.1 specifications for documentation quality and Zudoku/Zuplo portal rendering. Produces a severity-grouped findings report and offers to apply changes. Includes reference files covering the full review checklist and the eight Zudoku OpenAPI extensions.
There was a problem hiding this comment.
Pull request overview
Adds a new agent skill (openapi-zudoku-review) aimed at reviewing OpenAPI 3.1 specs for documentation quality and for best rendering in Zudoku/Zuplo portals, along with supporting reference material and repo index updates.
Changes:
- Introduces the
openapi-zudoku-reviewskill definition and workflow/reporting format. - Adds two reference docs: a Zudoku OpenAPI extensions reference and an OpenAPI review checklist.
- Updates
README.mdandAGENTS.mdto list/discover the new skill.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| skills/openapi-zudoku-review/SKILL.md | Defines the new OpenAPI review skill, including invocation criteria, workflow, and report structure. |
| skills/openapi-zudoku-review/references/zudoku-extensions.md | Documents Zudoku-specific OpenAPI extensions and when/where to use them. |
| skills/openapi-zudoku-review/references/review-checklist.md | Provides a detailed OpenAPI review checklist and severity guidance. |
| README.md | Adds the new skill to the “Included skills” table. |
| AGENTS.md | Adds the new skill directory to the repository structure table. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+144
to
+151
| x-mcp-server: | ||
| name: my-mcp-server | ||
| version: 1.0.0 | ||
| tools: | ||
| - name: search_docs | ||
| description: Search the documentation | ||
| - name: get_page | ||
| description: Retrieve a specific documentation page |
| - Date/time fields all use the same format (ideally `date-time`) | ||
| - Money amounts handled consistently (minor units integer vs. decimal string) | ||
|
|
||
| Severity: significant duplication = medium-high. Inconsistent naming = medium. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
openapi-zudoku-reviewfor reviewing OpenAPI 3.1 specifications for documentation quality and Zudoku/Zuplo portal rendering.x-tagGroups,x-displayName,x-code-samples,x-zudoku-collapsed,x-zudoku-collapsible,x-zudoku-playground-enabled,x-mcp-server,x-mcp).README.mdandAGENTS.mdto list the new skill.Test plan
references/zudoku-extensions.md,references/review-checklist.md)