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

Small mismatch in user info from /proposal vs /person

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

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

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
48/100
issue の種類
バグ
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
fastapi, python

調査の方向性

まず、表示されているレスポンスを生成するエントリーポイント /v1/proposal/{id} と /v1/person/username/{username} を追跡します。それぞれの user フィールドを比較し、first_name、last_name、orcid、institution について、プロジェクトで意図されている命名と利用可能性を判断します。関連する API レスポンスで合意したフィールドが一貫して公開され、変更をカバーするテストがあることを完了条件とします。

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

説明

The "users" key in the /v1/proposal's response is not the same as the response in /person

For example: https://api.nsls2.bnl.gov/v1/proposal/320326
The users section in the url above has my user info:

{
  "first_name": "Venkateswaran",
  "last_name": "Shekar",
  "email": "[email protected]",
  "bnl_id": "27196",
  "username": "vshekar1",
  "is_pi": false,
  "orcid": "0000-0001-5625-2475"
}

While the response in: https://api.nsls2.bnl.gov/v1/person/username/vshekar1

{
  "firstname": "Venkateswaran",
  "lastname": "Shekar",
  "email": "[email protected]",
  "username": "vshekar1",
  "bnl_id": "27196",
  "bnl_employee": true,
  "institution": "Brookhaven National Laboratory",
  "orcid": null,
  "globus_username": null,
  "pass_unique_id": null,
  "account_locked": null,
  "cyber_agreement_signed": "2022-08-01T00:00:00",
  "facility_code": null,
  "facility_name": null,
  "citizenship": null
}

Would be good to standardize first_name + last_name key names in both responses. Additionally the orcid is not available in /v1/person. Finally if user "institution" is available in the proposal response, it would be really useful for the lambda project.

Happy to make a PR so address them

主要言語
Python
スター
0
フォーク
13
PR マージ指標
30日以内にマージされた PR はありません

環境構築

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

はじめの一歩

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

NSLS2/nsls2api のほかの issue

NSLS2/nsls2api の issue をすべて見る

似ている issue

Python の issue をもっと見る

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

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