Project

Profile

Help

Issue #1122

closed

update response body in docs on Retrieve Importer(s) Associated with a Repository

Added by igulina@redhat.com over 8 years ago. Updated almost 4 years ago.

Status:
CLOSED - CURRENTRELEASE
Priority:
Normal
Category:
-
Sprint/Milestone:
-
Start date:
Due date:
Estimated time:
Severity:
3. High
Version:
2.7.0 Beta
Platform Release:
2.8.0
OS:
Triaged:
Yes
Groomed:
No
Sprint Candidate:
No
Tags:
Documentation, Pulp 2
Sprint:
Quarter:

Description

In docs for retrieving all importers [1] and a particular importer [2] associated with a repo response bodies differ from reality. For example, "_href" is missing and _id value is a dictionary including "$oid": . I'm not sure about "config" format. And I believe "sync_in_progress": false was replaced with "scheduled_syncs": [].

>> curl -s -H "Accept: application/json" -H "WebFrameworkSwitch: webpy" -X GET -k -u admin:admin https://localhost/pulp/api/v2/repositories/zoopark/importers/ | python -mjson.tool
[
    {
        "_href": "/pulp/api/v2/repositories/zoopark/importers/yum_importer/",
        "_id": {
            "$oid": "559be5fb77b2943159a2a436" 
        },
        "_ns": "repo_importers",
        "config": {
            "feed": "https://repos.fedorapeople.org/repos/pulp/pulp/demo_repos/zoo/" 
        },
        "id": "yum_importer",
        "importer_type_id": "yum_importer",
        "last_sync": null,
        "repo_id": "zoopark",
        "scheduled_syncs": [],
        "scratchpad": null
    }
]

>> curl -s -H "Accept: application/json" -H "WebFrameworkSwitch: webpy" -X GET -k -u admin:admin https://localhost/pulp/api/v2/repositories/zoopark/importers/yum_importer/ | python -mjson.tool
{
    "_href": "/pulp/api/v2/repositories/zoopark/importers/yum_importer/",
    "_id": {
        "$oid": "559be5fb77b2943159a2a436" 
    },
    "_ns": "repo_importers",
    "config": {
        "feed": "https://repos.fedorapeople.org/repos/pulp/pulp/demo_repos/zoo/" 
    },
    "id": "yum_importer",
    "importer_type_id": "yum_importer",
    "last_sync": null,
    "repo_id": "zoopark",
    "scheduled_syncs": [],
    "scratchpad": null
}

[1] http://pulp.readthedocs.org/en/latest/dev-guide/integration/rest-api/repo/retrieval.html#retrieve-importers-associated-with-a-repository

[2] http://pulp.readthedocs.org/en/latest/dev-guide/integration/rest-api/repo/retrieval.html#retrieve-an-importer-associated-with-a-repository

Also available in: Atom PDF