diff --git a/index.adoc b/index.adoc index 4e806f1..997bb27 100644 --- a/index.adoc +++ b/index.adoc @@ -3,11 +3,11 @@ opensource@aservo.com 1 :toc: left :numbered: -:toclevels: 3 +:toclevels: 4 :source-highlighter: highlightjs -:keywords: openapi, rest, ConfAPI for Jira -:specDir: src/main/resources/doc/ -:snippetDir: +:keywords: openapi, rest, ConfAPI for Jira +:specDir: src/main/resources/openapi/specs/ +:snippetDir: src/main/resources/openapi/snippets/ :generator-template: v1 2019-12-20 :info-url: https://github.com/aservo/confapi-jira-plugin :app-name: ConfAPI for Jira @@ -28,6 +28,7 @@ This plugin provides methods for accessing configuration for Jira. + == Endpoints @@ -37,12 +38,12 @@ This plugin provides methods for accessing configuration for Jira. [.addApplicationLink] ==== addApplicationLink - + `POST /application-links` Add an application link -===== Description +===== Description @@ -54,35 +55,35 @@ Add an application link ===== Parameters -===== Body Parameter +====== Body Parameter [cols="2,3,1,1,1"] -|=== +|=== |Name| Description| Required| Default| Pattern -| ApplicationLinkBean -| <> -| X -| -| +| ApplicationLinkBean +| <> +| X +| +| -|=== +|=== ====== Query Parameters [cols="2,3,1,1,1"] -|=== +|=== |Name| Description| Required| Default| Pattern -| ignore-setup-errors -| -| - -| false +| ignore-setup-errors | +| - +| false +| -|=== +|=== ===== Return Type @@ -96,10 +97,10 @@ Add an application link ===== Responses -.http response codes +.HTTP Response Codes [cols="2,3,1"] -|=== -| Code | Message | Datatype +|=== +| Code | Message | Datatype | 200 @@ -111,7 +112,7 @@ Add an application link | Returns a list of error messages. | <> -|=== +|=== ===== Samples @@ -137,12 +138,12 @@ endif::internal-generation[] [.deleteApplicationLink] ==== deleteApplicationLink - + `DELETE /application-links/{uuid}` Delete an application link -===== Description +===== Description @@ -156,16 +157,16 @@ Delete an application link ====== Path Parameters [cols="2,3,1,1,1"] -|=== +|=== |Name| Description| Required| Default| Pattern -| uuid -| -| X -| null +| uuid | +| X +| null +| -|=== +|=== @@ -184,10 +185,10 @@ Delete an application link ===== Responses -.http response codes +.HTTP Response Codes [cols="2,3,1"] -|=== -| Code | Message | Datatype +|=== +| Code | Message | Datatype | 200 @@ -199,7 +200,7 @@ Delete an application link | Returns a list of error messages. | <> -|=== +|=== ===== Samples @@ -225,12 +226,12 @@ endif::internal-generation[] [.deleteApplicationLinks] ==== deleteApplicationLinks - + `DELETE /application-links` Delete all application links -===== Description +===== Description NOTE: The 'force' parameter must be set to 'true' in order to execute this request. @@ -248,16 +249,16 @@ NOTE: The 'force' parameter must be set to 'true' in order to execute this reque ====== Query Parameters [cols="2,3,1,1,1"] -|=== +|=== |Name| Description| Required| Default| Pattern -| force -| -| - -| null +| force | +| - +| null +| -|=== +|=== ===== Return Type @@ -272,10 +273,10 @@ NOTE: The 'force' parameter must be set to 'true' in order to execute this reque ===== Responses -.http response codes +.HTTP Response Codes [cols="2,3,1"] -|=== -| Code | Message | Datatype +|=== +| Code | Message | Datatype | 200 @@ -287,7 +288,7 @@ NOTE: The 'force' parameter must be set to 'true' in order to execute this reque | Returns a list of error messages. | <> -|=== +|=== ===== Samples @@ -313,12 +314,12 @@ endif::internal-generation[] [.getApplicationLink] ==== getApplicationLink - + `GET /application-links/{uuid}` Get an application link -===== Description +===== Description Upon successful request, @@ -332,16 +333,16 @@ Upon successful request, ====== Path Parameters [cols="2,3,1,1,1"] -|=== +|=== |Name| Description| Required| Default| Pattern -| uuid -| -| X -| null +| uuid | +| X +| null +| -|=== +|=== @@ -359,10 +360,10 @@ Upon successful request, ===== Responses -.http response codes +.HTTP Response Codes [cols="2,3,1"] -|=== -| Code | Message | Datatype +|=== +| Code | Message | Datatype | 200 @@ -374,7 +375,7 @@ Upon successful request, | Returns a list of error messages. | <> -|=== +|=== ===== Samples @@ -400,12 +401,12 @@ endif::internal-generation[] [.getApplicationLinks] ==== getApplicationLinks - + `GET /application-links` Get all application links -===== Description +===== Description @@ -433,10 +434,10 @@ Get all application links ===== Responses -.http response codes +.HTTP Response Codes [cols="2,3,1"] -|=== -| Code | Message | Datatype +|=== +| Code | Message | Datatype | 200 @@ -448,7 +449,7 @@ Get all application links | Returns a list of error messages. | <> -|=== +|=== ===== Samples @@ -474,12 +475,12 @@ endif::internal-generation[] [.setApplicationLink] ==== setApplicationLink - + `PUT /application-links/{uuid}` Update an application link -===== Description +===== Description @@ -493,46 +494,46 @@ Update an application link ====== Path Parameters [cols="2,3,1,1,1"] -|=== +|=== |Name| Description| Required| Default| Pattern -| uuid -| -| X -| null +| uuid | +| X +| null +| -|=== +|=== -===== Body Parameter +====== Body Parameter [cols="2,3,1,1,1"] -|=== +|=== |Name| Description| Required| Default| Pattern -| ApplicationLinkBean -| <> -| X -| -| +| ApplicationLinkBean +| <> +| X +| +| -|=== +|=== ====== Query Parameters [cols="2,3,1,1,1"] -|=== +|=== |Name| Description| Required| Default| Pattern -| ignore-setup-errors -| -| - -| false +| ignore-setup-errors | +| - +| false +| -|=== +|=== ===== Return Type @@ -546,10 +547,10 @@ Update an application link ===== Responses -.http response codes +.HTTP Response Codes [cols="2,3,1"] -|=== -| Code | Message | Datatype +|=== +| Code | Message | Datatype | 200 @@ -561,7 +562,7 @@ Update an application link | Returns a list of error messages. | <> -|=== +|=== ===== Samples @@ -587,12 +588,12 @@ endif::internal-generation[] [.setApplicationLinks] ==== setApplicationLinks - + `PUT /application-links` Set or update a list of application links -===== Description +===== Description NOTE: All existing application links with the same 'rpcUrl' attribute are updated. @@ -604,35 +605,35 @@ NOTE: All existing application links with the same 'rpcUrl' attribute are update ===== Parameters -===== Body Parameter +====== Body Parameter [cols="2,3,1,1,1"] -|=== +|=== |Name| Description| Required| Default| Pattern -| ApplicationLinksBean -| <> -| X -| -| +| ApplicationLinksBean +| <> +| X +| +| -|=== +|=== ====== Query Parameters [cols="2,3,1,1,1"] -|=== +|=== |Name| Description| Required| Default| Pattern -| ignore-setup-errors -| -| - -| false +| ignore-setup-errors | +| - +| false +| -|=== +|=== ===== Return Type @@ -646,10 +647,10 @@ NOTE: All existing application links with the same 'rpcUrl' attribute are update ===== Responses -.http response codes +.HTTP Response Codes [cols="2,3,1"] -|=== -| Code | Message | Datatype +|=== +| Code | Message | Datatype | 200 @@ -661,7 +662,7 @@ NOTE: All existing application links with the same 'rpcUrl' attribute are update | Returns a list of error messages. | <> -|=== +|=== ===== Samples @@ -691,12 +692,12 @@ endif::internal-generation[] [.addDirectory] ==== addDirectory - + `POST /directories` Add a user directory -===== Description +===== Description @@ -708,35 +709,35 @@ Add a user directory ===== Parameters -===== Body Parameter +====== Body Parameter [cols="2,3,1,1,1"] -|=== +|=== |Name| Description| Required| Default| Pattern -| AbstractDirectoryBean -| <> -| X -| -| +| AbstractDirectoryBean +| <> +| X +| +| -|=== +|=== ====== Query Parameters [cols="2,3,1,1,1"] -|=== +|=== |Name| Description| Required| Default| Pattern -| test-connection -| -| - -| false +| test-connection | +| - +| false +| -|=== +|=== ===== Return Type @@ -750,10 +751,10 @@ Add a user directory ===== Responses -.http response codes +.HTTP Response Codes [cols="2,3,1"] -|=== -| Code | Message | Datatype +|=== +| Code | Message | Datatype | 200 @@ -765,7 +766,7 @@ Add a user directory | Returns a list of error messages. | <> -|=== +|=== ===== Samples @@ -791,12 +792,12 @@ endif::internal-generation[] [.deleteDirectories] ==== deleteDirectories - + `DELETE /directories` Delete all user directories -===== Description +===== Description NOTE: The 'force' parameter must be set to 'true' in order to execute this request. @@ -814,16 +815,16 @@ NOTE: The 'force' parameter must be set to 'true' in order to execute this reque ====== Query Parameters [cols="2,3,1,1,1"] -|=== +|=== |Name| Description| Required| Default| Pattern -| force -| -| - -| null +| force | +| - +| null +| -|=== +|=== ===== Return Type @@ -838,10 +839,10 @@ NOTE: The 'force' parameter must be set to 'true' in order to execute this reque ===== Responses -.http response codes +.HTTP Response Codes [cols="2,3,1"] -|=== -| Code | Message | Datatype +|=== +| Code | Message | Datatype | 200 @@ -853,7 +854,7 @@ NOTE: The 'force' parameter must be set to 'true' in order to execute this reque | Returns a list of error messages. | <> -|=== +|=== ===== Samples @@ -879,12 +880,12 @@ endif::internal-generation[] [.deleteDirectory] ==== deleteDirectory - + `DELETE /directories/{id}` Delete a user directory -===== Description +===== Description @@ -898,16 +899,16 @@ Delete a user directory ====== Path Parameters [cols="2,3,1,1,1"] -|=== +|=== |Name| Description| Required| Default| Pattern -| id -| -| X -| null +| id | +| X +| null +| -|=== +|=== @@ -926,10 +927,10 @@ Delete a user directory ===== Responses -.http response codes +.HTTP Response Codes [cols="2,3,1"] -|=== -| Code | Message | Datatype +|=== +| Code | Message | Datatype | 200 @@ -941,7 +942,7 @@ Delete a user directory | Returns a list of error messages. | <> -|=== +|=== ===== Samples @@ -967,12 +968,12 @@ endif::internal-generation[] [.getDirectories] ==== getDirectories - + `GET /directories` Get all user directories -===== Description +===== Description @@ -1000,10 +1001,10 @@ Get all user directories ===== Responses -.http response codes +.HTTP Response Codes [cols="2,3,1"] -|=== -| Code | Message | Datatype +|=== +| Code | Message | Datatype | 200 @@ -1015,7 +1016,7 @@ Get all user directories | Returns a list of error messages. | <> -|=== +|=== ===== Samples @@ -1041,12 +1042,12 @@ endif::internal-generation[] [.getDirectory] ==== getDirectory - + `GET /directories/{id}` Get a user directory -===== Description +===== Description @@ -1060,16 +1061,16 @@ Get a user directory ====== Path Parameters [cols="2,3,1,1,1"] -|=== +|=== |Name| Description| Required| Default| Pattern -| id -| -| X -| null +| id | +| X +| null +| -|=== +|=== @@ -1087,10 +1088,10 @@ Get a user directory ===== Responses -.http response codes +.HTTP Response Codes [cols="2,3,1"] -|=== -| Code | Message | Datatype +|=== +| Code | Message | Datatype | 200 @@ -1102,7 +1103,7 @@ Get a user directory | Returns a list of error messages. | <> -|=== +|=== ===== Samples @@ -1128,12 +1129,12 @@ endif::internal-generation[] [.setDirectories] ==== setDirectories - + `PUT /directories` Set or update a list of user directories -===== Description +===== Description NOTE: All existing directories with the same 'name' attribute are updated. @@ -1145,35 +1146,35 @@ NOTE: All existing directories with the same 'name' attribute are updated. ===== Parameters -===== Body Parameter +====== Body Parameter [cols="2,3,1,1,1"] -|=== +|=== |Name| Description| Required| Default| Pattern -| DirectoriesBean -| <> -| X -| -| +| DirectoriesBean +| <> +| X +| +| -|=== +|=== ====== Query Parameters [cols="2,3,1,1,1"] -|=== +|=== |Name| Description| Required| Default| Pattern -| test-connection -| -| - -| false +| test-connection | +| - +| false +| -|=== +|=== ===== Return Type @@ -1187,10 +1188,10 @@ NOTE: All existing directories with the same 'name' attribute are updated. ===== Responses -.http response codes +.HTTP Response Codes [cols="2,3,1"] -|=== -| Code | Message | Datatype +|=== +| Code | Message | Datatype | 200 @@ -1202,7 +1203,7 @@ NOTE: All existing directories with the same 'name' attribute are updated. | Returns a list of error messages. | <> -|=== +|=== ===== Samples @@ -1228,12 +1229,12 @@ endif::internal-generation[] [.setDirectory] ==== setDirectory - + `PUT /directories/{id}` Update a user directory -===== Description +===== Description @@ -1247,46 +1248,46 @@ Update a user directory ====== Path Parameters [cols="2,3,1,1,1"] -|=== +|=== |Name| Description| Required| Default| Pattern -| id -| -| X -| null +| id | +| X +| null +| -|=== +|=== -===== Body Parameter +====== Body Parameter [cols="2,3,1,1,1"] -|=== +|=== |Name| Description| Required| Default| Pattern -| AbstractDirectoryBean -| <> -| X -| -| +| AbstractDirectoryBean +| <> +| X +| +| -|=== +|=== ====== Query Parameters [cols="2,3,1,1,1"] -|=== +|=== |Name| Description| Required| Default| Pattern -| test-connection -| -| - -| false +| test-connection | +| - +| false +| -|=== +|=== ===== Return Type @@ -1300,10 +1301,10 @@ Update a user directory ===== Responses -.http response codes +.HTTP Response Codes [cols="2,3,1"] -|=== -| Code | Message | Datatype +|=== +| Code | Message | Datatype | 200 @@ -1315,7 +1316,7 @@ Update a user directory | Returns a list of error messages. | <> -|=== +|=== ===== Samples @@ -1345,12 +1346,12 @@ endif::internal-generation[] [.addLicense] ==== addLicense - + `POST /licenses` Add a license -===== Description +===== Description @@ -1362,19 +1363,19 @@ Add a license ===== Parameters -===== Body Parameter +====== Body Parameter [cols="2,3,1,1,1"] -|=== +|=== |Name| Description| Required| Default| Pattern -| LicenseBean -| <> -| X -| -| +| LicenseBean +| <> +| X +| +| -|=== +|=== @@ -1391,10 +1392,10 @@ Add a license ===== Responses -.http response codes +.HTTP Response Codes [cols="2,3,1"] -|=== -| Code | Message | Datatype +|=== +| Code | Message | Datatype | 200 @@ -1406,7 +1407,7 @@ Add a license | Returns a list of error messages. | <> -|=== +|=== ===== Samples @@ -1432,12 +1433,12 @@ endif::internal-generation[] [.getLicenses] ==== getLicenses - + `GET /licenses` Get all licenses information -===== Description +===== Description Upon successful request, returns a `LicensesBean` object containing license details. Be aware that `products` collection of the `LicenseBean` contains the product display names, not the product key names @@ -1465,10 +1466,10 @@ Upon successful request, returns a `LicensesBean` object containing license deta ===== Responses -.http response codes +.HTTP Response Codes [cols="2,3,1"] -|=== -| Code | Message | Datatype +|=== +| Code | Message | Datatype | 200 @@ -1480,7 +1481,7 @@ Upon successful request, returns a `LicensesBean` object containing license deta | Returns a list of error messages. | <> -|=== +|=== ===== Samples @@ -1510,12 +1511,12 @@ endif::internal-generation[] [.getMailServerPop] ==== getMailServerPop - + `GET /mail-server/pop` Get the default POP mail server -===== Description +===== Description @@ -1543,10 +1544,10 @@ Get the default POP mail server ===== Responses -.http response codes +.HTTP Response Codes [cols="2,3,1"] -|=== -| Code | Message | Datatype +|=== +| Code | Message | Datatype | 200 @@ -1563,7 +1564,7 @@ Get the default POP mail server | Returns a list of error messages. | <> -|=== +|=== ===== Samples @@ -1589,12 +1590,12 @@ endif::internal-generation[] [.getMailServerSmtp] ==== getMailServerSmtp - + `GET /mail-server/smtp` Get the default SMTP mail server -===== Description +===== Description @@ -1622,10 +1623,10 @@ Get the default SMTP mail server ===== Responses -.http response codes +.HTTP Response Codes [cols="2,3,1"] -|=== -| Code | Message | Datatype +|=== +| Code | Message | Datatype | 200 @@ -1642,7 +1643,7 @@ Get the default SMTP mail server | Returns a list of error messages. | <> -|=== +|=== ===== Samples @@ -1668,12 +1669,12 @@ endif::internal-generation[] [.setMailServerPop] ==== setMailServerPop - + `PUT /mail-server/pop` Set the default POP mail server -===== Description +===== Description @@ -1685,19 +1686,19 @@ Set the default POP mail server ===== Parameters -===== Body Parameter +====== Body Parameter [cols="2,3,1,1,1"] -|=== +|=== |Name| Description| Required| Default| Pattern -| MailServerPopBean -| <> -| X -| -| +| MailServerPopBean +| <> +| X +| +| -|=== +|=== @@ -1714,10 +1715,10 @@ Set the default POP mail server ===== Responses -.http response codes +.HTTP Response Codes [cols="2,3,1"] -|=== -| Code | Message | Datatype +|=== +| Code | Message | Datatype | 200 @@ -1729,7 +1730,7 @@ Set the default POP mail server | Returns a list of error messages. | <> -|=== +|=== ===== Samples @@ -1755,12 +1756,12 @@ endif::internal-generation[] [.setMailServerSmtp] ==== setMailServerSmtp - + `PUT /mail-server/smtp` Set the default SMTP mail server -===== Description +===== Description @@ -1772,19 +1773,19 @@ Set the default SMTP mail server ===== Parameters -===== Body Parameter +====== Body Parameter [cols="2,3,1,1,1"] -|=== +|=== |Name| Description| Required| Default| Pattern -| MailServerSmtpBean -| <> -| X -| -| +| MailServerSmtpBean +| <> +| X +| +| -|=== +|=== @@ -1801,10 +1802,10 @@ Set the default SMTP mail server ===== Responses -.http response codes +.HTTP Response Codes [cols="2,3,1"] -|=== -| Code | Message | Datatype +|=== +| Code | Message | Datatype | 200 @@ -1816,7 +1817,7 @@ Set the default SMTP mail server | Returns a list of error messages. | <> -|=== +|=== ===== Samples @@ -1846,12 +1847,12 @@ endif::internal-generation[] [.getPing] ==== getPing - + `GET /ping` Ping method for probing the REST API. -===== Description +===== Description @@ -1877,17 +1878,17 @@ Ping method for probing the REST API. ===== Responses -.http response codes +.HTTP Response Codes [cols="2,3,1"] -|=== -| Code | Message | Datatype +|=== +| Code | Message | Datatype | 200 | Returns 'pong' | <<>> -|=== +|=== ===== Samples @@ -1917,12 +1918,12 @@ endif::internal-generation[] [.getBrandingColorScheme] ==== getBrandingColorScheme - + `GET /settings/branding/color-scheme` Get the color scheme -===== Description +===== Description @@ -1950,10 +1951,10 @@ Get the color scheme ===== Responses -.http response codes +.HTTP Response Codes [cols="2,3,1"] -|=== -| Code | Message | Datatype +|=== +| Code | Message | Datatype | 200 @@ -1965,7 +1966,7 @@ Get the color scheme | Returns a list of error messages. | <> -|=== +|=== ===== Samples @@ -1991,12 +1992,12 @@ endif::internal-generation[] [.getBrandingFavicon] ==== getBrandingFavicon - + `GET /settings/branding/favicon` Get the favicon -===== Description +===== Description @@ -2025,10 +2026,10 @@ Get the favicon ===== Responses -.http response codes +.HTTP Response Codes [cols="2,3,1"] -|=== -| Code | Message | Datatype +|=== +| Code | Message | Datatype | 200 @@ -2040,7 +2041,7 @@ Get the favicon | Returns a list of error messages. | <> -|=== +|=== ===== Samples @@ -2066,12 +2067,12 @@ endif::internal-generation[] [.getBrandingLogo] ==== getBrandingLogo - + `GET /settings/branding/logo` Get the logo -===== Description +===== Description @@ -2100,10 +2101,10 @@ Get the logo ===== Responses -.http response codes +.HTTP Response Codes [cols="2,3,1"] -|=== -| Code | Message | Datatype +|=== +| Code | Message | Datatype | 200 @@ -2115,7 +2116,7 @@ Get the logo | Returns a list of error messages. | <> -|=== +|=== ===== Samples @@ -2141,12 +2142,12 @@ endif::internal-generation[] [.getSettings] ==== getSettings - + `GET /settings` Get the application settings -===== Description +===== Description @@ -2174,10 +2175,10 @@ Get the application settings ===== Responses -.http response codes +.HTTP Response Codes [cols="2,3,1"] -|=== -| Code | Message | Datatype +|=== +| Code | Message | Datatype | 200 @@ -2189,7 +2190,7 @@ Get the application settings | Returns a list of error messages. | <> -|=== +|=== ===== Samples @@ -2215,12 +2216,12 @@ endif::internal-generation[] [.setBrandingColorScheme] ==== setBrandingColorScheme - + `PUT /settings/branding/color-scheme` Set the color scheme -===== Description +===== Description @@ -2232,19 +2233,19 @@ Set the color scheme ===== Parameters -===== Body Parameter +====== Body Parameter [cols="2,3,1,1,1"] -|=== +|=== |Name| Description| Required| Default| Pattern -| SettingsBrandingColorSchemeBean -| <> -| X -| -| +| SettingsBrandingColorSchemeBean +| <> +| X +| +| -|=== +|=== @@ -2261,10 +2262,10 @@ Set the color scheme ===== Responses -.http response codes +.HTTP Response Codes [cols="2,3,1"] -|=== -| Code | Message | Datatype +|=== +| Code | Message | Datatype | 200 @@ -2276,7 +2277,7 @@ Set the color scheme | Returns a list of error messages. | <> -|=== +|=== ===== Samples @@ -2302,12 +2303,12 @@ endif::internal-generation[] [.setBrandingFavicon] ==== setBrandingFavicon - + `PUT /settings/branding/favicon` Set the favicon -===== Description +===== Description @@ -2319,19 +2320,19 @@ Set the favicon ===== Parameters -===== Body Parameter +====== Body Parameter [cols="2,3,1,1,1"] -|=== +|=== |Name| Description| Required| Default| Pattern -| body -| <> -| X -| -| +| body +| <> +| X +| +| -|=== +|=== @@ -2349,10 +2350,10 @@ Set the favicon ===== Responses -.http response codes +.HTTP Response Codes [cols="2,3,1"] -|=== -| Code | Message | Datatype +|=== +| Code | Message | Datatype | 200 @@ -2364,7 +2365,7 @@ Set the favicon | Returns a list of error messages. | <> -|=== +|=== ===== Samples @@ -2390,12 +2391,12 @@ endif::internal-generation[] [.setBrandingLogo] ==== setBrandingLogo - + `PUT /settings/branding/logo` Set the logo -===== Description +===== Description @@ -2407,19 +2408,19 @@ Set the logo ===== Parameters -===== Body Parameter +====== Body Parameter [cols="2,3,1,1,1"] -|=== +|=== |Name| Description| Required| Default| Pattern -| body -| <> -| X -| -| +| body +| <> +| X +| +| -|=== +|=== @@ -2437,10 +2438,10 @@ Set the logo ===== Responses -.http response codes +.HTTP Response Codes [cols="2,3,1"] -|=== -| Code | Message | Datatype +|=== +| Code | Message | Datatype | 200 @@ -2452,7 +2453,7 @@ Set the logo | Returns a list of error messages. | <> -|=== +|=== ===== Samples @@ -2478,12 +2479,12 @@ endif::internal-generation[] [.setSettings] ==== setSettings - + `PUT /settings` Set the application settings -===== Description +===== Description @@ -2495,19 +2496,19 @@ Set the application settings ===== Parameters -===== Body Parameter +====== Body Parameter [cols="2,3,1,1,1"] -|=== +|=== |Name| Description| Required| Default| Pattern -| SettingsBean -| <> -| X -| -| +| SettingsBean +| <> +| X +| +| -|=== +|=== @@ -2524,10 +2525,10 @@ Set the application settings ===== Responses -.http response codes +.HTTP Response Codes [cols="2,3,1"] -|=== -| Code | Message | Datatype +|=== +| Code | Message | Datatype | 200 @@ -2539,7 +2540,7 @@ Set the application settings | Returns a list of error messages. | <> -|=== +|=== ===== Samples @@ -2574,42 +2575,42 @@ endif::internal-generation[] [.fields-AbstractDirectoryBean] [cols="2,1,2,4,1"] -|=== +|=== | Field Name| Required| Type| Description| Format -| id -| -| Long +| id +| +| Long | | int64 -| name -| X -| String +| name +| X +| String | | -| description -| -| String +| description +| +| String | | -| active -| -| Boolean +| active +| +| Boolean | | -| createdDate -| -| Date +| createdDate +| +| Date | | date-time -| updatedDate -| -| Date +| updatedDate +| +| Date | | date-time @@ -2623,60 +2624,60 @@ endif::internal-generation[] [.fields-ApplicationLinkBean] [cols="2,1,2,4,1"] -|=== +|=== | Field Name| Required| Type| Description| Format -| uuid -| -| UUID +| uuid +| +| UUID | | uuid -| name -| X -| String +| name +| X +| String | | -| type -| X -| String +| type +| X +| String | | _Enum:_ BAMBOO, JIRA, BITBUCKET, CONFLUENCE, FISHEYE, CROWD, -| displayUrl -| X -| URI +| displayUrl +| X +| URI | | uri -| rpcUrl -| X -| URI +| rpcUrl +| X +| URI | | uri -| primary -| -| Boolean +| primary +| +| Boolean | | -| status -| -| String +| status +| +| String | | _Enum:_ AVAILABLE, UNAVAILABLE, CONFIGURATION_ERROR, -| username -| -| String +| username +| +| String | | -| password -| -| String +| password +| +| String | | @@ -2690,12 +2691,12 @@ endif::internal-generation[] [.fields-ApplicationLinksBean] [cols="2,1,2,4,1"] -|=== +|=== | Field Name| Required| Type| Description| Format -| applicationLinks -| -| List of <> +| applicationLinks +| +| List of <> | | @@ -2709,12 +2710,12 @@ endif::internal-generation[] [.fields-DirectoriesBean] [cols="2,1,2,4,1"] -|=== +|=== | Field Name| Required| Type| Description| Format -| directories -| -| List of <> +| directories +| +| List of <> | | @@ -2728,30 +2729,30 @@ endif::internal-generation[] [.fields-DirectoryCrowdAdvanced] [cols="2,1,2,4,1"] -|=== +|=== | Field Name| Required| Type| Description| Format -| enableNestedGroups -| -| Boolean +| enableNestedGroups +| +| Boolean | | -| enableIncrementalSync -| -| Boolean +| enableIncrementalSync +| +| Boolean | | -| updateGroupMembershipMethod -| -| String +| updateGroupMembershipMethod +| +| String | | -| updateSyncIntervalInMinutes -| -| Integer +| updateSyncIntervalInMinutes +| +| Integer | | int32 @@ -2765,60 +2766,60 @@ endif::internal-generation[] [.fields-DirectoryCrowdBean] [cols="2,1,2,4,1"] -|=== +|=== | Field Name| Required| Type| Description| Format -| id -| -| Long +| id +| +| Long | | int64 -| name -| X -| String +| name +| X +| String | | -| description -| -| String +| description +| +| String | | -| active -| -| Boolean +| active +| +| Boolean | | -| createdDate -| -| Date +| createdDate +| +| Date | | date-time -| updatedDate -| -| Date +| updatedDate +| +| Date | | date-time -| server -| -| DirectoryCrowdServer +| server +| +| DirectoryCrowdServer | | -| permissions -| -| DirectoryCrowdPermissions +| permissions +| +| DirectoryCrowdPermissions | | -| advanced -| -| DirectoryCrowdAdvanced +| advanced +| +| DirectoryCrowdAdvanced | | @@ -2832,18 +2833,18 @@ endif::internal-generation[] [.fields-DirectoryCrowdPermissions] [cols="2,1,2,4,1"] -|=== +|=== | Field Name| Required| Type| Description| Format -| readOnly -| -| Boolean +| readOnly +| +| Boolean | | -| fullAccess -| -| Boolean +| fullAccess +| +| Boolean | | @@ -2857,42 +2858,42 @@ endif::internal-generation[] [.fields-DirectoryCrowdServer] [cols="2,1,2,4,1"] -|=== +|=== | Field Name| Required| Type| Description| Format -| url -| X -| URI +| url +| X +| URI | | uri -| proxy -| -| DirectoryCrowdServerProxy +| proxy +| +| DirectoryCrowdServerProxy | | -| appUsername -| X -| String +| appUsername +| X +| String | | -| appPassword -| X -| String +| appPassword +| X +| String | | -| connectionTimeoutInMillis -| -| Long +| connectionTimeoutInMillis +| +| Long | | int64 -| maxConnections -| -| Integer +| maxConnections +| +| Integer | | int32 @@ -2906,281 +2907,529 @@ endif::internal-generation[] [.fields-DirectoryCrowdServerProxy] [cols="2,1,2,4,1"] -|=== +|=== | Field Name| Required| Type| Description| Format -| host -| -| String +| host +| +| String | | -| port -| -| Integer +| port +| +| Integer | | int32 -| username -| -| String +| username +| +| String | | -| password -| -| String +| password +| +| String | | |=== -[#DirectoryGenericBean] -=== _DirectoryGenericBean_ +[#DirectoryDelegatingBean] +=== _DirectoryDelegatingBean_ -[.fields-DirectoryGenericBean] +[.fields-DirectoryDelegatingBean] [cols="2,1,2,4,1"] -|=== +|=== | Field Name| Required| Type| Description| Format -| id -| -| Long +| id +| +| Long | | int64 -| name -| X -| String +| name +| X +| String | | -| description -| -| String +| description +| +| String | | -| active -| -| Boolean +| active +| +| Boolean | | -| createdDate -| -| Date +| createdDate +| +| Date | | date-time -| updatedDate -| -| Date +| updatedDate +| +| Date | | date-time -|=== - - -[#DirectoryInternalAdvanced] -=== _DirectoryInternalAdvanced_ - - - -[.fields-DirectoryInternalAdvanced] -[cols="2,1,2,4,1"] -|=== -| Field Name| Required| Type| Description| Format +| connector +| +| DirectoryDelegatingConnector +| +| -| enableNestedGroups +| configuration +| +| DirectoryDelegatingConfiguration +| | -| Boolean + +| permissions +| +| DirectoryPermissions | | |=== -[#DirectoryInternalBean] -=== _DirectoryInternalBean_ +[#DirectoryDelegatingConfiguration] +=== _DirectoryDelegatingConfiguration_ -[.fields-DirectoryInternalBean] +[.fields-DirectoryDelegatingConfiguration] [cols="2,1,2,4,1"] -|=== +|=== | Field Name| Required| Type| Description| Format -| id +| userDn +| +| String +| | -| Long + +| userObjectClass | -| int64 +| String +| +| -| name -| X -| String +| userObjectFilter +| +| String | | -| description +| userNameAttribute +| +| String +| | -| String + +| userNameRdnAttribute +| +| String | | -| active +| userFirstNameAttribute +| +| String +| | -| Boolean + +| userLastNameAttribute +| +| String | | -| createdDate +| userDisplayNameAttribute +| +| String +| | -| Date + +| userEmailAttribute | -| date-time +| String +| +| -| updatedDate +| userGroupAttribute +| +| String +| | -| Date + +| userUniqueIdAttribute | -| date-time +| String +| +| -| credentialPolicy +| groupDn +| +| String +| | -| DirectoryInternalCredentialPolicy + +| groupObjectClass +| +| String | | -| advanced +| groupObjectFilter +| +| String +| | -| DirectoryInternalAdvanced + +| groupNameAttribute +| +| String | | -| permissions +| groupDescriptionAttribute +| +| String +| | -| DirectoryInternalPermissions + +| groupMembersAttribute +| +| String | | |=== -[#DirectoryInternalCredentialPolicy] -=== _DirectoryInternalCredentialPolicy_ +[#DirectoryDelegatingConnector] +=== _DirectoryDelegatingConnector_ -[.fields-DirectoryInternalCredentialPolicy] +[.fields-DirectoryDelegatingConnector] [cols="2,1,2,4,1"] -|=== +|=== | Field Name| Required| Type| Description| Format -| passwordRegex +| type +| +| String +| +| _Enum:_ MICROSOFT_ACTIVE_DIRECTORY, + +| url +| +| String +| +| + +| ssl +| +| String +| +| _Enum:_ NONE, LDAPS, START_TLS, + +| useNodeReferrals +| +| Boolean +| | -| String + +| nestedGroupsDisabled +| +| Boolean | | -| passwordComplexityMessage +| synchronizeUsers +| +| Boolean +| | -| String + +| synchronizeUserDetails +| +| Boolean | | -| passwordMaxAttempts +| synchronizeGroupMemberships +| +| Boolean +| | -| Long + +| useUserMembershipAttribute | -| int64 +| Boolean +| +| -| passwordHistoryCount +| usePagedResults +| +| Boolean +| | -| Long + +| pagedResultsSize +| +| Long | | int64 -| passwordMaxChangeTime -| -| Long +| readTimeoutInMillis +| +| Long | | int64 -| passwordExpiryNotificationDays -| -| List of <> +| searchTimeoutInMillis | -| int32 +| Long +| +| int64 + +| connectionTimeoutInMillis +| +| Long +| +| int64 -| passwordEncryptionMethod +| baseDn +| +| String +| +| + +| username +| +| String +| | -| String + +| password +| +| String | | |=== -[#DirectoryInternalPermissions] -=== _DirectoryInternalPermissions_ +[#DirectoryGenericBean] +=== _DirectoryGenericBean_ -[.fields-DirectoryInternalPermissions] +[.fields-DirectoryGenericBean] [cols="2,1,2,4,1"] -|=== +|=== | Field Name| Required| Type| Description| Format -| addGroup -| -| Boolean +| id +| +| Long +| +| int64 + +| name +| X +| String | | -| addUser +| description +| +| String +| | -| Boolean + +| active +| +| Boolean | | -| modifyGroup +| createdDate +| +| Date +| +| date-time + +| updatedDate +| +| Date +| +| date-time + +|=== + + +[#DirectoryInternalAdvanced] +=== _DirectoryInternalAdvanced_ + + + +[.fields-DirectoryInternalAdvanced] +[cols="2,1,2,4,1"] +|=== +| Field Name| Required| Type| Description| Format + +| enableNestedGroups +| +| Boolean +| | -| Boolean + +|=== + + +[#DirectoryInternalBean] +=== _DirectoryInternalBean_ + + + +[.fields-DirectoryInternalBean] +[cols="2,1,2,4,1"] +|=== +| Field Name| Required| Type| Description| Format + +| id +| +| Long +| +| int64 + +| name +| X +| String | | -| modifyUser +| description +| +| String +| | -| Boolean + +| active +| +| Boolean | | -| modifyGroupAttributes +| createdDate +| +| Date +| +| date-time + +| updatedDate +| +| Date +| +| date-time + +| credentialPolicy +| +| DirectoryInternalCredentialPolicy +| | -| Boolean + +| advanced +| +| DirectoryInternalAdvanced | | -| modifyUserAttributes +| permissions +| +| DirectoryPermissions +| | -| Boolean + +| groups +| +| List of <> | | -| removeGroup +| users +| +| List of <> +| | -| Boolean + +|=== + + +[#DirectoryInternalCredentialPolicy] +=== _DirectoryInternalCredentialPolicy_ + + + +[.fields-DirectoryInternalCredentialPolicy] +[cols="2,1,2,4,1"] +|=== +| Field Name| Required| Type| Description| Format + +| passwordRegex +| +| String | | -| removeUser +| passwordComplexityMessage +| +| String +| | -| Boolean + +| passwordMaxAttempts +| +| Long +| +| int64 + +| passwordHistoryCount +| +| Long +| +| int64 + +| passwordMaxChangeTime +| +| Long +| +| int64 + +| passwordExpiryNotificationDays +| +| List of <> +| +| int32 + +| passwordEncryptionMethod +| +| String | | @@ -3194,60 +3443,60 @@ endif::internal-generation[] [.fields-DirectoryLdapBean] [cols="2,1,2,4,1"] -|=== +|=== | Field Name| Required| Type| Description| Format -| id -| -| Long +| id +| +| Long | | int64 -| name -| X -| String +| name +| X +| String | | -| description -| -| String +| description +| +| String | | -| active -| -| Boolean +| active +| +| Boolean | | -| createdDate -| -| Date +| createdDate +| +| Date | | date-time -| updatedDate -| -| Date +| updatedDate +| +| Date | | date-time -| server -| -| DirectoryLdapServer +| server +| +| DirectoryLdapServer | | -| schema -| -| DirectoryLdapSchema +| schema +| +| DirectoryLdapSchema | | -| permissions -| -| DirectoryLdapPermissions +| permissions +| +| DirectoryLdapPermissions | | @@ -3261,24 +3510,24 @@ endif::internal-generation[] [.fields-DirectoryLdapPermissions] [cols="2,1,2,4,1"] -|=== +|=== | Field Name| Required| Type| Description| Format -| readOnly -| -| Boolean +| readOnly +| +| Boolean | | -| readOnlyForLocalGroups -| -| Boolean +| readOnlyForLocalGroups +| +| Boolean | | -| fullAccess -| -| Boolean +| fullAccess +| +| Boolean | | @@ -3292,24 +3541,24 @@ endif::internal-generation[] [.fields-DirectoryLdapSchema] [cols="2,1,2,4,1"] -|=== +|=== | Field Name| Required| Type| Description| Format -| baseDn -| -| String +| baseDn +| +| String | | -| userDn -| -| String +| userDn +| +| String | | -| groupDn -| -| String +| groupDn +| +| String | | @@ -3323,36 +3572,97 @@ endif::internal-generation[] [.fields-DirectoryLdapServer] [cols="2,1,2,4,1"] -|=== +|=== | Field Name| Required| Type| Description| Format -| host -| X -| String +| host +| X +| String | | -| port -| -| Integer +| port +| +| Integer | | int32 -| useSsl +| useSsl +| +| Boolean +| | -| Boolean + +| username +| +| String | | -| username +| password +| +| String +| | -| String + +|=== + + +[#DirectoryPermissions] +=== _DirectoryPermissions_ + + + +[.fields-DirectoryPermissions] +[cols="2,1,2,4,1"] +|=== +| Field Name| Required| Type| Description| Format + +| addGroup +| +| Boolean +| +| + +| addUser +| +| Boolean | | -| password +| modifyGroup +| +| Boolean +| +| + +| modifyUser +| +| Boolean +| +| + +| modifyGroupAttributes +| +| Boolean +| +| + +| modifyUserAttributes +| +| Boolean +| | -| String + +| removeGroup +| +| Boolean +| +| + +| removeUser +| +| Boolean | | @@ -3366,12 +3676,43 @@ endif::internal-generation[] [.fields-ErrorCollection] [cols="2,1,2,4,1"] -|=== +|=== | Field Name| Required| Type| Description| Format -| errorMessages +| errorMessages +| +| List of <> +| | -| List of <> + +|=== + + +[#GroupBean] +=== _GroupBean_ + + + +[.fields-GroupBean] +[cols="2,1,2,4,1"] +|=== +| Field Name| Required| Type| Description| Format + +| name +| +| String +| +| + +| description +| +| String +| +| + +| active +| +| Boolean | | @@ -3385,48 +3726,48 @@ endif::internal-generation[] [.fields-LicenseBean] [cols="2,1,2,4,1"] -|=== +|=== | Field Name| Required| Type| Description| Format -| products -| -| List of <> +| products +| +| List of <> | | -| type -| -| String +| type +| +| String | | -| organization -| -| String +| organization +| +| String | | -| description -| -| String +| description +| +| String | | -| expiryDate -| -| Date +| expiryDate +| +| Date | | date-time -| maxUsers -| -| Integer +| maxUsers +| +| Integer | | int32 -| key -| -| String +| key +| +| String | | @@ -3440,12 +3781,12 @@ endif::internal-generation[] [.fields-LicensesBean] [cols="2,1,2,4,1"] -|=== +|=== | Field Name| Required| Type| Description| Format -| licenses -| -| List of <> +| licenses +| +| List of <> | | @@ -3459,54 +3800,54 @@ endif::internal-generation[] [.fields-MailServerPopBean] [cols="2,1,2,4,1"] -|=== +|=== | Field Name| Required| Type| Description| Format -| name -| -| String +| name +| +| String | | -| description -| -| String +| description +| +| String | | -| host -| -| String +| host +| +| String | | -| port -| -| Integer +| port +| +| Integer | | int32 -| protocol -| -| String +| protocol +| +| String | | -| timeout -| -| Long +| timeout +| +| Long | | int64 -| username -| -| String +| username +| +| String | | -| password -| -| String +| password +| +| String | | @@ -3520,78 +3861,78 @@ endif::internal-generation[] [.fields-MailServerSmtpBean] [cols="2,1,2,4,1"] -|=== +|=== | Field Name| Required| Type| Description| Format -| name -| -| String +| name +| +| String | | -| description -| -| String +| description +| +| String | | -| host -| -| String +| host +| +| String | | -| port -| -| Integer +| port +| +| Integer | | int32 -| protocol -| -| String +| protocol +| +| String | | -| timeout -| -| Long +| timeout +| +| Long | | int64 -| username -| -| String +| username +| +| String | | -| password -| -| String +| password +| +| String | | -| adminContact -| -| String +| adminContact +| +| String | | -| from -| -| String +| from +| +| String | | -| prefix -| -| String +| prefix +| +| String | | -| useTls -| -| Boolean +| useTls +| +| Boolean | | @@ -3605,36 +3946,36 @@ endif::internal-generation[] [.fields-SettingsBean] [cols="2,1,2,4,1"] -|=== +|=== | Field Name| Required| Type| Description| Format -| baseUrl -| -| URI +| baseUrl +| +| URI | | uri -| mode -| -| String +| mode +| +| String | | -| title -| -| String +| title +| +| String | | -| contactMessage -| -| String +| contactMessage +| +| String | | -| externalUserManagement -| -| Boolean +| externalUserManagement +| +| Boolean | | @@ -3648,102 +3989,163 @@ endif::internal-generation[] [.fields-SettingsBrandingColorSchemeBean] [cols="2,1,2,4,1"] -|=== +|=== | Field Name| Required| Type| Description| Format -| topBar -| -| String +| topBar +| +| String | | -| topBarText -| -| String +| topBarText +| +| String | | -| headerButtonBackground -| -| String +| headerButtonBackground +| +| String | | -| headerButtonText -| -| String +| headerButtonText +| +| String | | -| topBarMenuSelectedBackground -| -| String +| topBarMenuSelectedBackground +| +| String | | -| topBarMenuSelectedText -| -| String +| topBarMenuSelectedText +| +| String | | -| topBarMenuItemText -| -| String +| topBarMenuItemText +| +| String | | -| menuItemSelectedBackground -| -| String +| menuItemSelectedBackground +| +| String | | -| menuItemSelectedText +| menuItemSelectedText +| +| String +| | -| String + +| searchFieldBackground +| +| String | | -| searchFieldBackground +| searchFieldText +| +| String +| | -| String + +| pageMenuSelectedBackground +| +| String | | -| searchFieldText +| pageMenuItemText +| +| String +| | -| String + +| headingText +| +| String | | -| pageMenuSelectedBackground +| links +| +| String +| | -| String + +| bordersAndDividers +| +| String | | -| pageMenuItemText +|=== + + +[#UserBean] +=== _UserBean_ + + + +[.fields-UserBean] +[cols="2,1,2,4,1"] +|=== +| Field Name| Required| Type| Description| Format + +| username +| +| String +| | -| String + +| firstName +| +| String | | -| headingText +| lastName +| +| String +| | -| String + +| fullName +| +| String | | -| links +| email +| +| String +| | -| String + +| active +| +| Boolean | | -| bordersAndDividers +| password +| +| String +| | -| String + +| groups +| +| List of <> | | diff --git a/pom.xml b/pom.xml index caff128..43064c3 100644 --- a/pom.xml +++ b/pom.xml @@ -57,17 +57,18 @@ 9.12.5 8209 - 8.0.2 + 8.12.4 ${project.groupId}.${project.artifactId} - 2.1.5 + 2.2.4 0.5.0 2.2.4 6.1.5.Final - 0.8.5 3.0.0 4.0.1 7.13.0 5.10.0 + 7.3.0 + 2.2.20 UTF-8 UTF-8 @@ -399,7 +400,7 @@ org.openapitools openapi-generator-maven-plugin - ${openapi-generator-maven-plugin.version} + ${openapi-generator.version} package @@ -411,7 +412,10 @@ asciidoc ${project.basedir} true - specDir=src/main/resources/doc/ + + specDir=src/main/resources/openapi/specs/ + snippetDir=src/main/resources/openapi/snippets/ + @@ -422,6 +426,13 @@ jacoco-maven-plugin ${jacoco.plugin.version} + + + + org.sonatype.plugins + nexus-staging-maven-plugin + 1.6.13 +