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

workspace 정보조회 api 구현 #365

Merged
merged 1 commit into from
Dec 2, 2024
Merged

workspace 정보조회 api 구현 #365

merged 1 commit into from
Dec 2, 2024

Conversation

summersummerwhy
Copy link
Collaborator

@summersummerwhy summersummerwhy commented Dec 2, 2024

🔖 연관된 이슈

📂 작업 내용

워크스페이스 접근 권한 확인 + 데이터 얻기

  • 먼저 GET /api/auth/profile로 사용자의 snowflakeId부터 얻어야합니다 (로그인 안된 상태면 403 Forbidden 돌아옴)
  • Endpoint: GET /api/workspace/:workspaceId/:userId
  • Description: 특정 워크스페이스에 대한 사용자의 접근 권한을 확인합니다.
  • 요청 파라미터:
    • workspaceId: 워크스페이스의 snowflakeId (URL Path Parameter)
    • userId: 사용자의 snowflakeId (로그인하지 않은 경우 'null'로 전달)
  • 응답:
    • HTTP Status: 200 OK
    • Response Body:
{
  "message": "워크스페이스 접근 권한이 확인되었습니다.",
  "workspace": 
    {
      "workspaceId": "snowflake-id-1",
      "title": "워크스페이스 제목",
      "description": "워크스페이스 설명",
      "thumbnailUrl": "https://example.com/image.png",
      "role": "owner", // public workspace의 경우 role은 null로 돌아옴
      "visibility": "public"
    },
}
  • 워크스페이스 객체:
    • workspaceId (string) - 워크스페이스의 ID.
    • title (string) - 워크스페이스 제목.
    • description (string/null) - 워크스페이스 설명.
    • thumbnailUrl (string/null) - 워크스페이스의 썸네일 이미지 URL.
    • role (string/null) - 사용자가 해당 워크스페이스에서 가지고 있는 역할 (owner 또는 guest 또는 null => visibillity public의 경우).
    • visibility (string) - 워크스페이스의 전체공개 / 일부 공개 (public 또는 privat)
    • 예외:
      • 404 Not Found: 워크스페이스 또는 사용자를 찾을 수 없음
      • 403 Forbidden: 워크스페이스 접근 권한 없음

📑 참고 자료 & 스크린샷 (선택)

스크린샷 2024-12-02 16-44-53

📢 리뷰 요구사항 (선택)

@summersummerwhy summersummerwhy self-assigned this Dec 2, 2024
@summersummerwhy summersummerwhy added ✨ Feature 기능 추가 및 구현, 제안과 관련된 경우 🐧🚀😶‍🌫️ BE 백엔드 관련 이슈/PR 추적 라벨 labels Dec 2, 2024
Copy link
Member

@Tolerblanc Tolerblanc left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@github-actions github-actions bot merged commit 3322052 into develop Dec 2, 2024
21 checks passed
@github-actions github-actions bot deleted the dev-be-#362 branch December 2, 2024 07:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🐧🚀😶‍🌫️ BE 백엔드 관련 이슈/PR 추적 라벨 ✨ Feature 기능 추가 및 구현, 제안과 관련된 경우
Projects
None yet
Development

Successfully merging this pull request may close these issues.

workspace 정보 조회 API 구현
3 participants