API endpoint that allows querying compose-image RTT Test results.

Test tools

You can use curl in terminal, with -X method (GET|POST|PATCH), -d data (a json string). or GUI plugins for browsers, such as RESTClient, RESTConsole.

Documents & examples

Method: GET

URL: /rest_api/v1/compose-image-rtt-tests/

Query params:

  • arch (string)
  • compose (string)
  • file_name (string)
  • test_result (string)
  • variant (string)
  • ordering (string) Comma separated list of fields for ordering results.
    • To sort by a field in descending order, prefix its name with minus (e.g. -name).
    • Use double underscores for nested field names (e.g. parent__child for {"parent": {"child": ...}}).

Following filters can be used to show only specific fields. This can make response time faster. Format is list or single value (JSON: {"fields": ["a","b"]} or {"fields": "a"}, in URL: ?fields=a&fields=b).

  • fields (list | string) Fields to display (other fields will be hidden).
  • exclude_fields: (list | string) Fields NOT to display (overrules fields).

Response: a paged list of following objects

{
    "arch (read-only)": "string", 
    "compose (read-only)": "string", 
    "file_name (read-only)": "string", 
    "test_result": "ComposeAcceptanceTestingState.name", 
    "variant (read-only)": "string"
}

Method: GET

URL: /rest_api/v1/compose-image-rtt-tests/{compose_id}/{variant_uid}/{arch}/{file_name}/

Response:

{
    "arch (read-only)": "string", 
    "compose (read-only)": "string", 
    "file_name (read-only)": "string", 
    "test_result": "ComposeAcceptanceTestingState.name", 
    "variant (read-only)": "string"
}

Only test_result fields can be modified by this call. Trying to change anything else will result in 400 BAD REQUEST response.

Method: PATCH

URL: /rest_api/v1/compose-image-rtt-tests/{compose_id}/{variant_uid}/{arch}/{file_name}/

Data:

{
    "test_result": string
}

Response: same as for retrieve

It is possible to perform bulk partial update on composeimagertttest with PATCH method. The input must be a JSON object with composeimagertttest identifiers as keys. Values for these keys should be in the same format as when updating a single composeimagertttest.

Browsable GET

GET /rest_api/v1/compose-image-rtt-tests/
HTTP 200 OK
Allow: GET, PUT, PATCH, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "count": 84496,
    "next": "https://pdc.fedoraproject.org/rest_api/v1/compose-image-rtt-tests/?page=2",
    "previous": null,
    "results": [
        {
            "compose": "Fedora-Rawhide-20170502.n.0",
            "variant": "Atomic",
            "arch": "ppc64le",
            "file_name": "Fedora-Atomic-ostree-ppc64le-Rawhide-20170502.n.0.iso",
            "test_result": "untested"
        },
        {
            "compose": "Fedora-Rawhide-20170504.n.1",
            "variant": "Atomic",
            "arch": "ppc64le",
            "file_name": "Fedora-Atomic-ostree-ppc64le-Rawhide-20170504.n.1.iso",
            "test_result": "untested"
        },
        {
            "compose": "Fedora-Rawhide-20170505.n.0",
            "variant": "Atomic",
            "arch": "ppc64le",
            "file_name": "Fedora-Atomic-ostree-ppc64le-Rawhide-20170505.n.0.iso",
            "test_result": "untested"
        },
        {
            "compose": "Fedora-Rawhide-20170506.n.0",
            "variant": "Atomic",
            "arch": "ppc64le",
            "file_name": "Fedora-Atomic-ostree-ppc64le-Rawhide-20170506.n.0.iso",
            "test_result": "untested"
        },
        {
            "compose": "Fedora-Rawhide-20170507.n.0",
            "variant": "Atomic",
            "arch": "ppc64le",
            "file_name": "Fedora-Atomic-ostree-ppc64le-Rawhide-20170507.n.0.iso",
            "test_result": "untested"
        },
        {
            "compose": "Fedora-Rawhide-20170508.n.0",
            "variant": "Atomic",
            "arch": "ppc64le",
            "file_name": "Fedora-Atomic-ostree-ppc64le-Rawhide-20170508.n.0.iso",
            "test_result": "untested"
        },
        {
            "compose": "Fedora-Rawhide-20170511.n.0",
            "variant": "Atomic",
            "arch": "ppc64le",
            "file_name": "Fedora-Atomic-ostree-ppc64le-Rawhide-20170511.n.0.iso",
            "test_result": "untested"
        },
        {
            "compose": "Fedora-Rawhide-20170512.n.0",
            "variant": "Atomic",
            "arch": "ppc64le",
            "file_name": "Fedora-Atomic-ostree-ppc64le-Rawhide-20170512.n.0.iso",
            "test_result": "untested"
        },
        {
            "compose": "Fedora-Rawhide-20170514.n.1",
            "variant": "Atomic",
            "arch": "ppc64le",
            "file_name": "Fedora-Atomic-ostree-ppc64le-Rawhide-20170514.n.1.iso",
            "test_result": "untested"
        },
        {
            "compose": "Fedora-Rawhide-20170515.n.0",
            "variant": "Atomic",
            "arch": "ppc64le",
            "file_name": "Fedora-Atomic-ostree-ppc64le-Rawhide-20170515.n.0.iso",
            "test_result": "untested"
        },
        {
            "compose": "Fedora-Rawhide-20170516.n.0",
            "variant": "Atomic",
            "arch": "ppc64le",
            "file_name": "Fedora-Atomic-ostree-ppc64le-Rawhide-20170516.n.0.iso",
            "test_result": "untested"
        },
        {
            "compose": "Fedora-Rawhide-20170518.n.0",
            "variant": "Atomic",
            "arch": "ppc64le",
            "file_name": "Fedora-Atomic-ostree-ppc64le-Rawhide-20170518.n.0.iso",
            "test_result": "untested"
        },
        {
            "compose": "Fedora-Rawhide-20170624.n.1",
            "variant": "Atomic",
            "arch": "ppc64le",
            "file_name": "Fedora-Atomic-ostree-ppc64le-Rawhide-20170624.n.1.iso",
            "test_result": "untested"
        },
        {
            "compose": "Fedora-Rawhide-20170625.n.0",
            "variant": "Atomic",
            "arch": "ppc64le",
            "file_name": "Fedora-Atomic-ostree-ppc64le-Rawhide-20170625.n.0.iso",
            "test_result": "untested"
        },
        {
            "compose": "Fedora-Rawhide-20170626.n.0",
            "variant": "Atomic",
            "arch": "ppc64le",
            "file_name": "Fedora-Atomic-ostree-ppc64le-Rawhide-20170626.n.0.iso",
            "test_result": "untested"
        },
        {
            "compose": "Fedora-Rawhide-20170627.n.0",
            "variant": "Atomic",
            "arch": "ppc64le",
            "file_name": "Fedora-Atomic-ostree-ppc64le-Rawhide-20170627.n.0.iso",
            "test_result": "untested"
        },
        {
            "compose": "Fedora-Rawhide-20170702.n.0",
            "variant": "Atomic",
            "arch": "ppc64le",
            "file_name": "Fedora-Atomic-ostree-ppc64le-Rawhide-20170702.n.0.iso",
            "test_result": "untested"
        },
        {
            "compose": "Fedora-Rawhide-20170707.n.2",
            "variant": "Atomic",
            "arch": "ppc64le",
            "file_name": "Fedora-Atomic-ostree-ppc64le-Rawhide-20170707.n.2.iso",
            "test_result": "untested"
        },
        {
            "compose": "Fedora-Rawhide-20170708.n.0",
            "variant": "Atomic",
            "arch": "ppc64le",
            "file_name": "Fedora-Atomic-ostree-ppc64le-Rawhide-20170708.n.0.iso",
            "test_result": "untested"
        },
        {
            "compose": "Fedora-Rawhide-20170709.n.0",
            "variant": "Atomic",
            "arch": "ppc64le",
            "file_name": "Fedora-Atomic-ostree-ppc64le-Rawhide-20170709.n.0.iso",
            "test_result": "untested"
        }
    ]
}