Skip to content

[DRAFT] Fix inconsistencies in REST guidelines#14

Draft
aviator5 wants to merge 2 commits intocyberfabric:mainfrom
aviator5:rest-fix-inconsistencies
Draft

[DRAFT] Fix inconsistencies in REST guidelines#14
aviator5 wants to merge 2 commits intocyberfabric:mainfrom
aviator5:rest-fix-inconsistencies

Conversation

@aviator5
Copy link
Copy Markdown
Contributor

@aviator5 aviator5 commented Dec 2, 2025

Description

Type of Change

  • Documentation update
  • New section/guide
  • Bug fix (typo, broken link)
  • Code example improvement
  • Other:

Checklist

  • Commits are signed off (git commit -s)
  • Changes follow DNA principles
  • Code examples tested
  • Links are valid
  • Self-review completed

Related Issues

Closes #

@aviator5 aviator5 force-pushed the rest-fix-inconsistencies branch from 7dbb2c5 to 7e79388 Compare December 3, 2025 20:56
- Update PAGINATION.md to use canonical data + meta.pageInfo + links structure
- Replace items/page_info with data/meta.pageInfo for consistency
- Update API.md List Tickets example to use nextCursor/prevCursor
- Ensure consistent camelCase naming across all pagination fields
- Add full URL examples in links.self/next/prev

Fixes inconsistency between three different pagination response variants.

Signed-off-by: Aviator 5 <ai.agent.tor@gmail.com>
… parameters in examples

Signed-off-by: Aviator 5 <ai.agent.tor@gmail.com>
@aviator5 aviator5 force-pushed the rest-fix-inconsistencies branch from 7e79388 to 1e6afb4 Compare December 4, 2025 12:17
Comment thread REST/PAGINATION.md
{
"items": [
{ "id": "018f6c9e-2c3b-7b1a-8f4a-9c3d2b1a0e5f", "created_at": "2025-09-14T12:34:57.100Z", "text": "..." }
"data": [
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Is there any particular reason we use broad word data over items?

@aviator5 aviator5 marked this pull request as draft December 13, 2025 10:13
@aviator5 aviator5 changed the title Fix inconsistencies in REST guidelines [DRAFT] Fix inconsistencies in REST guidelines Dec 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants