AMBARI-20624. Misc fixes for ambari-server swagger integration prototype. (jaimin)
Project: http://git-wip-us.apache.org/repos/asf/ambari/repo Commit: http://git-wip-us.apache.org/repos/asf/ambari/commit/3cb45e84 Tree: http://git-wip-us.apache.org/repos/asf/ambari/tree/3cb45e84 Diff: http://git-wip-us.apache.org/repos/asf/ambari/diff/3cb45e84 Branch: refs/heads/trunk Commit: 3cb45e849a45b71142eb294a6625d9ec2d5c050a Parents: e250b90 Author: Jaimin Jetly <jai...@hortonworks.com> Authored: Sun Apr 2 22:11:51 2017 -0700 Committer: Jaimin Jetly <jai...@hortonworks.com> Committed: Sun Apr 2 22:11:51 2017 -0700 ---------------------------------------------------------------------- .../docs/api/asciidoc/definitions.adoc | 321 - ambari-server/docs/api/asciidoc/overview.adoc | 23 - ambari-server/docs/api/asciidoc/paths.adoc | 1264 -- ambari-server/docs/api/generated/index.html | 17421 +++++++++++++++++ ambari-server/docs/api/generated/swagger.json | 2305 +++ ambari-server/pom.xml | 62 +- .../services/groups/GroupPrivilegeService.java | 6 +- .../api/services/groups/GroupService.java | 8 +- .../api/services/groups/MemberService.java | 8 +- .../users/ActiveWidgetLayoutService.java | 4 +- .../users/UserAuthorizationService.java | 4 +- .../services/users/UserPrivilegeService.java | 4 +- .../server/api/services/users/UserService.java | 10 +- .../views/ViewDataMigrationService.java | 4 +- .../api/services/views/ViewInstanceService.java | 10 +- .../services/views/ViewPermissionService.java | 4 +- .../services/views/ViewPrivilegeService.java | 8 +- .../server/api/services/views/ViewService.java | 4 +- .../api/services/views/ViewVersionService.java | 6 +- 19 files changed, 19816 insertions(+), 1660 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/ambari/blob/3cb45e84/ambari-server/docs/api/asciidoc/definitions.adoc ---------------------------------------------------------------------- diff --git a/ambari-server/docs/api/asciidoc/definitions.adoc b/ambari-server/docs/api/asciidoc/definitions.adoc deleted file mode 100644 index 76beb8c..0000000 --- a/ambari-server/docs/api/asciidoc/definitions.adoc +++ /dev/null @@ -1,321 +0,0 @@ -== Definitions -=== ActiveWidgetLayoutRequest -[options="header"] -|=== -|Name|Description|Required|Schema|Default -|WidgetLayouts||false|<<WidgetLayoutIdWrapper>> array| -|=== - -=== ActiveWidgetLayoutResponse -[options="header"] -|=== -|Name|Description|Required|Schema|Default -|WidgetLayoutInfo/cluster_name||false|string| -|WidgetLayoutInfo/display_name||false|string| -|WidgetLayoutInfo/layout_name||false|string| -|WidgetLayoutInfo/scope||false|string| -|WidgetLayoutInfo/section_name||false|string| -|WidgetLayoutInfo/user_name||false|string| -|WidgetLayoutInfo/widgets||false|object array| -|=== - -=== GroupPrivilegeResponse -[options="header"] -|=== -|Name|Description|Required|Schema|Default -|PrivilegeInfo/permission_label||false|string| -|PrivilegeInfo/privilege_id||false|integer (int32)| -|PrivilegeInfo/permission_name||false|string| -|PrivilegeInfo/principal_type||false|enum (USER, GROUP, ROLE)| -|PrivilegeInfo/principal_name||false|string| -|PrivilegeInfo/type||false|enum (AMBARI, CLUSTER, VIEW)| -|PrivilegeInfo/cluster_name||false|string| -|PrivilegeInfo/view_name||false|string| -|PrivilegeInfo/version||false|string| -|PrivilegeInfo/instance_name||false|string| -|PrivilegeInfo/group_name||true|string| -|=== - -=== GroupRequest -[options="header"] -|=== -|Name|Description|Required|Schema|Default -|Groups/group_name||true|string| -|=== - -=== GroupResponse -[options="header"] -|=== -|Name|Description|Required|Schema|Default -|Groups/group_name||false|string| -|Groups/ldap_group||false|boolean|false -|Groups/group_type||false|enum (LOCAL, LDAP, JWT, PAM)| -|=== - -=== MemberRequest -[options="header"] -|=== -|Name|Description|Required|Schema|Default -|MemberInfo/group_name||true|string| -|MemberInfo/user_name||true|string| -|=== - -=== MemberResponse -[options="header"] -|=== -|Name|Description|Required|Schema|Default -|MemberInfo/group_name||false|string| -|MemberInfo/user_name||false|string| -|=== - -=== ParameterConfig -[options="header"] -|=== -|Name|Description|Required|Schema|Default -|name||false|string| -|description||false|string| -|label||false|string| -|placeholder||false|string| -|defaultValue||false|string| -|clusterConfig||false|string| -|required||false|boolean|false -|masked||false|boolean|false -|=== - -=== PrivilegeResponse -[options="header"] -|=== -|Name|Description|Required|Schema|Default -|PrivilegeInfo/permission_label||false|string| -|PrivilegeInfo/privilege_id||false|integer (int32)| -|PrivilegeInfo/permission_name||false|string| -|PrivilegeInfo/principal_type||false|enum (USER, GROUP, ROLE)| -|PrivilegeInfo/principal_name||false|string| -|PrivilegeInfo/type||false|enum (AMBARI, CLUSTER, VIEW)| -|PrivilegeInfo/cluster_name||false|string| -|PrivilegeInfo/view_name||false|string| -|PrivilegeInfo/version||false|string| -|PrivilegeInfo/instance_name||false|string| -|=== - -=== UserAuthorizationResponse -[options="header"] -|=== -|Name|Description|Required|Schema|Default -|AuthorizationInfo/authorization_id||false|string| -|AuthorizationInfo/authorization_name||false|string| -|AuthorizationInfo/resource_type||false|string| -|AuthorizationInfo/user_name||true|string| -|AuthorizationInfo/cluster_name||false|string| -|AuthorizationInfo/view_name||false|string| -|AuthorizationInfo/view_version||false|string| -|AuthorizationInfo/view_instance_name||false|string| -|=== - -=== UserPrivilegeResponse -[options="header"] -|=== -|Name|Description|Required|Schema|Default -|PrivilegeInfo/permission_label||false|string| -|PrivilegeInfo/privilege_id||false|integer (int32)| -|PrivilegeInfo/permission_name||false|string| -|PrivilegeInfo/principal_type||false|enum (USER, GROUP, ROLE)| -|PrivilegeInfo/principal_name||false|string| -|PrivilegeInfo/type||false|enum (AMBARI, CLUSTER, VIEW)| -|PrivilegeInfo/cluster_name||false|string| -|PrivilegeInfo/view_name||false|string| -|PrivilegeInfo/version||false|string| -|PrivilegeInfo/instance_name||false|string| -|PrivilegeInfo/user_name||true|string| -|=== - -=== UserRequest -[options="header"] -|=== -|Name|Description|Required|Schema|Default -|Users/password||false|string| -|Users/old_password||false|string| -|Users/active||false|boolean|false -|Users/admin||false|boolean|false -|=== - -=== UserResponse -[options="header"] -|=== -|Name|Description|Required|Schema|Default -|Users/user_type||false|enum (LOCAL, LDAP, JWT, PAM)| -|Users/groups||false|string array| -|Users/user_name||true|string| -|Users/active||false|boolean|false -|Users/admin||false|boolean|false -|Users/ldap_user||false|boolean|false -|=== - -=== ValidationResult -[options="header"] -|=== -|Name|Description|Required|Schema|Default -|detail||false|string| -|valid||false|boolean|false -|=== - -=== ViewInfo -[options="header"] -|=== -|Name|Description|Required|Schema|Default -|view_name||false|string| -|=== - -=== ViewInstanceRequest -[options="header"] -|=== -|Name|Description|Required|Schema|Default -|ViewInstanceInfo||false|<<ViewInstanceRequestInfo>>| -|=== - -=== ViewInstanceRequestInfo -[options="header"] -|=== -|Name|Description|Required|Schema|Default -|label||false|string| -|description||false|string| -|visible||false|boolean|false -|icon_path||false|string| -|icon64_path||false|string| -|properties||false|object| -|instance_data||false|object| -|cluster_handle||false|integer (int32)| -|cluster_type||false|enum (LOCAL_AMBARI, REMOTE_AMBARI, NONE)| -|=== - -=== ViewInstanceResponse -[options="header"] -|=== -|Name|Description|Required|Schema|Default -|ViewInstanceInfo||false|<<ViewInstanceResponseInfo>>| -|=== - -=== ViewInstanceResponseInfo -[options="header"] -|=== -|Name|Description|Required|Schema|Default -|view_name||false|string| -|version||false|string| -|instance_name||false|string| -|label||false|string| -|description||false|string| -|visible||false|boolean|false -|icon_path||false|string| -|icon64_path||false|string| -|properties||false|object| -|instance_data||false|object| -|cluster_handle||false|integer (int32)| -|cluster_type||false|enum (LOCAL_AMBARI, REMOTE_AMBARI, NONE)| -|context_path||false|string| -|static||false|boolean|false -|short_url||false|string| -|short_url_name||false|string| -|validation_result||false|<<ValidationResult>>| -|property_validation_results||false|object| -|=== - -=== ViewPermissionInfo -[options="header"] -|=== -|Name|Description|Required|Schema|Default -|view_name||false|string| -|version||false|string| -|permission_id||false|integer (int32)| -|permission_name||false|string| -|resource_name||false|string| -|=== - -=== ViewPermissionResponse -[options="header"] -|=== -|Name|Description|Required|Schema|Default -|ViewPermissionInfo||false|<<ViewPermissionInfo>>| -|=== - -=== ViewPrivilegeRequest -[options="header"] -|=== -|Name|Description|Required|Schema|Default -|PrivilegeInfo/permission_name||false|string| -|PrivilegeInfo/principal_type||false|enum (USER, GROUP, ROLE)| -|PrivilegeInfo/principal_name||false|string| -|=== - -=== ViewPrivilegeResponse -[options="header"] -|=== -|Name|Description|Required|Schema|Default -|PrivilegeInfo/permission_label||false|string| -|PrivilegeInfo/privilege_id||false|integer (int32)| -|PrivilegeInfo/permission_name||false|string| -|PrivilegeInfo/principal_type||false|enum (USER, GROUP, ROLE)| -|PrivilegeInfo/principal_name||false|string| -|PrivilegeInfo/view_name||false|string| -|PrivilegeInfo/version||false|string| -|PrivilegeInfo/instance_name||false|string| -|=== - -=== ViewResponse -[options="header"] -|=== -|Name|Description|Required|Schema|Default -|ViewInfo||false|<<ViewInfo>>| -|=== - -=== ViewVersionInfo -[options="header"] -|=== -|Name|Description|Required|Schema|Default -|archive||false|string| -|build_number||false|string| -|cluster_configurable||false|boolean|false -|description||false|string| -|label||false|string| -|masker_class||false|string| -|max_ambari_version||false|string| -|min_ambari_version||false|string| -|parameters||false|<<ParameterConfig>> array| -|status||false|enum (PENDING, DEPLOYING, DEPLOYED, ERROR)| -|status_detail||false|string| -|system||false|boolean|false -|version||false|string| -|view_name||false|string| -|=== - -=== ViewVersionResponse -[options="header"] -|=== -|Name|Description|Required|Schema|Default -|ViewVersionInfo||false|<<ViewVersionInfo>>| -|=== - -=== WidgetLayoutIdWrapper -[options="header"] -|=== -|Name|Description|Required|Schema|Default -|id||false|integer (int64)| -|=== - -=== WidgetResponse -[options="header"] -|=== -|Name|Description|Required|Schema|Default -|id||false|integer (int64)| -|widgetName||false|string| -|widgetType||false|string| -|metrics||false|string| -|timeCreated||false|integer (int64)| -|author||false|string| -|description||false|string| -|displayName||false|string| -|scope||false|string| -|widgetValues||false|string| -|properties||false|string| -|clusterName||false|string| -|=== - http://git-wip-us.apache.org/repos/asf/ambari/blob/3cb45e84/ambari-server/docs/api/asciidoc/overview.adoc ---------------------------------------------------------------------- diff --git a/ambari-server/docs/api/asciidoc/overview.adoc b/ambari-server/docs/api/asciidoc/overview.adoc deleted file mode 100644 index e9e5649..0000000 --- a/ambari-server/docs/api/asciidoc/overview.adoc +++ /dev/null @@ -1,23 +0,0 @@ -= Swagger spec for Ambari REST API - -== Overview -Ambari REST APIs has inherent support for querying, sorting and pagination - -=== Version information -Version: v1 - -=== License information -License: Apache License, Version 2.0 -License URL: http://www.apache.org/licenses/LICENSE-2.0 - -=== URI scheme -BasePath: /api/v1 -Schemes: HTTP, HTTPS - -=== Tags - -* Groups: Endpoint for group specific operations -* Users: Endpoint for user specific operations -* Views - - http://git-wip-us.apache.org/repos/asf/ambari/blob/3cb45e84/ambari-server/docs/api/asciidoc/paths.adoc ---------------------------------------------------------------------- diff --git a/ambari-server/docs/api/asciidoc/paths.adoc b/ambari-server/docs/api/asciidoc/paths.adoc deleted file mode 100644 index d756051..0000000 --- a/ambari-server/docs/api/asciidoc/paths.adoc +++ /dev/null @@ -1,1264 +0,0 @@ -== Paths -=== Create new group ----- -POST /groups ----- - -==== Description -:hardbreaks: -Creates group resource. - -==== Parameters -[options="header"] -|=== -|Type|Name|Description|Required|Schema|Default -|BodyParameter|body|input parameters in json form|true|<<GroupRequest>>| -|=== - -==== Responses -[options="header"] -|=== -|HTTP Code|Description|Schema -|200|successful operation|No Content -|500|Server Error|No Content -|=== - -==== Produces - -* text/plain - -==== Tags - -* Groups - -=== Get all groups ----- -GET /groups ----- - -==== Description -:hardbreaks: -Returns details of all groups. - -==== Parameters -[options="header"] -|=== -|Type|Name|Description|Required|Schema|Default -|QueryParameter|fields|Filter group details|false|string|Groups/* -|QueryParameter|sortBy|Sort groups (asc | desc)|false|string|Groups/group_name.asc -|QueryParameter|page_size|The number of resources to be returned for the paged response.|false|integer|10 -|QueryParameter|from|The starting page resource (inclusive). Valid values are :offset | "start"|false|string|0 -|QueryParameter|to|The ending page resource (inclusive). Valid values are :offset | "end"|false|string| -|=== - -==== Responses -[options="header"] -|=== -|HTTP Code|Description|Schema -|200|Successful retrieval of all group entries|<<GroupResponse>> array -|=== - -==== Produces - -* text/plain - -==== Tags - -* Groups - -=== Get group ----- -GET /groups/{groupName} ----- - -==== Description -:hardbreaks: -Returns group details. - -==== Parameters -[options="header"] -|=== -|Type|Name|Description|Required|Schema|Default -|PathParameter|groupName|group name|true|string| -|QueryParameter|fields|Filter group details|false|string|Groups -|=== - -==== Responses -[options="header"] -|=== -|HTTP Code|Description|Schema -|200|Successful retrieval of group resource|<<GroupResponse>> -|=== - -==== Produces - -* text/plain - -==== Tags - -* Groups - -=== Delete group ----- -DELETE /groups/{groupName} ----- - -==== Description -:hardbreaks: -Delete group resource. - -==== Parameters -[options="header"] -|=== -|Type|Name|Description|Required|Schema|Default -|PathParameter|groupName|group name|true|string| -|=== - -==== Responses -[options="header"] -|=== -|HTTP Code|Description|Schema -|200|Successful operation|No Content -|500|Server Error|No Content -|=== - -==== Produces - -* text/plain - -==== Tags - -* Groups - -=== Get all group members ----- -GET /groups/{groupName}/members ----- - -==== Description -:hardbreaks: -Returns details of all members. - -==== Parameters -[options="header"] -|=== -|Type|Name|Description|Required|Schema|Default -|PathParameter|groupName|group name|true|string| -|QueryParameter|fields|Filter member details|false|string|MemberInfo/* -|QueryParameter|sortBy|Sort members (asc | desc)|false|string|MemberInfo/user_name.asc -|QueryParameter|page_size|The number of resources to be returned for the paged response.|false|integer|10 -|QueryParameter|from|The starting page resource (inclusive). Valid values are :offset | "start"|false|string|0 -|QueryParameter|to|The ending page resource (inclusive). Valid values are :offset | "end"|false|string| -|=== - -==== Responses -[options="header"] -|=== -|HTTP Code|Description|Schema -|200|Successful operation|<<MemberResponse>> array -|=== - -==== Produces - -* text/plain - -==== Tags - -* Groups - -=== Update group members ----- -PUT /groups/{groupName}/members ----- - -==== Description -:hardbreaks: -Updates group member resources. - -==== Parameters -[options="header"] -|=== -|Type|Name|Description|Required|Schema|Default -|PathParameter|groupName|group name|true|string| -|BodyParameter|body|input parameters in json form|true|<<MemberRequest>>| -|=== - -==== Responses -[options="header"] -|=== -|HTTP Code|Description|Schema -|200|Successful operation|No Content -|500|Server Error|No Content -|=== - -==== Produces - -* text/plain - -==== Tags - -* Groups - -=== Get group member ----- -GET /groups/{groupName}/members/{userName} ----- - -==== Description -:hardbreaks: -Returns member details. - -==== Parameters -[options="header"] -|=== -|Type|Name|Description|Required|Schema|Default -|PathParameter|groupName|group name|true|string| -|PathParameter|userName|user name|true|string| -|QueryParameter|fields|Filter member details|false|string|MemberInfo -|=== - -==== Responses -[options="header"] -|=== -|HTTP Code|Description|Schema -|200|Successful operation|<<MemberResponse>> -|=== - -==== Produces - -* text/plain - -==== Tags - -* Groups - -=== Delete group member ----- -DELETE /groups/{groupName}/members/{userName} ----- - -==== Description -:hardbreaks: -Delete member resource. - -==== Parameters -[options="header"] -|=== -|Type|Name|Description|Required|Schema|Default -|PathParameter|groupName|group name|true|string| -|PathParameter|userName|user name|true|string| -|=== - -==== Responses -[options="header"] -|=== -|HTTP Code|Description|Schema -|200|Successful operation|No Content -|500|Server Error|No Content -|=== - -==== Produces - -* text/plain - -==== Tags - -* Groups - -=== Get all privileges ----- -GET /groups/{groupName}/privileges ----- - -==== Description -:hardbreaks: -Returns all privileges for group. - -==== Parameters -[options="header"] -|=== -|Type|Name|Description|Required|Schema|Default -|PathParameter|groupName|group name|true|string| -|QueryParameter|fields|Filter user privileges|false|string|PrivilegeInfo/* -|QueryParameter|sortBy|Sort user privileges (asc | desc)|false|string|PrivilegeInfo/user_name.asc -|QueryParameter|page_size|The number of resources to be returned for the paged response.|false|integer|10 -|QueryParameter|from|The starting page resource (inclusive). Valid values are :offset | "start"|false|string|0 -|QueryParameter|to|The ending page resource (inclusive). Valid values are :offset | "end"|false|string| -|=== - -==== Responses -[options="header"] -|=== -|HTTP Code|Description|Schema -|200|successful operation|<<GroupPrivilegeResponse>> array -|=== - -==== Produces - -* text/plain - -==== Tags - -* Groups - -=== Get group privilege ----- -GET /groups/{groupName}/privileges/{privilegeId} ----- - -==== Description -:hardbreaks: -Returns group privilege details. - -==== Parameters -[options="header"] -|=== -|Type|Name|Description|Required|Schema|Default -|PathParameter|userName|user name|true|string| -|PathParameter|privilegeId|privilege id|true|string| -|QueryParameter|fields|Filter group privilege details|false|string|PrivilegeInfo/* -|=== - -==== Responses -[options="header"] -|=== -|HTTP Code|Description|Schema -|200|Successful operation|<<PrivilegeResponse>> -|=== - -==== Produces - -* text/plain - -==== Tags - -* Groups - -=== Get all users ----- -GET /users ----- - -==== Description -:hardbreaks: -Returns details of all users. - -==== Parameters -[options="header"] -|=== -|Type|Name|Description|Required|Schema|Default -|QueryParameter|fields|Filter user details|false|string|Users/* -|QueryParameter|sortBy|Sort users (asc | desc)|false|string|Users/user_name.desc -|QueryParameter|page_size|The number of resources to be returned for the paged response.|false|integer|10 -|QueryParameter|from|The starting page resource (inclusive). Valid values are :offset | "start"|false|string|0 -|QueryParameter|to|The ending page resource (inclusive). Valid values are :offset | "end"|false|string| -|=== - -==== Responses -[options="header"] -|=== -|HTTP Code|Description|Schema -|200|Successful operation|<<UserResponse>> array -|=== - -==== Produces - -* text/plain - -==== Tags - -* Users - -=== Create new user ----- -POST /users/{userName} ----- - -==== Description -:hardbreaks: -Creates user resource. - -==== Parameters -[options="header"] -|=== -|Type|Name|Description|Required|Schema|Default -|PathParameter|userName|user name|true|string| -|BodyParameter|body|input parameters in json form|true|<<UserRequest>>| -|=== - -==== Responses -[options="header"] -|=== -|HTTP Code|Description|Schema -|200|Successful operation|No Content -|500|Server Error|No Content -|=== - -==== Produces - -* text/plain - -==== Tags - -* Users - -=== Get single user ----- -GET /users/{userName} ----- - -==== Description -:hardbreaks: -Returns user details. - -==== Parameters -[options="header"] -|=== -|Type|Name|Description|Required|Schema|Default -|PathParameter|userName|user name|true|string|admin -|QueryParameter|fields|Filter user details|false|string|Users -|=== - -==== Responses -[options="header"] -|=== -|HTTP Code|Description|Schema -|200|Successful operation|<<UserResponse>> -|=== - -==== Produces - -* text/plain - -==== Tags - -* Users - -=== Delete single user ----- -DELETE /users/{userName} ----- - -==== Description -:hardbreaks: -Delete user resource. - -==== Parameters -[options="header"] -|=== -|Type|Name|Description|Required|Schema|Default -|PathParameter|userName|user name|true|string| -|=== - -==== Responses -[options="header"] -|=== -|HTTP Code|Description|Schema -|200|Successful operation|No Content -|500|Server Error|No Content -|=== - -==== Produces - -* text/plain - -==== Tags - -* Users - -=== Update user detail ----- -PUT /users/{userName} ----- - -==== Description -:hardbreaks: -Updates user resource. - -==== Parameters -[options="header"] -|=== -|Type|Name|Description|Required|Schema|Default -|PathParameter|userName|user name|true|string| -|BodyParameter|body|input parameters in json form|true|<<UserRequest>>| -|=== - -==== Responses -[options="header"] -|=== -|HTTP Code|Description|Schema -|200|Successful operation|No Content -|500|Server Error|No Content -|=== - -==== Produces - -* text/plain - -==== Tags - -* Users - -=== Get user widget layouts ----- -GET /users/{userName}/activeWidgetLayouts ----- - -==== Description -:hardbreaks: -Returns all active widget layouts for user. - -==== Parameters -[options="header"] -|=== -|Type|Name|Description|Required|Schema|Default -|PathParameter|userName|user name|true|string| -|QueryParameter|fields|Filter user layout details|false|string|WidgetLayoutInfo/* -|QueryParameter|sortBy|Sort layouts (asc | desc)|false|string|WidgetLayoutInfo/user_name.asc -|QueryParameter|page_size|The number of resources to be returned for the paged response.|false|integer|10 -|QueryParameter|from|The starting page resource (inclusive). Valid values are :offset | "start"|false|string|0 -|QueryParameter|to|The ending page resource (inclusive). Valid values are :offset | "end"|false|string| -|=== - -==== Responses -[options="header"] -|=== -|HTTP Code|Description|Schema -|200|successful operation|<<ActiveWidgetLayoutResponse>> array -|=== - -==== Produces - -* text/plain - -==== Tags - -* Users - -=== Update user widget layouts ----- -PUT /users/{userName}/activeWidgetLayouts ----- - -==== Description -:hardbreaks: -Updates user widget layout. - -==== Parameters -[options="header"] -|=== -|Type|Name|Description|Required|Schema|Default -|PathParameter|userName|user name|true|string| -|BodyParameter|body|input parameters in json form|true|<<ActiveWidgetLayoutRequest>>| -|=== - -==== Responses -[options="header"] -|=== -|HTTP Code|Description|Schema -|200|Successful operation|No Content -|500|Server Error|No Content -|=== - -==== Produces - -* text/plain - -==== Tags - -* Users - -=== Get all authorizations ----- -GET /users/{userName}/authorizations ----- - -==== Description -:hardbreaks: -Returns all authorization for user. - -==== Parameters -[options="header"] -|=== -|Type|Name|Description|Required|Schema|Default -|PathParameter|userName|user name|true|string| -|QueryParameter|fields|Filter user authorization details|false|string|AuthorizationInfo/* -|QueryParameter|sortBy|Sort user authorizations (asc | desc)|false|string|AuthorizationInfo/user_name.asc -|QueryParameter|page_size|The number of resources to be returned for the paged response.|false|integer|10 -|QueryParameter|from|The starting page resource (inclusive). Valid values are :offset | "start"|false|string|0 -|QueryParameter|to|The ending page resource (inclusive). Valid values are :offset | "end"|false|string| -|=== - -==== Responses -[options="header"] -|=== -|HTTP Code|Description|Schema -|200|successful operation|<<UserAuthorizationResponse>> array -|=== - -==== Produces - -* text/plain - -==== Tags - -* Users - -=== Get user authorization ----- -GET /users/{userName}/authorizations/{authorization_id} ----- - -==== Description -:hardbreaks: -Returns user authorization details. - -==== Parameters -[options="header"] -|=== -|Type|Name|Description|Required|Schema|Default -|PathParameter|userName|user name|true|string| -|PathParameter|authorization_id|Authorization Id|true|string| -|QueryParameter|fields|Filter user authorization details|false|string|AuthorizationInfo/* -|=== - -==== Responses -[options="header"] -|=== -|HTTP Code|Description|Schema -|200|Successful operation|<<UserAuthorizationResponse>> -|=== - -==== Produces - -* text/plain - -==== Tags - -* Users - -=== Get all privileges ----- -GET /users/{userName}/privileges ----- - -==== Description -:hardbreaks: -Returns all privileges for user. - -==== Parameters -[options="header"] -|=== -|Type|Name|Description|Required|Schema|Default -|PathParameter|userName|user name|true|string|admin -|QueryParameter|fields|Filter user privileges|false|string|PrivilegeInfo/* -|QueryParameter|sortBy|Sort user privileges (asc | desc)|false|string|PrivilegeInfo/user_name.asc -|QueryParameter|page_size|The number of resources to be returned for the paged response.|false|integer|10 -|QueryParameter|from|The starting page resource (inclusive). Valid values are :offset | "start"|false|string|0 -|QueryParameter|to|The ending page resource (inclusive). Valid values are :offset | "end"|false|string| -|=== - -==== Responses -[options="header"] -|=== -|HTTP Code|Description|Schema -|200|successful operation|<<UserPrivilegeResponse>> array -|=== - -==== Produces - -* text/plain - -==== Tags - -* Users - -=== Get user privilege ----- -GET /users/{userName}/privileges/{privilegeId} ----- - -==== Description -:hardbreaks: -Returns user privilege details. - -==== Parameters -[options="header"] -|=== -|Type|Name|Description|Required|Schema|Default -|PathParameter|userName|user name|true|string| -|PathParameter|privilegeId|privilege id|true|string| -|QueryParameter|fields|Filter user privilege details|false|string|PrivilegeInfo/* -|=== - -==== Responses -[options="header"] -|=== -|HTTP Code|Description|Schema -|200|Successful operation|<<UserPrivilegeResponse>> -|=== - -==== Produces - -* text/plain - -==== Tags - -* Users - -=== Get all views ----- -GET /views ----- - -==== Description -:hardbreaks: -Returns details of all views. - -==== Parameters -[options="header"] -|=== -|Type|Name|Description|Required|Schema|Default -|QueryParameter|fields|Filter view details|false|string|ViewInfo/* -|QueryParameter|sortBy|Sort users (asc | desc)|false|string|ViewInfo/view_name.asc -|QueryParameter|page_size|The number of resources to be returned for the paged response.|false|integer|10 -|QueryParameter|from|The starting page resource (inclusive). Valid values are :offset | "start"|false|string|0 -|QueryParameter|to|The ending page resource (inclusive). Valid values are :offset | "end"|false|string| -|=== - -==== Responses -[options="header"] -|=== -|HTTP Code|Description|Schema -|200|Successful operation|<<ViewResponse>> array -|=== - -==== Produces - -* text/plain - -==== Tags - -* Views - -=== Get single view ----- -GET /views/{viewName} ----- - -==== Description -:hardbreaks: -Returns view details. - -==== Parameters -[options="header"] -|=== -|Type|Name|Description|Required|Schema|Default -|PathParameter|viewName|view name|true|string| -|QueryParameter|fields|Filter view details|false|string|ViewInfo -|=== - -==== Responses -[options="header"] -|=== -|HTTP Code|Description|Schema -|200|Successful operation|<<ViewResponse>> -|=== - -==== Produces - -* text/plain - -==== Tags - -* Views - -=== Get all versions for a view ----- -GET /views/{viewName}/versions ----- - -==== Description -:hardbreaks: -Returns details of all versions for a view. - -==== Parameters -[options="header"] -|=== -|Type|Name|Description|Required|Schema|Default -|PathParameter|viewName|view name|true|string| -|QueryParameter|fields|Filter view version details|false|string|ViewVersionInfo/* -|QueryParameter|sortBy|Sort users (asc | desc)|false|string|ViewVersionInfo/version.desc -|QueryParameter|page_size|The number of resources to be returned for the paged response.|false|integer|10 -|QueryParameter|from|The starting page resource (inclusive). Valid values are :offset | "start"|false|string|0 -|QueryParameter|to|The ending page resource (inclusive). Valid values are :offset | "end"|false|string| -|=== - -==== Responses -[options="header"] -|=== -|HTTP Code|Description|Schema -|200|Successful operation|<<ViewVersionResponse>> array -|=== - -==== Produces - -* text/plain - -==== Tags - -* Views - -=== Get single view version ----- -GET /views/{viewName}/versions/{version} ----- - -==== Description -:hardbreaks: -Returns view details. - -==== Parameters -[options="header"] -|=== -|Type|Name|Description|Required|Schema|Default -|PathParameter|viewName|view name|true|string| -|PathParameter|version||true|string| -|QueryParameter|fields|Filter view details|false|string|ViewVersionInfo -|=== - -==== Responses -[options="header"] -|=== -|HTTP Code|Description|Schema -|200|Successful operation|<<ViewVersionResponse>> -|=== - -==== Produces - -* text/plain - -==== Tags - -* Views - -=== Get all view instances ----- -GET /views/{viewName}/versions/{version}/instances ----- - -==== Description -:hardbreaks: -Returns all instances for a view version. - -==== Parameters -[options="header"] -|=== -|Type|Name|Description|Required|Schema|Default -|PathParameter|viewName||true|string| -|PathParameter|version||true|string| -|QueryParameter|fields|Filter view instance details|false|string|ViewInstanceInfo/* -|QueryParameter|sortBy|Sort users (asc | desc)|false|string|ViewInstanceInfo/instance_name.desc -|QueryParameter|page_size|The number of resources to be returned for the paged response.|false|integer|10 -|QueryParameter|from|The starting page resource (inclusive). Valid values are :offset | "start"|false|string|0 -|QueryParameter|to|The ending page resource (inclusive). Valid values are :offset | "end"|false|string| -|=== - -==== Responses -[options="header"] -|=== -|HTTP Code|Description|Schema -|200|Successful operation|<<ViewInstanceResponse>> array -|=== - -==== Produces - -* text/plain - -==== Tags - -* Views - -=== Create view instance ----- -POST /views/{viewName}/versions/{version}/instances/{instanceName} ----- - -==== Description -:hardbreaks: -Creates view instance resource. - -==== Parameters -[options="header"] -|=== -|Type|Name|Description|Required|Schema|Default -|PathParameter|viewName|view name|true|string| -|PathParameter|version||true|string| -|PathParameter|instanceName|instance name|true|string| -|BodyParameter|body|input parameters in json form|true|<<ViewInstanceRequest>>| -|=== - -==== Responses -[options="header"] -|=== -|HTTP Code|Description|Schema -|200|Successful operation|No Content -|500|Server Error|No Content -|=== - -==== Produces - -* text/plain - -==== Tags - -* Views - -=== Get single view instance ----- -GET /views/{viewName}/versions/{version}/instances/{instanceName} ----- - -==== Description -:hardbreaks: -Returns view instance details. - -==== Parameters -[options="header"] -|=== -|Type|Name|Description|Required|Schema|Default -|PathParameter|viewName|view name|true|string| -|PathParameter|version||true|string| -|PathParameter|instanceName|instance name|true|string| -|QueryParameter|fields|Filter view instance details|false|string|ViewInstanceInfo -|=== - -==== Responses -[options="header"] -|=== -|HTTP Code|Description|Schema -|200|Successful operation|<<ViewInstanceResponse>> -|=== - -==== Produces - -* text/plain - -==== Tags - -* Views - -=== Delete view instance ----- -DELETE /views/{viewName}/versions/{version}/instances/{instanceName} ----- - -==== Description -:hardbreaks: -Delete view resource. - -==== Parameters -[options="header"] -|=== -|Type|Name|Description|Required|Schema|Default -|PathParameter|viewName|view name|true|string| -|PathParameter|version||true|string| -|PathParameter|instanceName|instance name|true|string| -|=== - -==== Responses -[options="header"] -|=== -|HTTP Code|Description|Schema -|200|Successful operation|No Content -|500|Server Error|No Content -|=== - -==== Produces - -* text/plain - -==== Tags - -* Views - -=== Update view instance detail ----- -PUT /views/{viewName}/versions/{version}/instances/{instanceName} ----- - -==== Description -:hardbreaks: -Updates view instance resource. - -==== Parameters -[options="header"] -|=== -|Type|Name|Description|Required|Schema|Default -|PathParameter|viewName|view name|true|string| -|PathParameter|version||true|string| -|PathParameter|instanceName|instance name|true|string| -|BodyParameter|body|input parameters in json form|true|<<ViewInstanceRequest>>| -|=== - -==== Responses -[options="header"] -|=== -|HTTP Code|Description|Schema -|200|Successful operation|No Content -|500|Server Error|No Content -|=== - -==== Produces - -* text/plain - -==== Tags - -* Views - -=== Migrate view instance data ----- -PUT /views/{viewName}/versions/{version}/instances/{instanceName}/migrate/{originVersion}/{originInstanceName} ----- - -==== Description -:hardbreaks: -Migrates view instance persistence data from origin view instance specified in the path params. - -==== Parameters -[options="header"] -|=== -|Type|Name|Description|Required|Schema|Default -|PathParameter|viewName|view name|true|string| -|PathParameter|viewVersion|view version|true|string| -|PathParameter|instanceName|instance name|true|string| -|PathParameter|originVersion|origin version|true|string| -|PathParameter|originInstanceName|origin instance name|true|string| -|=== - -==== Responses -[options="header"] -|=== -|HTTP Code|Description|Schema -|200|Successful operation|No Content -|500|Server Error|No Content -|=== - -==== Tags - -* Views - -=== Create view instance privilege ----- -POST /views/{viewName}/versions/{version}/instances/{instanceName}/privileges ----- - -==== Description -:hardbreaks: -Create privilege resource for view instance. - -==== Parameters -[options="header"] -|=== -|Type|Name|Description|Required|Schema|Default -|PathParameter|viewName|view name|true|string| -|PathParameter|version|view version|true|string| -|PathParameter|instanceName|instance name|true|string| -|BodyParameter|body|input parameters in json form|true|<<ViewPrivilegeRequest>>| -|=== - -==== Responses -[options="header"] -|=== -|HTTP Code|Description|Schema -|200|Successful operation|No Content -|500|Server Error|No Content -|=== - -==== Produces - -* text/plain - -==== Tags - -* Views - -=== Get all view instance privileges ----- -GET /views/{viewName}/versions/{version}/instances/{instanceName}/privileges ----- - -==== Description -:hardbreaks: -Returns all privileges for the resource. - -==== Parameters -[options="header"] -|=== -|Type|Name|Description|Required|Schema|Default -|PathParameter|viewName|view name|true|string| -|PathParameter|version|view version|true|string| -|PathParameter|instanceName|instance name|true|string| -|QueryParameter|fields|Filter privileges|false|string|PrivilegeInfo/* -|QueryParameter|sortBy|Sort privileges (asc | desc)|false|string|PrivilegeInfo/user_name.asc -|QueryParameter|page_size|The number of resources to be returned for the paged response.|false|integer|10 -|QueryParameter|from|The starting page resource (inclusive). Valid values are :offset | "start"|false|string|0 -|QueryParameter|to|The ending page resource (inclusive). Valid values are :offset | "end"|false|string| -|=== - -==== Responses -[options="header"] -|=== -|HTTP Code|Description|Schema -|200|successful operation|<<ViewPrivilegeResponse>> array -|=== - -==== Produces - -* text/plain - -==== Tags - -* Views - -=== Get single view instance privilege ----- -GET /views/{viewName}/versions/{version}/instances/{instanceName}/privileges/{privilegeId} ----- - -==== Description -:hardbreaks: -Returns privilege details. - -==== Parameters -[options="header"] -|=== -|Type|Name|Description|Required|Schema|Default -|PathParameter|viewName|view name|true|string| -|PathParameter|version|view version|true|string| -|PathParameter|instanceName|instance name|true|string| -|PathParameter|privilegeId|privilege id|true|string| -|QueryParameter|fields|Filter privilege details|false|string|PrivilegeInfo -|=== - -==== Responses -[options="header"] -|=== -|HTTP Code|Description|Schema -|200|Successful operation|<<ViewPrivilegeResponse>> -|=== - -==== Produces - -* text/plain - -==== Tags - -* Views - -=== Delete view instance privilege ----- -DELETE /views/{viewName}/versions/{version}/instances/{instanceName}/privileges/{privilegeId} ----- - -==== Description -:hardbreaks: -Delete view instance privilege resource. - -==== Parameters -[options="header"] -|=== -|Type|Name|Description|Required|Schema|Default -|PathParameter|viewName|view name|true|string| -|PathParameter|version|view version|true|string| -|PathParameter|instanceName|instance name|true|string| -|PathParameter|privilegeId|privilege id|true|string| -|=== - -==== Responses -[options="header"] -|=== -|HTTP Code|Description|Schema -|200|Successful operation|No Content -|500|Server Error|No Content -|=== - -==== Produces - -* text/plain - -==== Tags - -* Views - -=== Get all permissions for a view ----- -GET /views/{viewName}/versions/{version}/permissions ----- - -==== Description -:hardbreaks: -Returns all permission details for the version of a view. - -==== Parameters -[options="header"] -|=== -|Type|Name|Description|Required|Schema|Default -|PathParameter|viewName|view name|true|string| -|PathParameter|version|view version|true|string| -|QueryParameter|fields|Filter privileges|false|string|PermissionInfo/* -|QueryParameter|page_size|The number of resources to be returned for the paged response.|false|integer|10 -|QueryParameter|from|The starting page resource (inclusive). Valid values are :offset | "start"|false|string|0 -|QueryParameter|to|The ending page resource (inclusive). Valid values are :offset | "end"|false|string| -|=== - -==== Responses -[options="header"] -|=== -|HTTP Code|Description|Schema -|200|Successful operation|<<ViewPermissionResponse>> array -|=== - -==== Produces - -* text/plain - -==== Tags - -* Views - -=== Get single view permission ----- -GET /views/{viewName}/versions/{version}/permissions/{permissionId} ----- - -==== Description -:hardbreaks: -Returns permission details for a single version of a view. - -==== Parameters -[options="header"] -|=== -|Type|Name|Description|Required|Schema|Default -|PathParameter|viewName|view name|true|string| -|PathParameter|version|view version|true|string| -|PathParameter|permissionId|permission id|true|string| -|QueryParameter|fields|Filter view permission details|false|string|PermissionInfo -|=== - -==== Responses -[options="header"] -|=== -|HTTP Code|Description|Schema -|200|Successful operation|<<ViewPermissionResponse>> -|=== - -==== Produces - -* text/plain - -==== Tags - -* Views -