Swagger API documentation and flask-restplus: How to represent an object with a key in the body of a request

I have this example of the parameter needed in the body of a PUT request to my API:

{

  "id": "string",

  "closed_date": "2018-11-20T18:42:58.946Z",

  "contact": "string",

  "description": "string",

  "status": "Open"

}

To have it represented in my Swagger end point documentation I did this :

@api.doc(body=card_change_fields)

    def put(self, card_id, *args, **kwargs):

Where:

card_change_fields = api.model('card modification', {



        'id': fields.String(description='id', required=True),

        'closed_date': fields.DateTime(description='Closed date'),

        'contact': fields.String(description='Contact'),

        'description': fields.String(description='Description'),

        'status': fields.String(description='Status', required=True,

                                enum=["Open", "Closed"])

})

However what I want is actually this :

{  card : {

  "id": "string",

  "closed_date": "2018-11-20T18:42:58.946Z",

  "contact": "string",

  "description": "string",

  "status": "Open" }

}

How can I do this in my flask-restplus swagger documentation ?
I tried with child and parent model and expect with no success

Thanks,
DT

edited Nov 20 at 22:54

asked Nov 20 at 19:03

DTG

257

add a comment |

I have this example of the parameter needed in the body of a PUT request to my API:

{

  "id": "string",

  "closed_date": "2018-11-20T18:42:58.946Z",

  "contact": "string",

  "description": "string",

  "status": "Open"

}

To have it represented in my Swagger end point documentation I did this :

@api.doc(body=card_change_fields)

    def put(self, card_id, *args, **kwargs):

Where:

card_change_fields = api.model('card modification', {



        'id': fields.String(description='id', required=True),

        'closed_date': fields.DateTime(description='Closed date'),

        'contact': fields.String(description='Contact'),

        'description': fields.String(description='Description'),

        'status': fields.String(description='Status', required=True,

                                enum=["Open", "Closed"])

})

However what I want is actually this :

{  card : {

  "id": "string",

  "closed_date": "2018-11-20T18:42:58.946Z",

  "contact": "string",

  "description": "string",

  "status": "Open" }

}

How can I do this in my flask-restplus swagger documentation ?
I tried with child and parent model and expect with no success

Thanks,
DT

edited Nov 20 at 22:54

asked Nov 20 at 19:03

DTG

257

add a comment |

I have this example of the parameter needed in the body of a PUT request to my API:

{

  "id": "string",

  "closed_date": "2018-11-20T18:42:58.946Z",

  "contact": "string",

  "description": "string",

  "status": "Open"

}

To have it represented in my Swagger end point documentation I did this :

@api.doc(body=card_change_fields)

    def put(self, card_id, *args, **kwargs):

Where:

card_change_fields = api.model('card modification', {



        'id': fields.String(description='id', required=True),

        'closed_date': fields.DateTime(description='Closed date'),

        'contact': fields.String(description='Contact'),

        'description': fields.String(description='Description'),

        'status': fields.String(description='Status', required=True,

                                enum=["Open", "Closed"])

})

However what I want is actually this :

{  card : {

  "id": "string",

  "closed_date": "2018-11-20T18:42:58.946Z",

  "contact": "string",

  "description": "string",

  "status": "Open" }

}

How can I do this in my flask-restplus swagger documentation ?
I tried with child and parent model and expect with no success

Thanks,
DT

edited Nov 20 at 22:54

asked Nov 20 at 19:03

DTG

257

I have this example of the parameter needed in the body of a PUT request to my API:

{

  "id": "string",

  "closed_date": "2018-11-20T18:42:58.946Z",

  "contact": "string",

  "description": "string",

  "status": "Open"

}

To have it represented in my Swagger end point documentation I did this :

@api.doc(body=card_change_fields)

    def put(self, card_id, *args, **kwargs):

Where:

card_change_fields = api.model('card modification', {



        'id': fields.String(description='id', required=True),

        'closed_date': fields.DateTime(description='Closed date'),

        'contact': fields.String(description='Contact'),

        'description': fields.String(description='Description'),

        'status': fields.String(description='Status', required=True,

                                enum=["Open", "Closed"])

})

However what I want is actually this :

{  card : {

  "id": "string",

  "closed_date": "2018-11-20T18:42:58.946Z",

  "contact": "string",

  "description": "string",

  "status": "Open" }

}

How can I do this in my flask-restplus swagger documentation ?
I tried with child and parent model and expect with no success

Thanks,
DT

python-3.x api flask swagger flask-restplus

edited Nov 20 at 22:54

asked Nov 20 at 19:03

DTG

257

edited Nov 20 at 22:54

asked Nov 20 at 19:03

DTG

257

edited Nov 20 at 22:54

asked Nov 20 at 19:03

DTG

257

asked Nov 20 at 19:03

DTG

257

asked Nov 20 at 19:03

DTG

257

add a comment |

1 Answer
1

active

oldest

votes

You need to use fields.Nested to use a model to be a input of another Model. Check the code below:

card_change_fields = api.model('card modification', {

                'id': fields.String(description='id', required=True),

                'closed_date': fields.DateTime(description='Closed date'),

                'contact': fields.String(description='Contact'),

                'description': fields.String(description='Description'),

                'status': fields.String(description='Status', required=True,

                                        enum=["Open", "Closed"])

})



card = api.model('Card', {

    'card': fields.Nested(card_change_fields, required=True)

})

And respectively your doc rendering will also change to:

@api.doc(body=card)

    def put(self, card_id, *args, **kwargs):

answered Nov 23 at 12:52

Sawan Choudhary

211

Yes your response was correct.It works exactly as I expected. Thank you for your help.
– DTG
Nov 23 at 21:27

add a comment |

Your Answer

StackExchange.ifUsing("editor", function () {
StackExchange.using("externalEditor", function () {
StackExchange.using("snippets", function () {
StackExchange.snippets.init();
});
});
}, "code-snippets");

StackExchange.ready(function() {
var channelOptions = {
tags: "".split(" "),
id: "1"
};
initTagRenderer("".split(" "), "".split(" "), channelOptions);

StackExchange.using("externalEditor", function() {
// Have to fire editor after snippets, if snippets enabled
if (StackExchange.settings.snippets.snippetsEnabled) {
StackExchange.using("snippets", function() {
createEditor();
});
}
else {
createEditor();
}
});

function createEditor() {
StackExchange.prepareEditor({
heartbeatType: 'answer',
autoActivateHeartbeat: false,
convertImagesToLinks: true,
noModals: true,
showLowRepImageUploadWarning: true,
reputationToPostImages: 10,
bindNavPrevention: true,
postfix: "",
imageUploader: {
brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
allowUrls: true
},
onDemand: true,
discardSelector: ".discard-answer"
,immediatelyShowMarkdownHelp:true
});

}
});

draft saved

draft discarded

Sign up or log in

StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});

Post as a guest

Name

Required, but never shown

StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53399835%2fswagger-api-documentation-and-flask-restplus-how-to-represent-an-object-with-a%23new-answer', 'question_page');
}
);

Post as a guest

Name

Required, but never shown

1 Answer
1

active

oldest

votes

1 Answer
1

active

oldest

votes

You need to use fields.Nested to use a model to be a input of another Model. Check the code below:

card_change_fields = api.model('card modification', {

                'id': fields.String(description='id', required=True),

                'closed_date': fields.DateTime(description='Closed date'),

                'contact': fields.String(description='Contact'),

                'description': fields.String(description='Description'),

                'status': fields.String(description='Status', required=True,

                                        enum=["Open", "Closed"])

})



card = api.model('Card', {

    'card': fields.Nested(card_change_fields, required=True)

})

And respectively your doc rendering will also change to:

@api.doc(body=card)

    def put(self, card_id, *args, **kwargs):

answered Nov 23 at 12:52

Sawan Choudhary

211

Yes your response was correct.It works exactly as I expected. Thank you for your help.
– DTG
Nov 23 at 21:27

add a comment |

You need to use fields.Nested to use a model to be a input of another Model. Check the code below:

card_change_fields = api.model('card modification', {

                'id': fields.String(description='id', required=True),

                'closed_date': fields.DateTime(description='Closed date'),

                'contact': fields.String(description='Contact'),

                'description': fields.String(description='Description'),

                'status': fields.String(description='Status', required=True,

                                        enum=["Open", "Closed"])

})



card = api.model('Card', {

    'card': fields.Nested(card_change_fields, required=True)

})

And respectively your doc rendering will also change to:

@api.doc(body=card)

    def put(self, card_id, *args, **kwargs):

answered Nov 23 at 12:52

Sawan Choudhary

211

Yes your response was correct.It works exactly as I expected. Thank you for your help.
– DTG
Nov 23 at 21:27

add a comment |

You need to use fields.Nested to use a model to be a input of another Model. Check the code below:

card_change_fields = api.model('card modification', {

                'id': fields.String(description='id', required=True),

                'closed_date': fields.DateTime(description='Closed date'),

                'contact': fields.String(description='Contact'),

                'description': fields.String(description='Description'),

                'status': fields.String(description='Status', required=True,

                                        enum=["Open", "Closed"])

})



card = api.model('Card', {

    'card': fields.Nested(card_change_fields, required=True)

})

And respectively your doc rendering will also change to:

@api.doc(body=card)

    def put(self, card_id, *args, **kwargs):

answered Nov 23 at 12:52

Sawan Choudhary

211

You need to use fields.Nested to use a model to be a input of another Model. Check the code below:

card_change_fields = api.model('card modification', {

                'id': fields.String(description='id', required=True),

                'closed_date': fields.DateTime(description='Closed date'),

                'contact': fields.String(description='Contact'),

                'description': fields.String(description='Description'),

                'status': fields.String(description='Status', required=True,

                                        enum=["Open", "Closed"])

})



card = api.model('Card', {

    'card': fields.Nested(card_change_fields, required=True)

})

And respectively your doc rendering will also change to:

@api.doc(body=card)

    def put(self, card_id, *args, **kwargs):

answered Nov 23 at 12:52

Sawan Choudhary

211

answered Nov 23 at 12:52

Sawan Choudhary

211

answered Nov 23 at 12:52

Sawan Choudhary

211

answered Nov 23 at 12:52

Sawan Choudhary

211

Yes your response was correct.It works exactly as I expected. Thank you for your help.
– DTG
Nov 23 at 21:27

add a comment |

Yes your response was correct.It works exactly as I expected. Thank you for your help.
– DTG
Nov 23 at 21:27

Yes your response was correct.It works exactly as I expected. Thank you for your help.
– DTG
Nov 23 at 21:27

add a comment |

draft saved

draft discarded

Thanks for contributing an answer to Stack Overflow!

Please be sure to answer the question. Provide details and share your research!

But avoid …

Asking for help, clarification, or responding to other answers.

Making statements based on opinion; back them up with references or personal experience.

To learn more, see our tips on writing great answers.

Some of your past answers have not been well-received, and you're in danger of being blocked from answering.

Please pay close attention to the following guidance:

Please be sure to answer the question. Provide details and share your research!

But avoid …

Asking for help, clarification, or responding to other answers.

Making statements based on opinion; back them up with references or personal experience.

To learn more, see our tips on writing great answers.

draft saved

draft discarded

Sign up or log in

StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});

Post as a guest

Name

Required, but never shown

Post as a guest

Name

Required, but never shown

Sign up or log in

StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});

Post as a guest

Name

Required, but never shown

Sign up or log in

StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});

Post as a guest

Name

Required, but never shown

Sign up or log in

StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});

Post as a guest

Name

Required, but never shown

Name

Required, but never shown

Name

Required, but never shown

This page is only for reference, If you need detailed information, please check here

搜尋此網誌

Ytukyg