Skip to content

v1 API seems broken when compared to the v1 API docs #1610

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
khilnani opened this issue Aug 30, 2015 · 0 comments
Closed

v1 API seems broken when compared to the v1 API docs #1610

khilnani opened this issue Aug 30, 2015 · 0 comments
Labels
Bug A bug Needed: documentation Documentation is required

Comments

@khilnani
Copy link

When i review the end points below against https://read-the-docs.readthedocs.org/en/latest/api.html , the end point resources below do not match the documentation.

Are the end points working correctly??

{
"objects": []
}

instead of the below as per docs

{
    "objects": [
        "http//django-fab-deploy.readthedocs.org/en/latest/...",
        "http//dimagi-deployment-tools.readthedocs.org/en/...",
        "http//openblock.readthedocs.org/en/latest/install/base_install.html#virtualenv",
        ...
    ]
}
{
"facets": {},
"objects": [],
"page": {
"num_pages": 1,
"number": 1,
"object_count": 0,
"page_range": [
1
],
"per_page": 20,
"url_template": "/api/v1/file/search/?q=virtualenvwrapper&format=json&page={0}"
}
}

instead of the below as per docs

{
    "objects": [
        {
            "absolute_url": "/docs/python-guide/en/latest/scenarios/virtualenvs/index.html",
            "id": "375539",
            "name": "index.html",
            "path": "scenarios/virtualenvs/index.html",
            "project": {
                "absolute_url": "/projects/python-guide/",
                "analytics_code": null,
                "copyright": "Unknown",
                "crate_url": "",
                "default_branch": "",
                "default_version": "latest",
                "description": "[WIP] Python best practices...",
                "django_packages_url": "",
                "documentation_type": "sphinx_htmldir",
                "id": "530",
                "modified_date": "2012-03-13T01:05:30.191496",
                "name": "python-guide",
                "project_url": "",
                "pub_date": "2011-03-20T19:40:03.599987",
                "repo": "git://github.com/kennethreitz/python-guide.git",
                "repo_type": "git",
                "requirements_file": "",
                "resource_uri": "/api/v1/project/530/",
                "slug": "python-guide",
                "subdomain": "http://python-guide.readthedocs.org/",
                "suffix": ".rst",
                "theme": "kr",
                "use_virtualenv": false,
                "users": [
                    "/api/v1/user/130/"
                ],
                "version": ""
            },
            "resource_uri": "/api/v1/file/375539/",
            "text": "...<span class=\"highlighted\">virtualenvwrapper</span>\n..."
        },
        ...
    ]
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug A bug Needed: documentation Documentation is required
Projects
None yet
Development

No branches or pull requests

2 participants