AB-Law / AB-Law/Pluck-It

IWardrobeRepository / WardrobeFunctions: Missing contract documentation on public interface and HTTP endpoints

Đang mở
#102 0 bình luận 0 reaction 0 người được giao Xem trên GitHub
documentation
Ngôn ngữ chính
TypeScript
Star
0
Fork
0
Merge trung bình
16 phút
Pull request đã merge (30 ngày)
1

Mô tả

## Problem

`PluckIt.Core/IWardrobeRepository.cs` has no XML documentation on any method. `PluckIt.Functions/Functions/WardrobeFunctions.cs` HTTP endpoints have no documentation on accepted query parameters, request body shape, or returned error codes (400/401/404/422/500).

## Impact

New developers must read through implementation code to understand contracts. API clients (including the Angular frontend) have no specification for error handling.

## Proposed Fix

- Add XML ``, ``, ``, and `` tags to all public interface methods in `IWardrobeRepository`.
- Add a comment block to each `[Function]` handler in `WardrobeFunctions.cs` listing HTTP method, route params, request body schema, and possible error responses.

## Functionality Impact

No runtime change; improves developer experience and reduces onboarding friction.

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Đánh giá

Issue này chưa được đánh giá.

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.