hmLoadTopic({
hmKeywords:"",
hmTitle:"Swagger Publisher",
hmDescription:"Swagger is a set of rules, specifications and tools that help us document our APIs. More information at https:\/\/swagger.io\/",
hmPrevLink:"ws_identity-resources.html",
hmNextLink:"ws_users.html",
hmParentLink:"ws_manager.html",
hmBreadCrumbs:"<a href=\"ws_manager.html\">LinkarWS Manager<\/a>",
hmTitlePath:"LinkarWS Manager > Swagger Publisher",
hmHeader:"<h1 class=\"p_Heading1\" style=\"page-break-after: avoid;\"><span class=\"f_Heading1\">Swagger Publisher<\/span><\/h1>\n\r",
hmBody:"<p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\"><span style=\"font-size: 0.91rem; color: #000000;\">&nbsp;<\/span><\/p>\n\r<p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\">Swagger is a set of rules, specifications and tools that help us document our APIs. More information at <span style=\"color: #0000ff; text-decoration: underline;\"><a href=\"https:\/\/swagger.io\/\" target=\"_blank\" class=\"weblink\">https:\/\/swagger.io\/<\/a><\/span><\/p>\n\r<p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\">LinkarWS generates the Swagger file for documentation and testing purposes. Depending on the Authentication mode used, certain options will be allowed.<\/p>\n\r<p class=\"p_Normal\">&nbsp;<\/p>\n\r<p class=\"p_HeadingHowTo_atoc_\" style=\"page-break-after: avoid;\"><img id=\"TOGGLE0186A1_ICON\" class=\"dropdown-toggle-icon\" style=\"margin:0;width:1.0000rem;height:1.0000rem;border:none\" src=\".\/images\/tog_plus.gif\"\/><span class=\"f_HeadingHowTo_atoc_\" style=\"font-size: 1.00rem; font-family: Arial,Helvetica,sans-serif;\"><a id=\"TOGGLE0186A1_LINK\" class=\"dropdown-toggle\" style=\"font-style: normal; font-weight: normal; color: #000000; letter-spacing: -0.0625rem; background-color: transparent; text-decoration: none;\" href=\"javascript:void(0)\" data-type=\"dropdown\" data-state=\"0\" data-icon=\"TOGGLE0186A1_ICON\" data-src0=\".\/images\/tog_plus.gif\" data-src1=\".\/images\/tog_minus.gif\">None<\/a><\/span><\/p>\n\r<div id=\"TOGGLE0186A1\" class=\"dropdown-toggle-body\" style=\"text-align: left; padding: 0 0 0 0; margin: 0 0 0 2.0000rem;display:none\"><table style=\"border:none; border-spacing:0;\">\n\r<tr>\n\r<td style=\"vertical-align:top; padding:0; border:none\"><div style=\"text-align: center; line-height: 1.28; margin: 0 0 0.6875rem 0;\"><div style=\"margin:0 auto 0 auto;width:80%;max-width:431px;height:auto;\"><img style=\"width:100%;height:auto;border:none\" src=\".\/images\/swagger1.png\"\/><\/div><\/div>\n\r<p style=\"text-align: center; line-height: 1.28; margin: 0 0 0.6875rem 0;\"><span style=\"font-size: 0.91rem; color: #000000;\">&nbsp;<\/span><\/p>\n\r<p style=\"line-height: 1.28; margin: 0 0 0.6875rem 0;\">The API Resource must be specified, and its Linkar EntryPoint must be open. Swagger Publisher accesses the data account to document the dictionaries and Schemas. <span class=\"f_ImageCaption\"> <img style=\"width:80%;max-width:3792px;height:auto;border:none\" src=\".\/images\/blank.png\"\/><\/span><\/p>\n\r<\/td>\n\r<\/tr>\n\r<\/table>\n\r<\/div>\n\r<p class=\"p_Normal\">&nbsp;<\/p>\n\r<p class=\"p_HeadingHowTo_atoc_\" style=\"page-break-after: avoid;\"><img id=\"TOGGLE0186A2_ICON\" class=\"dropdown-toggle-icon\" style=\"margin:0;width:1.0000rem;height:1.0000rem;border:none\" src=\".\/images\/tog_plus.gif\"\/><span class=\"f_HeadingHowTo_atoc_\" style=\"font-size: 1.00rem; font-family: Arial,Helvetica,sans-serif;\"><a id=\"TOGGLE0186A2_LINK\" class=\"dropdown-toggle\" style=\"font-style: normal; font-weight: normal; color: #000000; letter-spacing: -0.0625rem; background-color: transparent; text-decoration: none;\" href=\"javascript:void(0)\" data-type=\"dropdown\" data-state=\"0\" data-icon=\"TOGGLE0186A2_ICON\" data-src0=\".\/images\/tog_plus.gif\" data-src1=\".\/images\/tog_minus.gif\">ApiKey<\/a><\/span><\/p>\n\r<div id=\"TOGGLE0186A2\" class=\"dropdown-toggle-body\" style=\"text-align: left; padding: 0 0 0 0; margin: 0 0 0 2.0000rem;display:none\"><table style=\"border:none; border-spacing:0;\">\n\r<tr>\n\r<td style=\"vertical-align:top; padding:0; border:none\"><div class=\"p_Normal\" style=\"text-align: center;\"><div style=\"margin:0 auto 0 auto;width:80%;max-width:429px;height:auto;\"><img style=\"width:100%;height:auto;border:none\" src=\".\/images\/swagger2.png\"\/><\/div><\/div>\n\r<p class=\"p_Normal\" style=\"text-align: center;\">&nbsp;<\/p>\n\r<p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\">The API Resource must be specified, and its Linkar EntryPoint must be open. Swagger Publisher accesses the data account to document the dictionaries and Schemas. <\/p>\n\r<p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\">If we do not specify an API Key the Swagger file will be generated with all the Scopes defined in the API Resource, and if we choose a specific API Key we will only generate the documentation of the EndPoints allowed for that API Key.<\/p>\n\r<\/td>\n\r<\/tr>\n\r<\/table>\n\r<\/div>\n\r<p class=\"p_Normal\">&nbsp;<\/p>\n\r<p class=\"p_HeadingHowTo_atoc_\" style=\"page-break-after: avoid;\"><img id=\"TOGGLE0186A3_ICON\" class=\"dropdown-toggle-icon\" style=\"margin:0;width:1.0000rem;height:1.0000rem;border:none\" src=\".\/images\/tog_plus.gif\"\/><span class=\"f_HeadingHowTo_atoc_\" style=\"font-size: 1.00rem; font-family: Arial,Helvetica,sans-serif;\"><a id=\"TOGGLE0186A3_LINK\" class=\"dropdown-toggle\" style=\"font-style: normal; font-weight: normal; color: #000000; letter-spacing: -0.0625rem; background-color: transparent; text-decoration: none;\" href=\"javascript:void(0)\" data-type=\"dropdown\" data-state=\"0\" data-icon=\"TOGGLE0186A3_ICON\" data-src0=\".\/images\/tog_plus.gif\" data-src1=\".\/images\/tog_minus.gif\">OAuth2.0<\/a><\/span><\/p>\n\r<div id=\"TOGGLE0186A3\" class=\"dropdown-toggle-body\" style=\"text-align: left; padding: 0 0 0 0; margin: 0 0 0 2.0000rem;display:none\"><table style=\"border:none; border-spacing:0;\">\n\r<tr>\n\r<td style=\"vertical-align:top; padding:0; border:none\"><div class=\"p_Normal\" style=\"text-align: center;\"><div style=\"margin:0 auto 0 auto;width:80%;max-width:413px;height:auto;\"><img style=\"width:100%;height:auto;border:none\" src=\".\/images\/swagger3.png\"\/><\/div><\/div>\n\r<p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\"><span style=\"font-size: 0.91rem; color: #000000;\">&nbsp;<\/span><\/p>\n\r<p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\">API Resource and Identity Resource must be specified and the Linkar EntryPoint must be open. Swagger Publisher accesses the data account to document the dictionaries and Schemas. <\/p>\n\r<\/td>\n\r<\/tr>\n\r<\/table>\n\r<\/div>\n\r<p class=\"p_Normal\">&nbsp;<\/p>\n\r<p class=\"p_HeadingHowTo_atoc_\" style=\"page-break-after: avoid;\"><img id=\"TOGGLE0186A4_ICON\" class=\"dropdown-toggle-icon\" style=\"margin:0;width:1.0000rem;height:1.0000rem;border:none\" src=\".\/images\/tog_plus.gif\"\/><span class=\"f_HeadingHowTo_atoc_\" style=\"font-size: 1.00rem; font-family: Arial,Helvetica,sans-serif;\"><a id=\"TOGGLE0186A4_LINK\" class=\"dropdown-toggle\" style=\"font-style: normal; font-weight: normal; color: #000000; letter-spacing: -0.0625rem; background-color: transparent; text-decoration: none;\" href=\"javascript:void(0)\" data-type=\"dropdown\" data-state=\"0\" data-icon=\"TOGGLE0186A4_ICON\" data-src0=\".\/images\/tog_plus.gif\" data-src1=\".\/images\/tog_minus.gif\">IdentityServer4<\/a><\/span><\/p>\n\r<div id=\"TOGGLE0186A4\" class=\"dropdown-toggle-body\" style=\"text-align: left; padding: 0 0 0 0; margin: 0 0 0 2.0000rem;display:none\"><table style=\"border:none; border-spacing:0;\">\n\r<tr>\n\r<td style=\"vertical-align:top; padding:0; border:none\"><div style=\"text-align: center; line-height: 1.28; margin: 0 0 0.6875rem 0;\"><div style=\"margin:0 auto 0 auto;width:80%;max-width:431px;height:auto;\"><img style=\"width:100%;height:auto;border:none\" src=\".\/images\/swagger1.png\"\/><\/div><\/div>\n\r<p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\"><span style=\"font-size: 0.91rem; color: #000000;\">&nbsp;<\/span><\/p>\n\r<p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\">The API Resource must be specified, and its Linkar EntryPoint must be open. Swagger Publisher accesses the data account to document the dictionaries and Schemas.<\/p>\n\r<\/td>\n\r<\/tr>\n\r<\/table>\n\r<\/div>\n\r<p class=\"p_Normal\">&nbsp;<\/p>\n\r<p class=\"p_HeadingHowTo_atoc_\" style=\"page-break-after: avoid;\"><img style=\"margin:0;width:1.0000rem;height:1.0000rem;border:none\" src=\".\/images\/tog_plus.gif\"\/><span class=\"f_HeadingHowTo_atoc_\" style=\"font-size: 1.00rem; font-family: Arial,Helvetica,sans-serif;\">General options<\/span><\/p>\n\r<div style=\"text-align: left; padding: 0 0 0 0; margin: 0 0 0 2.0000rem;\"><table style=\"border:none; border-spacing:0;\">\n\r<tr>\n\r<td style=\"vertical-align:top; padding:0; border:none\"><p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\">The options below are available for all cases:<\/p>\n\r<div style=\"text-align: center; line-height: 1.28; margin: 0 0 0.6875rem 0;\"><div style=\"margin:0 auto 0 auto;width:80%;max-width:1345px;height:auto;\"><img style=\"width:100%;height:auto;border:none\" src=\".\/images\/swagger4.png\"\/><\/div><\/div>\n\r<p style=\"text-align: center; line-height: 1.28; margin: 0 0 0.6875rem 0;\"><span style=\"font-size: 0.91rem; color: #000000;\">&nbsp;<\/span><\/p>\n\r<div style=\"text-align: left; text-indent: 0; padding: 0 0 0 0; margin: 0 0 0 0;\"><table class=\"argumentos\" >\n\r<tr class=\"argumentos\">\n\r<td class=\"argumentos\" style=\"width:8.6250rem;\"><p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\"><span style=\"font-weight: bold;\">Field<\/span><\/p>\n\r<\/td>\n\r<td class=\"argumentos\" style=\"width:9.4375rem;\"><p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\"><span style=\"font-weight: bold;\">Type<\/span><\/p>\n\r<\/td>\n\r<td class=\"argumentos\" style=\"width:24.0000rem;\"><p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\"><span style=\"font-weight: bold;\">Description<\/span><\/p>\n\r<\/td>\n\r<\/tr>\n\r<tr class=\"argumentos\">\n\r<td class=\"argumentos\" style=\"width:8.6250rem; background-color:#CCFFFF;\"><p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\">Publish Swagger<\/p>\n\r<\/td>\n\r<td class=\"argumentos\" style=\"width:9.4375rem; background-color:#CCFFFF;\"><p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\">Switch<\/p>\n\r<\/td>\n\r<td class=\"argumentos\" style=\"width:24.0000rem; background-color:#CCFFFF;\"><p style=\"line-height: 1.28; margin: 0 0 0.6875rem 0;\">With this option enabled, the generated file will be saved in the wwwroot\/swagger\/docs folder, inside LinkarWS instance root. This way we will be able to access the documentation from the browser using an url with the following format:<\/p>\n\r<p style=\"line-height: 1.28; margin: 0 0 0.6875rem 0;\">http:\/\/localhost:12000\/swagger\/index.html?api_resource=&lt;outputfilename&gt;<\/p>\n\r<\/td>\n\r<\/tr>\n\r<tr class=\"argumentos\">\n\r<td class=\"argumentos\" style=\"width:8.6250rem;\"><p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\">Administrator EndPoints<\/p>\n\r<\/td>\n\r<td class=\"argumentos\" style=\"width:9.4375rem;\"><p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\">Switch<\/p>\n\r<\/td>\n\r<td class=\"argumentos\" style=\"width:24.0000rem;\"><p style=\"line-height: 1.28; margin: 0 0 0.6875rem 0;\">Enable the Administration EndPoints documentation.<\/p>\n\r<\/td>\n\r<\/tr>\n\r<tr class=\"argumentos\">\n\r<td class=\"argumentos\" style=\"width:8.6250rem; background-color:#CCFFFF;\"><p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\">Output path<\/p>\n\r<\/td>\n\r<td class=\"argumentos\" style=\"width:9.4375rem; background-color:#CCFFFF;\"><p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\">Optional<\/p>\n\r<\/td>\n\r<td class=\"argumentos\" style=\"width:24.0000rem; background-color:#CCFFFF;\"><p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\">If Publish Swagger is disabled, here we indicate the output folder.<\/p>\n\r<\/td>\n\r<\/tr>\n\r<tr class=\"argumentos\">\n\r<td class=\"argumentos\" style=\"width:8.6250rem;\"><p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\">Output filename<\/p>\n\r<\/td>\n\r<td class=\"argumentos\" style=\"width:9.4375rem;\"><p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\">Optional<\/p>\n\r<\/td>\n\r<td class=\"argumentos\" style=\"width:24.0000rem;\"><p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\">Name for the generated JSON file.<\/p>\n\r<\/td>\n\r<\/tr>\n\r<\/table>\n\r<\/div>\n\r<p class=\"p_Normal\" style=\"text-align: justify; margin: 0 0 0 1.5000rem;\">&nbsp;<\/p>\n\r<\/td>\n\r<\/tr>\n\r<\/table>\n\r<\/div>\n\r<p class=\"p_Normal\">&nbsp;<\/p>\n\r<p class=\"p_Normal\">&nbsp;<\/p>\n\r"
})
