Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Update README to explain `top` in pagination response

オープン
#374 コメント 3 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
1/5
見積もり時間
1時間未満
初心者へのやさしさ
45/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
openapi
領域
api, documentation

調査の方向性

リンク先のswagger.yamlの1758行付近のセクションから始め、READMEのページネーションに関するドキュメントを見つけてください。topプロパティがどこで説明されているかを確認し、サーバーによって課される制限と、ページサイズが要求されない場合のデフォルト値も含めてください。READMEにこの動作とFoundation APIへの適用可能性を明確に記載できれば完了です。

索引モデルが issue の本文から書いたものです。

説明

https://github.com/buildingSMART/BCF-API/blob/19ac4f410728994bb67fb1552c974b4ec36d6f90/swagger.yaml#L1758

The top property describes how many items are at most returned per request / per page. If a server responds with a lower top value than what the client originally asked for, then that means the server has imposed a lower limit than what was requested.

If no page size is requested, the server will still populate the top property with it's default limit.

Maybe this part should be included in the Foundation API?

主要言語
言語のデータがありません
スター
239
フォーク
67
PR マージ指標
30日以内にマージされた PR はありません

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

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

buildingSMART/BCF-API のほかの issue

buildingSMART/BCF-API の issue をすべて見る

似ている issue

Backend & API Design の issue をもっと見る

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

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