Breakdown of WIF API requests

[penyuan]

I'm using this issue to gather my notes from various places into one place to track the (1) prioritised dashboard features for 2022; and (2) the WIF API requests needed by each one.

WIF prioritised dashboard indicators

• File types (number and proportion)
  • API: get file tree
    • This is doable, including getting the file mimetypes from the API 👍🏼
• Issue activity level
  • API: list of a project's issues
    • timestamps of items in issue thread
• Commits over time
  • API: list of a project's contributions
    • timestamp of each contribution
• User skills/tags profile
  • API: user tags
  • (this depends on the ongoing implementation of user (and project) skill tags)
• Manufacturing metadata
  • API: project tags (for now)
    • Also identify OKH manifest file from file list if possible
• Standards compliance metadata
  • API: project tags (for now)
    • Also identify OKH manifest file from file list if possible
• LICENSE file and meanings
  • API: project license which returns SPDX
  • API: get file tree to identify LICENSE file
    • then need to parse LICENSE if it exists
  • API:
    • GitLab licenses list API with metadata
    • GitHub licenses list API with metadata
      • https://lwn.net/Articles/636261/
      • Guide for using choosealicense.com repository: https://devpost.com/software/choosealicense-com
        • Useful for adding hardware licenses
    • BTW, since the license list doesn't change often, a bonus would be to cache the license list and metadata so as to not call the GitLab/GitHub APIs all the time.
• Files editability
  • API: get file tree
    • then analyse file types to infer editability
• Different views for stakeholder types
  • This is probably some dynamic view with combinations of the above