Skip to content
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

Remove foreign keys in swagger docs #396

Open
dankolbman opened this issue Jul 17, 2018 · 0 comments
Open

Remove foreign keys in swagger docs #396

dankolbman opened this issue Jul 17, 2018 · 0 comments
Assignees
Labels
bug Something isn't working documentation Regarding developer or user documentation help wanted Extra attention is needed

Comments

@dankolbman
Copy link
Contributor

The foreign key relationships currently show up inside of the results object inside of the swagger docs:

{
    "_links": {
        "next": "/genomic-files?after=1519402953",
        "self": "/genomic-files?after=1519402952"
    },
    "_status": {
        "code": 200,
        "message": "success"
    },
    "limit": 10,
    "results": [
        {
            "_links": "string",
            "biospecimen_id": "string",
            "kf_id": "string"
            ...
        }
    ],
    "total": 1

}

However, they show up in the _links section inside of the actual API:

{
    "_links": {
        "next": "/genomic-files?after=1519402953",
        "self": "/genomic-files?after=1519402952"
    },
    "_status": {
        "code": 200,
        "message": "success"
    },
    "limit": 10,
    "results": [
        {
            "_links": {
                "biospecimen": "/biospecimens/BS_00000000"
            },
            "kf_id": "string"
            ...
        }
    ],
    "total": 1

}
@dankolbman dankolbman added bug Something isn't working documentation Regarding developer or user documentation help wanted Extra attention is needed labels Jul 17, 2018
@parimalak parimalak self-assigned this Aug 1, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Regarding developer or user documentation help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants