DEV-27807 Allow correct sorting by license status example (#91)

* docs: add example for sort by licenceType * docs: add example for sort desc by licenceType * docs: limit response to 4 items * docs: renamed user details * docs: changed example rewording * docs: remove extra example * docs: move changes to sort section Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com>
acrolinx · Nov 22, 2021 · 8d758a7 · 8d758a7
1 parent 38b22d6
commit 8d758a7
Showing 1 changed file with 157 additions and 0 deletions.
diff --git a/apiary.apib b/apiary.apib
@@ -1499,6 +1499,163 @@ The example response includes the pagination URLs in the `links` object so you k
                 ]
             }
 
++ Request Get a list of all users sorted by license type in ascending order (application/json)
+
+    + Headers
+
+            X-Acrolinx-Auth: your_access_token
+
++ Response 200 (application/json)
+
+    + Attributes (object)
+        + links (Pagination)
+        + data (array[User])
+
+    + Body
+
+            {
+                "links": {},
+                "data": [
+                    {
+                        "id": "5894f2bb-5b34-4874-bc40-ec64e9a4ca63",
+                        "username": "analyticsReadOnlyUser",
+                        "fullName": "",
+                        "createdOn": "2021-10-07T08:40:53.646Z",
+                        "activeTokenId": "",
+                        "lastIntegrationAccess": "1970-01-01T00:00:00Z",
+                        "licenseType": "builtin",
+                        "licenseStatus": "active",
+                        "checkingFrequency": "infrequent",
+                        "roles": [
+                            {
+                                "id": "898a7c32-2c39-4cde-becb-16f22243e9b8",
+                                "name": "Analytics Read-Only User",
+                                "default": false
+                            }
+                        ],
+                        "properties": {
+                            "Segmentation.xml.DTDs": ""
+                        },
+                        "customFields": [
+                            {
+                                "key": "Department",
+                                "displayName": "Department",
+                                "inputType": "optional",
+                                "type": "list",
+                                "value": "Example Department",
+                                "possibleValues": [
+                                    "Example Department"
+                                ]
+                            }
+                        ]
+                    },
+                    {
+                        "id": "c85030fd-2e03-4c69-9946-0b4f5689522c",
+                        "username": "termcontribution",
+                        "fullName": "",
+                        "createdOn": "2021-10-07T08:40:53.642Z",
+                        "activeTokenId": "",
+                        "lastIntegrationAccess": "1970-01-01T00:00:00Z",
+                        "licenseType": "builtin",
+                        "licenseStatus": "inactive",
+                        "checkingFrequency": "infrequent",
+                        "roles": [
+                            {
+                                "id": "d66d4d00-3381-11e0-bc8e-0800200c9a66",
+                                "name": "Term Contributor",
+                                "default": false
+                            }
+                        ],
+                        "properties": {
+                            "Segmentation.xml.DTDs": ""
+                        },
+                        "customFields": [
+                            {
+                                "key": "Department",
+                                "displayName": "Department",
+                                "inputType": "optional",
+                                "type": "list",
+                                "value": "Example Department",
+                                "possibleValues": [
+                                    "Example Department"
+                                ]
+                            }
+                        ]
+                    },
+                    {
+                        "id": "bb284474-e107-413e-9c15-d813ed7209e9",
+                        "username": "fred",
+                        "fullName": "Fred Freelancer",
+                        "createdOn": "2021-10-21T11:52:36.912Z",
+                        "activeTokenId": "touxmkywwmu5vk6nyqto2m75x6",
+                        "lastIntegrationAccess": "1970-01-01T00:00:00Z",
+                        "licenseType": "named",
+                        "licenseStatus": "active",
+                        "checkingFrequency": "infrequent",
+                        "roles": [
+                            {
+                                "id": "8c66c4e2-174a-4f77-b8d4-71bfa9ca4d2e",
+                                "name": "Author",
+                                "default": false
+                            },
+                            {
+                                "id": "bc5c91f3-fae1-49f7-8d60-d325077c6ef9",
+                                "name": "Super Administrator",
+                                "default": false
+                            }
+                        ],
+                        "properties": {
+                            "Segmentation.xml.DTDs": ""
+                        },
+                        "customFields": [
+                            {
+                                "key": "Department",
+                                "displayName": "Department",
+                                "inputType": "optional",
+                                "type": "list",
+                                "value": "C",
+                                "possibleValues": [
+                                    "Example Department"
+                                ]
+                            }
+                        ]
+                    },
+                    {
+                        "id": "0593c6b4-99d9-4d43-886b-f67cb66df7ed",
+                        "username": "franz",
+                        "fullName": "Franz Hubendobler",
+                        "createdOn": "2021-11-01T07:31:18.365Z",
+                        "activeTokenId": "",
+                        "lastIntegrationAccess": "1970-01-01T00:00:00Z",
+                        "licenseType": "named",
+                        "licenseStatus": "inactive",
+                        "checkingFrequency": "infrequent",
+                        "roles": [
+                            {
+                                "id": "8c66c4e2-174a-4f77-b8d4-71bfa9ca4d2e",
+                                "name": "Author",
+                                "default": false
+                            }
+                        ],
+                        "properties": {
+                            "Segmentation.xml.DTDs": ""
+                        },
+                        "customFields": [
+                            {
+                                "key": "Department",
+                                "displayName": "Department",
+                                "inputType": "optional",
+                                "type": "list",
+                                "value": "B",
+                                "possibleValues": [
+                                    "Example Department"
+                                ]
+                            }
+                        ]
+                    }
+                ]
+            }
+
 + Response 400 (application/json)
 
         // when the sort query parameter uses an invalid field name