published_at field in CLOTributor API

[aliok]

Sample call: https://clotributor.dev/api/issues/search?limit=1&offset=0&sort_by=most_recent

[
  {
    "number": 17811,
    "title": "🐛 Bug Report: `SidebarConfigContext` not respecting config prop values",
    "url": "https://github.com/backstage/backstage/issues/17811",
    "labels": [
      "bug",
      "help wanted"
    ],
    "published_at": 1684200943,
    "kind": "bug",
    "repository": {
      "name": "backstage",
      "url": "https://github.com/backstage/backstage",
      "homepage_url": "https://backstage.io",
      "topics": [
        "infrastructure",
        "dx",
        "developer-experience",
        "developer-portal",
        "service-catalog",
        "microservices",
        "cncf",
        "backstage",
        "hacktoberfest"
      ],
      "languages": [
        "TypeScript",
        "JavaScript",
        "Handlebars",
        "CSS",
        "Smarty"
      ],
      "stars": 21907
    },
    "project": {
      "name": "backstage",
      "display_name": "Backstage",
      "logo_url": "https://raw.githubusercontent.com/cncf/artwork/master/projects/backstage/icon/color/backstage-icon-color.svg",
      "devstats_url": "https://backstage.devstats.cncf.io/",
      "accepted_at": "2020-09-08",
      "maturity": "incubating",
      "foundation": "cncf"
    },
    "_relevance": 1
  }
]

I am curious about published_at. Is that issue creation datetime?

Are there any docs available? Or, a schema/struct/class or something similar that I can take a look?

[aliok]

Relevant: what sorting options are available other than most_recent?

[aliok]

Also relevant: perhaps you didn't really think that somebody would come and consume CLOTributor API, but I think it is a good data source.

[tegioz]

Thanks! 🙂

[tegioz]

I am curious about published_at. Is that issue creation datetime?

Yes, that field comes from:

clotributor/clotributor-tracker/src/graphql/repo_view.graphql

Line 20 in b8a71fd

publishedAt

Are there any docs available? Or, a schema/struct/class or something similar that I can take a look?

Not yet, but we'd like to add some API docs like the ones we have for Artifact Hub 🙂

In the meantime, maybe this can be of help:

• clotributor/clotributor-apiserver/src/db.rs

  Lines 67 to 83 in b8a71fd

  	/// Query input used when searching for issues.
  	#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
  	pub(crate) struct SearchIssuesInput {
  	pub limit: Option<usize>,
  	pub offset: Option<usize>,
  	pub sort_by: Option<String>,
  	pub foundation: Option<Vec<String>>,
  	pub maturity: Option<Vec<String>>,
  	pub project: Option<Vec<String>>,
  	pub area: Option<Vec<String>>,
  	pub kind: Option<Vec<String>>,
  	pub difficulty: Option<Vec<String>>,
  	pub language: Option<Vec<String>>,
  	pub mentor_available: Option<bool>,
  	pub good_first_issue: Option<bool>,
  	pub ts_query_web: Option<String>,
  	}

• clotributor/database/migrations/functions/issues/search_issues.sql

  Lines 170 to 172 in b8a71fd

  	order by
  	(case when v_sort_by = 'most_recent' then issue_published_at end) desc,
  	(case when v_sort_by = 'relevance' then (relevance, issue_published_at) end) desc

Hope that helps!

[aliok]

That helps, thanks!

[tegioz]

Out of curiosity, may I ask what would you like to build with it? 😇

[aliok]

Many people reach out to me, asking for beginner tasks to start contributing to CNCF.
I use CLOTributor to find tasks, but I want to be able to take some notes for the tasks like:

• "Person ABC said they're interested in this"
• "This task is too complex"
• "This task needs multiple persons"
• etc.

I guess it would be too much to ask to have in CLOtributor :)

So, I thought I might have a small thing that combines the information from CLOTtributor API and my notes from a JSON file.
I am still thinking about how to accomplish this the best way: spreadsheet generator vs modified CLOTributor webapp vs lightweight CLOTributor API client. Maybe in the end I won't do any coding but simply use a spreadsheet.

[tegioz]

That sounds cool, nice!

Maybe some of those points could somehow be summarized in the form of special labels in the issues, that we could highlight in the UI and integrate with the filters. "This task is too complex" kind of aligns with the difficulty, for example. Others may require a new special label, like the ones described in the README file. But this information could be really helpful for others 🙂

Once CLOTributor becomes a bit more popular and projects are aware of how to make the most of it by applying some labels to issues, filters will be more effective and search results more accurate, and hopefully it'll be easier for contributors to find tasks that suit their interests and skills.

[aliok]

The problem is that I cannot add labels to random CNCF projects myself :) Also, I wouldn't want that anyway. Hence, I wanted to go with a custom thing where I can store my own notes.