Skip to content

Get Project

Method

REST method is adopted.

HTTP Method

GET: Retrieve a single project by ID

Naming Convention

To unify naming of query parameters and nodes and improve readability, snake_case is used for URIs and nodes in JSON during requests.

Request and Response

Headers

Meta information is set in HTTP headers rather than in the response body.

Request Headers

  • Authorization: Bearer <access_token>
  • Content-Type: application/json

Response Headers

  • Content-Type: application/json

Get Project

URI

Path parameter type is integer. 

/api/v1/projects/{project_id}

Response (200 OK)

Response is JSON. 

{
  "id": 1,
  "organizationId": 1,
  "name": "Project Alpha",
  "createdAt": 1640995200000,
  "updatedAt": 1640995200000,
  "createdBy": "1111-aaaa-2222-bbbb",
  "updatedBy": "1111-aaaa-2222-bbbb",
  "deletedAt": null,
  "deletedBy": null
}

Authentication

Authentication is performed using JSON Web Tokens (JWT) issued by Amazon Cognito. A valid Bearer token is required in the Authorization header.

Exception Handling

Exception handling status codes are as follows.

Description Status Code Status Name
Missing or invalid token 401 Unauthorized
Project not found 404 Not Found
Internal server error 500 Internal Server Error

Process Flow

Sequence Diagram

sequenceDiagram
    participant Client
    participant Middleware as Protected Route Middleware
    participant API as Hono Router
    participant Service as Project Service
    participant DB as PostgreSQL Database

    Client->>Middleware: GET /api/v1/projects/{project_id}
    Middleware->>Middleware: Verify JWT & session

    alt Token Valid
        Middleware-->>API: Auth info
        API->>Service: getById(id)
        Service->>DB: findOneByIdOnly(id, includeDeleted=false)
        DB-->>Service: Project record

        alt Project Found
            Service-->>API: Project
            API-->>Client: 200 OK
        else Project Not Found
            Service-->>API: throw NotFoundError
            API-->>Client: 404 Not Found
        end
    else Token Invalid
        Middleware-->>Client: 401 Unauthorized
    end

Routes Layer

API routing is performed here. The protectedRoute middleware validates the JWT token. The handler extracts the project_id path parameter and delegates to the project service.

Source: apps/admin/src/routes/v1/project.ts

Services Layer

This section describes business logic. It looks up the project by ID and throws a NotFoundError if the project does not exist or is soft-deleted.

Source: apps/admin/src/services/project.ts

Repositories Layer

This section describes access to databases. It handles single project lookup by ID, excluding soft-deleted records.

Source: apps/admin/src/repositories/project.ts

Security

  • Token validated by protectedRoute middleware before handler execution
  • Soft-deleted projects are excluded from results