Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GO-4459: REST API Docs & Refinement #2073

Draft
wants to merge 33 commits into
base: main
Choose a base branch
from
Draft

Conversation

jmetrikat
Copy link
Member

@jmetrikat jmetrikat commented Feb 2, 2025

  • Add comments for swagger data models
  • Fix mapping of errors originating from middleware functions
  • Add last_modified sort criterion as fallback for last_opened sort
  • Add endpoint GET /spaces/:space_id
  • Add endpoint GET /spaces/:space_id/members/:member_id
  • Add endpoints for lists (collections)
    • GET /spaces/:space_id/lists/:list_id/objects
    • POST /spaces/:space_id/lists/:list_id/objects
    • DELETE /spaces/:space_id/lists/:list_id/objects
  • Return 404 for deleted object from GET /spaces/:space_id/objects/:object_id
  • Add relation format type to detail entries and change value keys:
    {
      "id": "last_modified_date",
      "details": {
        "type": "date",
        "date": "2024-02-14T12:34:56Z"
      }
    }
    
  • Return custom relations in details of object response
  • Add make swagger for generation and format
  • Add more detailed endpoint descriptions

Copy link

github-actions bot commented Feb 2, 2025

Previous Coverage 50.7% of statements
New Coverage 50.6% of statements
Patch Coverage 24.7% of changed statements (98/397)

Coverage provided by https://github.com/seriousben/go-patch-cover-action

@jmetrikat jmetrikat changed the title GO-4459: REST API Documentation GO-4459: REST API Docs & Refinement Feb 12, 2025
Copy link

Testomat.io Report 🟢 SMOKE-TEST PASSED
Tests ✔️ 8 tests run
Summary 🟢 8 passed; 🟡 0 skipped
Duration 🕐 13 minutes, 0 seconds
Testomat.io Report 📊 Run #2752318a
Job 🗂️ Smoke Tests / smoke-test
Operating System 🖥️ Linux X64

✅ Passed Tests (8)

  • Revoking an invite link (3 minutes, 12 seconds)
  • User cancels their join request (1 minute, 20 seconds)
  • User deletes the space and rejoins later (1 minute, 35 seconds)
  • Owner changes the rights of a user from Viewer to Editor (1 minute, 49 seconds)
  • Owner approves a join request with Editor permissions (1 minute, 29 seconds)
  • Owner declines a join request (1 minute, 4 seconds)
  • Owner removes a participant from the space (1 minute, 23 seconds)
  • Sync on staging nodes (1 minute, 5 seconds)

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.

1 participant