Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GetPostsParameters

GET /v1/teams/:team_name/postsに指定できるURIクエリ文字列

公式ドキュメント: dev/esa/api/v1 #noexpand - docs.esa.io

Hierarchy

  • GetPostsParameters

Index

Properties

Properties

Optional Readonly include

include: ReadonlyArray<"comments" | "comments.stargazers" | "stargazers">

投稿の関連情報を含めることができます。

  • comments を指定するとコメントの配列を含んだレスポンスを返します。
  • stargazers を指定するとStarの配列を含んだレスポンスを返します。
  • 複数指定できます。

Optional Readonly order

order: "desc" | "asc"

並び順の方向

  • desc (default): 降順
  • asc: 昇順

Optional Readonly q

q: undefined | string

記事を絞り込むための条件を指定します

help/記事の検索方法 - docs.esa.ioを参照

Optional Readonly sort

sort: "updated" | "created" | "number" | "stars" | "watches" | "comments" | "best_match"

投稿の並び順

  • updated (default): 記事の更新日時
  • created: 記事の作成日時
  • number: 記事番号
  • stars: 記事へのStarの数
  • watches: 記事へのWatchの数
  • comments: 記事へのCommentの数
  • best_match: 総合的な記事のスコア

Generated using TypeDoc