Swagger Array: Null Values Swag











up vote
0
down vote

favorite












I am currently working on creating a swagger file to call an API. As part of the application some values have to have the option of being a single value or an array. In order to do so I do the following



    Name:
Type: array
Items:
Type:string
Example: John


The issue is that when I dont fill in this portion of the request, swagger still sends



     "Name":  


into the curl request which causes an error in my application. Is there a way to modify this code so when nothing is put into the request the the curl request doesn't have a "Name" Field? Similar to when the Type is just string, when nothing is specified, no information is put into the curl request.



Name:      
Type: String


I used the following link as reference and thought Nullable: would be a potential solution but this throws an error within the swagger editor.



https://swagger.io/docs/specification/data-models/data-types/



Thank you!










share|improve this question






















  • Do you use swagger: '2.0' or openapi: 3.0.0? Does the array need to be sent in the query string or request body? What is the current curl command, and what curl do you expect to get? Can you also post the complete API definition? (The example you posted is not valid syntax - the indentation is off and the keywords must be lowercase, e.g. type: string not Type: String.)
    – Helen
    Nov 20 at 9:18















up vote
0
down vote

favorite












I am currently working on creating a swagger file to call an API. As part of the application some values have to have the option of being a single value or an array. In order to do so I do the following



    Name:
Type: array
Items:
Type:string
Example: John


The issue is that when I dont fill in this portion of the request, swagger still sends



     "Name":  


into the curl request which causes an error in my application. Is there a way to modify this code so when nothing is put into the request the the curl request doesn't have a "Name" Field? Similar to when the Type is just string, when nothing is specified, no information is put into the curl request.



Name:      
Type: String


I used the following link as reference and thought Nullable: would be a potential solution but this throws an error within the swagger editor.



https://swagger.io/docs/specification/data-models/data-types/



Thank you!










share|improve this question






















  • Do you use swagger: '2.0' or openapi: 3.0.0? Does the array need to be sent in the query string or request body? What is the current curl command, and what curl do you expect to get? Can you also post the complete API definition? (The example you posted is not valid syntax - the indentation is off and the keywords must be lowercase, e.g. type: string not Type: String.)
    – Helen
    Nov 20 at 9:18













up vote
0
down vote

favorite









up vote
0
down vote

favorite











I am currently working on creating a swagger file to call an API. As part of the application some values have to have the option of being a single value or an array. In order to do so I do the following



    Name:
Type: array
Items:
Type:string
Example: John


The issue is that when I dont fill in this portion of the request, swagger still sends



     "Name":  


into the curl request which causes an error in my application. Is there a way to modify this code so when nothing is put into the request the the curl request doesn't have a "Name" Field? Similar to when the Type is just string, when nothing is specified, no information is put into the curl request.



Name:      
Type: String


I used the following link as reference and thought Nullable: would be a potential solution but this throws an error within the swagger editor.



https://swagger.io/docs/specification/data-models/data-types/



Thank you!










share|improve this question













I am currently working on creating a swagger file to call an API. As part of the application some values have to have the option of being a single value or an array. In order to do so I do the following



    Name:
Type: array
Items:
Type:string
Example: John


The issue is that when I dont fill in this portion of the request, swagger still sends



     "Name":  


into the curl request which causes an error in my application. Is there a way to modify this code so when nothing is put into the request the the curl request doesn't have a "Name" Field? Similar to when the Type is just string, when nothing is specified, no information is put into the curl request.



Name:      
Type: String


I used the following link as reference and thought Nullable: would be a potential solution but this throws an error within the swagger editor.



https://swagger.io/docs/specification/data-models/data-types/



Thank you!







curl swagger swagger-ui swagger-2.0 swagger-editor






share|improve this question













share|improve this question











share|improve this question




share|improve this question










asked Nov 20 at 0:17









Adam

1




1












  • Do you use swagger: '2.0' or openapi: 3.0.0? Does the array need to be sent in the query string or request body? What is the current curl command, and what curl do you expect to get? Can you also post the complete API definition? (The example you posted is not valid syntax - the indentation is off and the keywords must be lowercase, e.g. type: string not Type: String.)
    – Helen
    Nov 20 at 9:18


















  • Do you use swagger: '2.0' or openapi: 3.0.0? Does the array need to be sent in the query string or request body? What is the current curl command, and what curl do you expect to get? Can you also post the complete API definition? (The example you posted is not valid syntax - the indentation is off and the keywords must be lowercase, e.g. type: string not Type: String.)
    – Helen
    Nov 20 at 9:18
















Do you use swagger: '2.0' or openapi: 3.0.0? Does the array need to be sent in the query string or request body? What is the current curl command, and what curl do you expect to get? Can you also post the complete API definition? (The example you posted is not valid syntax - the indentation is off and the keywords must be lowercase, e.g. type: string not Type: String.)
– Helen
Nov 20 at 9:18




Do you use swagger: '2.0' or openapi: 3.0.0? Does the array need to be sent in the query string or request body? What is the current curl command, and what curl do you expect to get? Can you also post the complete API definition? (The example you posted is not valid syntax - the indentation is off and the keywords must be lowercase, e.g. type: string not Type: String.)
– Helen
Nov 20 at 9:18

















active

oldest

votes











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',
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


















StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53384469%2fswagger-array-null-values-swag%23new-answer', 'question_page');
}
);

Post as a guest















Required, but never shown






























active

oldest

votes













active

oldest

votes









active

oldest

votes






active

oldest

votes
















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














StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53384469%2fswagger-array-null-values-swag%23new-answer', 'question_page');
}
);

Post as a guest















Required, but never shown





















































Required, but never shown














Required, but never shown












Required, but never shown







Required, but never shown

































Required, but never shown














Required, but never shown












Required, but never shown







Required, but never shown







Popular posts from this blog

Wiesbaden

Marschland

Dieringhausen