Create API Specs

オープン
  • 何か問題がありますか？
#43 コメント 0 件 リアクション 0 件 担当者 1 名 GitHub で見る

@Gloobinours がすでに取り組んでいます。

2026年10月25日 から。

評価

この issue はまだ評価されていません。

説明

Description:
As a developer, I want to have an easy way to understand the API contracts so that I can code better.

Area of Responsibility

  • backend
  • documentation

Tasks:

  • Create all endpoints with definitions
  • Add examples to all endpoints that need them.
  • Create all object schemas
  • Create info and server section

Requirements (Acceptance Criteria):

  • Done when an OpenAPI YAML file is created with all the API contracts.

Testing Reuirements:

  • N/A

Always Make Sure:

  • The implementation builds successfully.
  • All tests written for the ticket, as well as all existing applicable tests, pass successfully.
  • Any documentation affected by the change has been updated.
  • The approved change has been successfully merged into main.
主要言語
CSS
スター
3
フォーク
1
平均マージ
22時間 6分
マージ済み PR（30日）
6

環境構築

  • Dockerfile または Docker Compose ファイルあり
  • プルリクエストのテンプレートあり
  • コントリビューションガイドなし

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

RIT-Software-Engineering/Open-Source-Sticker-Micro-Business のほかの issue

RIT-Software-Engineering/Open-Source-Sticker-Micro-Business の issue をすべて見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。