Skip to content

docs(skills): add aip to api skills#3937

Merged
hekike merged 2 commits intomainfrom
docs/skills-api
Mar 24, 2026
Merged

docs(skills): add aip to api skills#3937
hekike merged 2 commits intomainfrom
docs/skills-api

Conversation

@hekike
Copy link
Contributor

@hekike hekike commented Mar 11, 2026

Add AIP to API skills

Summary by CodeRabbit

  • Documentation
    • Expanded API design standards with comprehensive guidance: kebab-case URL paths, trailing-slash behavior, URL-path versioning, strict delete semantics (including force-delete behavior), bulk-delete limits and responses, list filtering rules (any/all quantifiers; multiple filters combine with AND), label key/value constraints, time/duration formats, content-type handling and errors, and requirement to include empty fields as null/[]/{}.
    • Added a dedicated AIP reference link and clarified placement of new APIs.

@hekike hekike requested a review from tothandras March 11, 2026 17:34
@hekike hekike requested a review from a team as a code owner March 11, 2026 17:34
@hekike hekike added the release-note/ignore Ignore this change when generating release notes label Mar 11, 2026
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 11, 2026

📝 Walkthrough

Walkthrough

Adds Kong AIP design guidelines into the skills API docs, creates a small redirect file to the AIP package README, and expands the AIP README with detailed rules for URLs, deletes, filtering, labels, time/duration, content-types, bulk deletes, versioning, and response field presence.

Changes

Cohort / File(s) Summary
Skills API docs
.agents/skills/api/SKILL.md
Inserted “AIP Standards (Kong AIP)” guidance (duplicated in two locations), adjusted an “Important Reminders” wording, and added a blank line in the Key types list. Documentation-only edits.
AIP redirect/shortcut
.agents/skills/api/AIP.md
New file added pointing to ../../../api/spec/packages/aip/README.md (simple reference file).
AIP specification
api/spec/packages/aip/README.md
Expanded AIP README with concrete rules: kebab-case URL paths, trailing-slash behavior (GET returns 404), delete semantics (path params, cascading with ?force=true), list filtering quantifiers (any/all) and AND-combination, label key/value constraints and PATCH semantics, timestamp/duration formats, content-type validation/defaults, bulk delete limits/response codes, URL-path versioning, and requirement to always include response fields (use null/[]/{} for empties).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested reviewers

  • tothandras
  • gergely-kurucz-konghq
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title 'docs(skills): add aip to api skills' accurately describes the main change: adding AIP documentation to the API skills section. It's concise, specific, and directly reflects the changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/skills-api

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
.agents/skills/api/SKILL.md (1)

415-415: Consider reorganizing this bullet point for better flow.

Line 415 ("All new APIs go in v3 directory") appears under "Important Reminders" but comes immediately after the AIP Standards section. This creates a slight organizational awkwardness. Consider either:

  • Moving this reminder earlier in the document (near the V3 API Structure section where it's more contextually relevant)
  • Adding a clear separator or heading between the AIP Standards and Important Reminders sections
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In @.agents/skills/api/SKILL.md at line 415, The "All new APIs go in v3
directory (`api/spec/src/v3/`)" bullet is misplaced and disrupts flow; either
move that bullet near the "V3 API Structure" section or insert a clear
separator/heading between "AIP Standards" and "Important Reminders" so the
reminder is contextually grouped; update the SKILL.md content to relocate the
specific bullet or add a short heading (e.g., "Reminder: V3 APIs") so readers
see the v3 placement guidance adjacent to the V3 structure discussion.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In @.agents/skills/api/SKILL.md:
- Line 415: The "All new APIs go in v3 directory (`api/spec/src/v3/`)" bullet is
misplaced and disrupts flow; either move that bullet near the "V3 API Structure"
section or insert a clear separator/heading between "AIP Standards" and
"Important Reminders" so the reminder is contextually grouped; update the
SKILL.md content to relocate the specific bullet or add a short heading (e.g.,
"Reminder: V3 APIs") so readers see the v3 placement guidance adjacent to the V3
structure discussion.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 153566b4-5765-47e4-9e62-3afec8d4c174

📥 Commits

Reviewing files that changed from the base of the PR and between 56a331f and 731e6b8.

📒 Files selected for processing (1)
  • .agents/skills/api/SKILL.md

@hekike hekike enabled auto-merge (squash) March 24, 2026 16:18
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@api/spec/packages/aip/README.md`:
- Line 223: The README line under "Duration fields" contains a typo: replace "We
defer from the AIP standard here." with "We differ from the AIP standard here."
in the Duration fields paragraph (the sentence that begins "We defer from the
AIP standard here. We use the ISO 8601 duration format...") so the documentation
correctly uses "differ" to indicate deviation from the AIP standard.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 3e43f993-d9aa-4180-94f3-7730261880d0

📥 Commits

Reviewing files that changed from the base of the PR and between 731e6b8 and 076c8bd.

📒 Files selected for processing (3)
  • .agents/skills/api/AIP.md
  • .agents/skills/api/SKILL.md
  • api/spec/packages/aip/README.md
✅ Files skipped from review due to trivial changes (1)
  • .agents/skills/api/AIP.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • .agents/skills/api/SKILL.md


- Timestamp fields: `<verb_past_participle>_at` (e.g., `created_at`, `updated_at`, `expires_at`)
- Format: RFC 3339, must be UTC with `Z` suffix: `2023-02-27T02:15:00Z`
- Duration fields: We defer from the AIP standard here. We use the ISO 8601 duration format. Key components include Years (Y), Months (M), Weeks (W), Days (D), a time separator 'T', and Hours (H). Example: `PT1M` (one minute), `PT1H` (one hour), `P1D` (one day), `P1M` (one month)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Typo: "defer from" should be "differ from"

The phrase "We defer from the AIP standard" should be "We differ from the AIP standard". "Defer" means to postpone or delay, while "differ" means to deviate or be different, which is what you mean here.

📝 Proposed fix
-- Duration fields: We defer from the AIP standard here. We use the ISO 8601 duration format. Key components include Years (Y), Months (M), Weeks (W), Days (D), a time separator 'T', and Hours (H). Example: `PT1M` (one minute), `PT1H` (one hour), `P1D` (one day), `P1M` (one month)
+- Duration fields: We differ from the AIP standard here. We use the ISO 8601 duration format. Key components include Years (Y), Months (M), Weeks (W), Days (D), a time separator 'T', and Hours (H). Example: `PT1M` (one minute), `PT1H` (one hour), `P1D` (one day), `P1M` (one month)

As per coding guidelines, markdown documentation should be assessed for grammatical errors.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- Duration fields: We defer from the AIP standard here. We use the ISO 8601 duration format. Key components include Years (Y), Months (M), Weeks (W), Days (D), a time separator 'T', and Hours (H). Example: `PT1M` (one minute), `PT1H` (one hour), `P1D` (one day), `P1M` (one month)
- Duration fields: We differ from the AIP standard here. We use the ISO 8601 duration format. Key components include Years (Y), Months (M), Weeks (W), Days (D), a time separator 'T', and Hours (H). Example: `PT1M` (one minute), `PT1H` (one hour), `P1D` (one day), `P1M` (one month)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@api/spec/packages/aip/README.md` at line 223, The README line under "Duration
fields" contains a typo: replace "We defer from the AIP standard here." with "We
differ from the AIP standard here." in the Duration fields paragraph (the
sentence that begins "We defer from the AIP standard here. We use the ISO 8601
duration format...") so the documentation correctly uses "differ" to indicate
deviation from the AIP standard.

@hekike hekike merged commit 75f46d2 into main Mar 24, 2026
25 checks passed
@hekike hekike deleted the docs/skills-api branch March 24, 2026 16:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

release-note/ignore Ignore this change when generating release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants