microsoft / microsoft/azure-devops-python-api

list_groups() documentation unclear, as is the REST API related to it.

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

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

主要言語
Python
スター
684
フォーク
218
平均マージ
8日 10時間
マージ済み PR(30日)
1

説明

In this section:

which has this blob of code:

    def list_groups(self, scope_descriptor=None, subject_types=None, continuation_token=None):
        """ListGroups.
        [Preview API] Gets a list of all groups in the current scope (usually organization or account).
        :param str scope_descriptor: Specify a non-default scope (collection, project) to search for groups.
        :param [str] subject_types: A comma separated list of user subject subtypes to reduce the retrieved results, e.g. Microsoft.IdentityModel.Claims.ClaimsIdentity
        :param str continuation_token: An opaque data blob that allows the next page of data to resume immediately after where the previous page ended. The only reliable way to know if there is more data left is the presence of a continuation token.
        :rtype: :class:`<PagedGraphGroups> <azure.devops.v5_1.graph.models.PagedGraphGroups>`
        """

what is actually meant by these pieces and where should I find that information? The REST API docs dont' really tell much and aren't much help either.

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

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

調査の方向性

azure-devops/azure/devops/v5_1/graph/graph_client.py の145〜152行付近から始め、list_groups のdocstringをリンク先の Azure DevOps Graph Groups REST ドキュメントと比較してください。各パラメーターと返される PagedGraphGroups の値が何を意味するのかを確認し、その後、ユーザーが明確な説明と参照先を見つけられるよう、関連するドキュメントを更新してください。

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

評価

技術スタック
azure, python
領域
api, documentation
issue の種類
ドキュメント
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
35/100

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

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