Pz/types 003 - Categories API

[p-zielinski]

20230828

Added schemas

• CategoryObject
• CreateCategory
• ResponseCreateCategory
• UpdateCategoryRequest
• ResponseUpdateCategory
• ListCategories

Endpoints changes

• /v1/categories
• GET
• Response schema was replaced with ListCategories
• POST
• Request parameters schema was replaced with CreateCategory
• Response schema was replaced with ResponseCreateCategory
• /v1/categories/{categoryId}
• GET
• Response schema was replaced with CategoryObject
• PUT
• Request parameters schema was replaced with UpdateCategoryRequest
• Response schema was replaced with ResponseUpdateCategory

[marcin-slezak]

Sprawdzić czy w OpenAPI możemy robić coś na zasadzie “Omit<>” z TS?
W PR 003 (zarówno kod jak i dokumentacja) musimy dostosować nazewnictwo do naszego patternu, doprecyzować również nazewnictwo np. Liczba mnoga/pojedyńćza?
Zaproponować bardziej logiczny sposób tworzenia struktury obiektów

• bazowy obiekt “Category”
• “CategoryListResponse” -> używać “Category”
• “CategoriesCreate” -> używać “Category”
  Upewnić się, że pola required/optional są poprawne zarówno w SDK jak i OpenAPI
  Jak zaproponowana struktura obiektów wyświetli się w Readmeio??