ATathenian
filter
default

Find releases that were published in the given time fram in the given repositories.

Changed on
post/filter/releases

Request

Request body

accountinteger required

Session account ID.

date_fromstring date required

Updates must be later than or equal to this date. An update is any action that influences the stage assignment.

date_tostring date required

Updates must be earlier than or equal to this date. An update is any action that influences the stage assignment.

timezoneinteger

Local time zone offset in minutes, used to adjust date_from and date_to.

inRepositoryID[]

Set of repositories. An empty list raises a bad response 400. Duplicates are automatically ignored.

labels_includestring[]

At least one of these labels must be present in at least one released PR.

labels_excludestring[]

PRs with these labels are excluded from ReleaseSet.data.prs.

Example request

{
  "account": 1,
  "date_from": "2020-01-23",
  "date_to": "2020-05-23",
  "in": [
    "{1}",
    "github.com/athenianco/athenian-webapp"
  ],
  "with": {
    "pr_author": [
      "github.com/vmarkovtsev"
    ]
  }
}

Response

Repositories that were updated within the given timeframe.

Example response

{
  "include": {
    "users": {
      "github.com/gkwillie": {
        "avatar": "https://avatars0.githubusercontent.com/u/60340680?v=4"
      }
    },
    "deployments": {
      "production-2020-03-26-W9J3uzHl": {
        "components": [
          {
            "repository": "github.com/athenianco/athenian-api",
            "reference": "v0.10.34"
          }
        ],
        "environment": "production",
        "date_finished": "2022-01-23T05:01:07.000+00:00",
        "date_started": "2022-01-23T04:56:07.000+00:00",
        "conclusion": "SUCCESS",
        "labels": {
          "helm_chart": "0.0.67"
        }
      }
    }
  },
  "data": [
    {
      "added_lines": 1000,
      "commits": 20,
      "deleted_lines": 200,
      "name": "v0.0.93",
      "sha": "e337123fc32c38cf6a8149b518f2e58ae836c8e6",
      "published": "2020-03-25T10:57:00Z",
      "publisher": "github.com/vmarkovtsev",
      "repository": "github.com/athenianco/athenian-api",
      "url": "https://github.com/athenianco/athenian-api/releases/tag/v0.0.93",
      "age": "1000s",
      "commit_authors": [
        "github.com/vmarkovtsev"
      ],
      "prs": []
    },
    {
      "added_lines": 1000,
      "commits": 20,
      "deleted_lines": 200,
      "name": "v0.0.93",
      "sha": "e337123fc32c38cf6a8149b518f2e58ae836c8e6",
      "published": "2020-03-25T10:57:00Z",
      "publisher": "github.com/vmarkovtsev",
      "repository": "github.com/athenianco/athenian-api",
      "url": "https://github.com/athenianco/athenian-api/releases/tag/v0.0.93",
      "age": "2000s",
      "commit_authors": [
        "github.com/vmarkovtsev"
      ],
      "prs": []
    }
  ]
}

Changes

  • f9fdd9fbfc25Revision changes
    • info

      added the new optional request property /

  • d08637dcd231Revision changes
    • breaking

      the /////// response property's maxLength was unset from 100 for the response status

    • breaking

      the /////// response property's minLength was decreased from 1 to 0 for the response status

    • info

      the /////// response's property pattern ^([^'\s]| ){1,100}$ was added for the status