-
Notifications
You must be signed in to change notification settings - Fork 17
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update for removed check for privilege escalation for creating a user and editing assigned roles #127
Merged
mrnyax
merged 13 commits into
acrolinx:develop
from
mrnyax:docs/DEV-34314-remove-check-for-privilege-escalation
Jul 4, 2023
Merged
Update for removed check for privilege escalation for creating a user and editing assigned roles #127
mrnyax
merged 13 commits into
acrolinx:develop
from
mrnyax:docs/DEV-34314-remove-check-for-privilege-escalation
Jul 4, 2023
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
In this case, the external authentication system is used to manage password change
Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>
Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>
Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>
…enabled' into develop
tkrisztian95
requested changes
Jul 4, 2023
hjohannsen
approved these changes
Jul 4, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fine with me!
tkrisztian95
approved these changes
Jul 4, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good.
…tion' into develop
hjohannsen
added a commit
that referenced
this pull request
Oct 18, 2023
* DEV-28485: add section on random password generation (#106) * docs: add section on random password generation * docs: bump core platform version to .03 * docs: end sentences with period in note * docs: change sub-group name to Random Passwords * docs: replace "comply with" by "meet" * docs: tweak sentence for convenient user creation * docs: update sentences to meet ux standard * docs: update 403 response comment * docs: update 503 response comment Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * DEV-29043 Custom Field API to get defined user custom fields (#111) * docs: add custom fields API to docs * docs: add note on privileges * docs: add response for missing/invalid token * docs: update CFs release version * docs: clean json response Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> * Extend documentation of CheckRequest.language (#112) Add documentation about what values to use for CheckRequest.language, extend description of the default. * Edits to custom fields API text (#113) * DEV-28754 Query users with missing required custom fields (#114) * docs: Add section ## Missing Required User Custom Fields + ### Count Users [HEAD /api/v1/user/custom-fields-missing] + ### Get Users [GET /api/v1/user/custom-fields-missing{?page,per_page}] * docs: Add comment see pagination details documented elsewhere * Update description Fix phrasing Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> * Update apiary.apib Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> * Update apiary.apib Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib UX writers edits Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib UX writers edits Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib UX writers edits Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib UX writers edits Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib UX writers edits Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib UX writers edits Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib UX writers edits Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: UX writers recommendation Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * DEV-29342: update pagination params error responses (#115) * style: replace char u+2019 with standard single quote apostrophe * docs: add error responses for invalid page param * docs: add error responses for invalid page param for custom-fields-missing api * docs: add section for health/status end point (#118) * docs: add section for health/status end point * docs: add description for health/status api path * docs: add Get Health Liveliness section * chore: add missing brace and format response codes * docs: ux string changes Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Add guidelineId to issues in examples (#120) Since 2022.10 Acrolinx returns a guidelineId for issues. This commit adds this field to the examples. * DEV-30375 change from optional -> recommended (#117) * Actualize main for 2021.12 rollout (#95) * Docs/dev 26614 change license type (#58) * docs: add section for update license type * docs: fix Response 400 section and indentations * docs: use "User" attribute object instead of "Role" * docs: add missing 200 response for roles request * docs: add privilege note only for license type change * docs: use enum for UserLicense * docs: add 409 response * docs: add 409 response for license contract change * style: white space formatting * docs: Add request to Postman collection Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> * Migrate Travis CI job to GitHub actions (#59) * chore: Remove travis.yml + But keep as old.travis.yml * feat: Add initial GitHub actions.yml + Name: Lint API Blueprint + Uses: node 12.x + Steps: npm run lint * chore: Add npm ci step to install deps * chore: Delete old.travis.yml * feat: Run only on push apiary.apib * chore: Added ending newline * Revert "feat: Run only on push apiary.apib" This reverts commit a1e5c991878d4b96064c698d2c21d2479881f4d5. Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> * docs/remove specific changes (#60) * docs: remove section * docs: apply changes to postman collection * Build preview from develop branch * Added info about pagination (#62) * docs: added docs for pagination parameters and how response changes * docs: added more details about pagination * added explanation of query parameters to the `Request` section * added example URLs to `links` object in `Response` section * added a note that the example response contains URLs for pagination * docs: add pagination data structure for links attribute * docs: added pagination parameters to request section Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> * DEV-26948 Add missing auth headers to requests (#64) * Add X-Acrolinx-Auth header to User API requests + Add '+ Requests' where missing * Add X-Acrolinx-Auth header to Role API requests + Add missing + Request block * Add X-Acrolinx-Auth header to Checking API requests * fix: URI parameters section parent should be a Resource or Action section + Fixng parameters or its description not showing up in some request cases * fix: Add parameters section to some Role API resources * fix: Move parameters out from request section + Fix parameter not showing up for request Get Link to Content Analysis Dashboard Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> * Develop to Main (#61) (#65) * docs/dev 26614 change license type (#58) * docs: add section for update license type * docs: fix Response 400 section and indentations * docs: use "User" attribute object instead of "Role" * docs: add missing 200 response for roles request * docs: add privilege note only for license type change * docs: use enum for UserLicense * docs: add 409 response * docs: add 409 response for license contract change * style: white space formatting * docs: Add request to Postman collection * Migrate Travis CI job to GitHub actions (#59) * chore: Remove travis.yml + But keep as old.travis.yml * feat: Add initial GitHub actions.yml + Name: Lint API Blueprint + Uses: node 12.x + Steps: npm run lint * chore: Add npm ci step to install deps * chore: Delete old.travis.yml * feat: Run only on push apiary.apib * chore: Added ending newline * Revert "feat: Run only on push apiary.apib" This reverts commit a1e5c991878d4b96064c698d2c21d2479881f4d5. * docs/remove specific changes (#60) * docs: remove section * docs: apply changes to postman collection * Build preview from develop branch Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com> * Ux writers edits (#66) * Develop to Main (#61) * docs/dev 26614 change license type (#58) * docs: add section for update license type * docs: fix Response 400 section and indentations * docs: use "User" attribute object instead of "Role" * docs: add missing 200 response for roles request * docs: add privilege note only for license type change * docs: use enum for UserLicense * docs: add 409 response * docs: add 409 response for license contract change * style: white space formatting * docs: Add request to Postman collection * Migrate Travis CI job to GitHub actions (#59) * chore: Remove travis.yml + But keep as old.travis.yml * feat: Add initial GitHub actions.yml + Name: Lint API Blueprint + Uses: node 12.x + Steps: npm run lint * chore: Add npm ci step to install deps * chore: Delete old.travis.yml * feat: Run only on push apiary.apib * chore: Added ending newline * Revert "feat: Run only on push apiary.apib" This reverts commit a1e5c991878d4b96064c698d2c21d2479881f4d5. * docs/remove specific changes (#60) * docs: remove section * docs: apply changes to postman collection * Build preview from develop branch * Added notes about authentication to user/role api * Update apiary.apib * docs: resolve minor typos * docs: remove datastructures url comment * Update apiary.apib * docs: remove duplicate /api/v1/user/self Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com> Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> * DEV-27221: User API pagination update (#67) * docs: add 400 response for per_page param and note on omitted links * docs: remove other draft api section * docs: add line to include headers for next/prev values * docs: add note on data source change during pagination call (#68) * docs: add note on data source change during pagination call * docs: sentence changes * UX writer edits to pagination draft (#69) * DEV-26981 Create user with custom field values (#70) * docs: Add Request Create a user with specified custom field values + Example response: Value not in Possible values error with status code 400 * fix: Linting issue * docs: Add error response example for unkown custom field speciefied on user create * fix: Correct a typo * Update apiary.apib Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> * fix: Omit empty privielges from User.roles[] response model (#73) Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> * DEV-27658: add functionality to sort by user custom fields (#77) * feat: Add custom key(customFields.{key}) as sortable parameter * fix: modify regex to allow sort with '.' * refactor: add note on how to use customFields.{key} * docs: add error response for invalid custom field value * docs: edit sort note * docs: rename comment * docs: edit error message * docs: add error response for null or empty custom field * docs: edit error message when custom field cannot be found * docs: add note about using custom fields to sort * docs: edit sort note * style: indentation fix Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> * devx: add build badge (#78) * docs: update regex (#83) * docs: update regex * docs: update sort API description Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> * DEV-27630 Document User API endpoint(s) for request user(s) to update custom field value (#86) * docs: Add section Request actualize Custom field values (single user) + Under the User Commands group + Example request and response * docs: Add some notes to the request + Mentioning the required privilege to perform the request * fix: Fix some typos * docs: Add the bulk request variant + Example request and success response * docs: Fix bulk response status codes after copy&paste * docs: Add example bulk request with invalid userids to showcase possible errors + Change in note to be gender neutral * fix: Linting issue * docs: Fix style issues * docs: User Information Update Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix description Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix request name Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix bulk request name Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix description in bulk Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix note in single request Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix bulk note about limitations Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix request naming Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Rename to Request User Information Update in Bulk * Update apiary.apib Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix error example should be singular * Update apiary.apib Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * DEV-27677 I can delete users in bulk (#87) * docs: add bulk delete API documentation * style: adjust indentation * style: adjust result indentation * docs: update result description * docs: cleanup documentation * docs: remove location field with null values * style: indentation adjustment * docs: lowercase for starting comments * docs: add documentation for bulk delete unknown/invalid user ids * docs: update null as bad request * docs: apply review suggestions * docs: add sample request with errors in response * docs: update description for API request * docs: moved comment to description section * docs: rename delete to deleted * docs: update sentence for request of users that cannot be deleted Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> * DEV-27807 Allow correct sorting by license status if the user has the license type Named user (#88) * docs: add note on sort by licenseType * docs: add fullstop * docs: note formatting Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> * DEV-27658: allowed special characters in custom field keys (#90) * docs: add note on allowed special chars for custom fields * docs: move special char text to a paragraph * Edits from docs team (#92) * Update apiary.apib * Update apiary.apib Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> * 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> * DEV-27658 Replace null custom field value with empty string (#93) * docs: add description when custom field has empty values Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> * term API doc: added referenced ACTIF sample file (#89) * term API doc: added referenced ACTIF sample file * term API doc: clarified "create entries" response * addressed Madeline's questions * apply Madeline's final suggestions for clarity/style Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * DEV-26980 Improve error response (#94) * docs: error message when creating user with more previleges than current user * docs: error message when you create/edit user with more previleges than you * docs: update error detail Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com> Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> Co-authored-by: mrnyax <nyakoria@gmail.com> Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: Robert Grabowski <robert.grabowski@acrolinx.com> * DEV-28485: add section on random password generation (#106) * docs: add section on random password generation * docs: bump core platform version to .03 * docs: end sentences with period in note * docs: change sub-group name to Random Passwords * docs: replace "comply with" by "meet" * docs: tweak sentence for convenient user creation * docs: update sentences to meet ux standard * docs: update 403 response comment * docs: update 503 response comment Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * DEV-29043 Custom Field API to get defined user custom fields (#111) * docs: add custom fields API to docs * docs: add note on privileges * docs: add response for missing/invalid token * docs: update CFs release version * docs: clean json response Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> * Extend documentation of CheckRequest.language (#112) Add documentation about what values to use for CheckRequest.language, extend description of the default. * Edits to custom fields API text (#113) * DEV-30375 change from ooptional -> recommended --------- Co-authored-by: Tóth Krisztián Gyula <t.krisztian95@gmail.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com> Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> Co-authored-by: mrnyax <nyakoria@gmail.com> Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: Robert Grabowski <robert.grabowski@acrolinx.com> Co-authored-by: replrep <32941710+replrep@users.noreply.github.com> * docs: remove duplicate section for random passwords api (#123) * Minor text improvements in the Acrolinx Platform API description (#125) Minor improvements in the Acrolinx Platform API description, fix broken links * docs: error response when external auth is enabled (#126) * docs: error response when external auth is enabled In this case, the external authentication system is used to manage password change * style: fix semantic issues * edit error message Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * edit error message Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * edit doc comment Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> --------- Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> Co-authored-by: Tóth Krisztián Gyula <ktothdev@gmail.com> * Update for removed check for privilege escalation for creating a user and editing assigned roles (#127) * docs: error response when external auth is enabled In this case, the external authentication system is used to manage password change * style: fix semantic issues * edit error message Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * edit error message Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * edit doc comment Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * doc: adjust error message for removed privilege escalation * doc: move response to appropriate area * doc: update description * doc: delete error response * refactor: group status response --------- Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Get all users include/exclude nested data (#132) * docs: Get all users include/exclude nested data * Update apiary.apib Co-authored-by: mrnyax <nyakoria@gmail.com> * Update apiary.apib Co-authored-by: mrnyax <nyakoria@gmail.com> * style: Simplify * Update apiary.apib Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> --------- Co-authored-by: mrnyax <nyakoria@gmail.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Remove note about valid access token needed (#136) + In context this should be clear its neccessarry for the action * Fix three minor typos on line 261. (#137) * Resolve conflicts with main (#138) * Actualize main for 2021.12 rollout (#95) * Docs/dev 26614 change license type (#58) * docs: add section for update license type * docs: fix Response 400 section and indentations * docs: use "User" attribute object instead of "Role" * docs: add missing 200 response for roles request * docs: add privilege note only for license type change * docs: use enum for UserLicense * docs: add 409 response * docs: add 409 response for license contract change * style: white space formatting * docs: Add request to Postman collection Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> * Migrate Travis CI job to GitHub actions (#59) * chore: Remove travis.yml + But keep as old.travis.yml * feat: Add initial GitHub actions.yml + Name: Lint API Blueprint + Uses: node 12.x + Steps: npm run lint * chore: Add npm ci step to install deps * chore: Delete old.travis.yml * feat: Run only on push apiary.apib * chore: Added ending newline * Revert "feat: Run only on push apiary.apib" This reverts commit a1e5c991878d4b96064c698d2c21d2479881f4d5. Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> * docs/remove specific changes (#60) * docs: remove section * docs: apply changes to postman collection * Build preview from develop branch * Added info about pagination (#62) * docs: added docs for pagination parameters and how response changes * docs: added more details about pagination * added explanation of query parameters to the `Request` section * added example URLs to `links` object in `Response` section * added a note that the example response contains URLs for pagination * docs: add pagination data structure for links attribute * docs: added pagination parameters to request section Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> * DEV-26948 Add missing auth headers to requests (#64) * Add X-Acrolinx-Auth header to User API requests + Add '+ Requests' where missing * Add X-Acrolinx-Auth header to Role API requests + Add missing + Request block * Add X-Acrolinx-Auth header to Checking API requests * fix: URI parameters section parent should be a Resource or Action section + Fixng parameters or its description not showing up in some request cases * fix: Add parameters section to some Role API resources * fix: Move parameters out from request section + Fix parameter not showing up for request Get Link to Content Analysis Dashboard Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> * Develop to Main (#61) (#65) * docs/dev 26614 change license type (#58) * docs: add section for update license type * docs: fix Response 400 section and indentations * docs: use "User" attribute object instead of "Role" * docs: add missing 200 response for roles request * docs: add privilege note only for license type change * docs: use enum for UserLicense * docs: add 409 response * docs: add 409 response for license contract change * style: white space formatting * docs: Add request to Postman collection * Migrate Travis CI job to GitHub actions (#59) * chore: Remove travis.yml + But keep as old.travis.yml * feat: Add initial GitHub actions.yml + Name: Lint API Blueprint + Uses: node 12.x + Steps: npm run lint * chore: Add npm ci step to install deps * chore: Delete old.travis.yml * feat: Run only on push apiary.apib * chore: Added ending newline * Revert "feat: Run only on push apiary.apib" This reverts commit a1e5c991878d4b96064c698d2c21d2479881f4d5. * docs/remove specific changes (#60) * docs: remove section * docs: apply changes to postman collection * Build preview from develop branch Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com> * Ux writers edits (#66) * Develop to Main (#61) * docs/dev 26614 change license type (#58) * docs: add section for update license type * docs: fix Response 400 section and indentations * docs: use "User" attribute object instead of "Role" * docs: add missing 200 response for roles request * docs: add privilege note only for license type change * docs: use enum for UserLicense * docs: add 409 response * docs: add 409 response for license contract change * style: white space formatting * docs: Add request to Postman collection * Migrate Travis CI job to GitHub actions (#59) * chore: Remove travis.yml + But keep as old.travis.yml * feat: Add initial GitHub actions.yml + Name: Lint API Blueprint + Uses: node 12.x + Steps: npm run lint * chore: Add npm ci step to install deps * chore: Delete old.travis.yml * feat: Run only on push apiary.apib * chore: Added ending newline * Revert "feat: Run only on push apiary.apib" This reverts commit a1e5c991878d4b96064c698d2c21d2479881f4d5. * docs/remove specific changes (#60) * docs: remove section * docs: apply changes to postman collection * Build preview from develop branch * Added notes about authentication to user/role api * Update apiary.apib * docs: resolve minor typos * docs: remove datastructures url comment * Update apiary.apib * docs: remove duplicate /api/v1/user/self Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com> Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> * DEV-27221: User API pagination update (#67) * docs: add 400 response for per_page param and note on omitted links * docs: remove other draft api section * docs: add line to include headers for next/prev values * docs: add note on data source change during pagination call (#68) * docs: add note on data source change during pagination call * docs: sentence changes * UX writer edits to pagination draft (#69) * DEV-26981 Create user with custom field values (#70) * docs: Add Request Create a user with specified custom field values + Example response: Value not in Possible values error with status code 400 * fix: Linting issue * docs: Add error response example for unkown custom field speciefied on user create * fix: Correct a typo * Update apiary.apib Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> * fix: Omit empty privielges from User.roles[] response model (#73) Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> * DEV-27658: add functionality to sort by user custom fields (#77) * feat: Add custom key(customFields.{key}) as sortable parameter * fix: modify regex to allow sort with '.' * refactor: add note on how to use customFields.{key} * docs: add error response for invalid custom field value * docs: edit sort note * docs: rename comment * docs: edit error message * docs: add error response for null or empty custom field * docs: edit error message when custom field cannot be found * docs: add note about using custom fields to sort * docs: edit sort note * style: indentation fix Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> * devx: add build badge (#78) * docs: update regex (#83) * docs: update regex * docs: update sort API description Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> * DEV-27630 Document User API endpoint(s) for request user(s) to update custom field value (#86) * docs: Add section Request actualize Custom field values (single user) + Under the User Commands group + Example request and response * docs: Add some notes to the request + Mentioning the required privilege to perform the request * fix: Fix some typos * docs: Add the bulk request variant + Example request and success response * docs: Fix bulk response status codes after copy&paste * docs: Add example bulk request with invalid userids to showcase possible errors + Change in note to be gender neutral * fix: Linting issue * docs: Fix style issues * docs: User Information Update Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix description Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix request name Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix bulk request name Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix description in bulk Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix note in single request Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix bulk note about limitations Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix request naming Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Rename to Request User Information Update in Bulk * Update apiary.apib Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix error example should be singular * Update apiary.apib Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * DEV-27677 I can delete users in bulk (#87) * docs: add bulk delete API documentation * style: adjust indentation * style: adjust result indentation * docs: update result description * docs: cleanup documentation * docs: remove location field with null values * style: indentation adjustment * docs: lowercase for starting comments * docs: add documentation for bulk delete unknown/invalid user ids * docs: update null as bad request * docs: apply review suggestions * docs: add sample request with errors in response * docs: update description for API request * docs: moved comment to description section * docs: rename delete to deleted * docs: update sentence for request of users that cannot be deleted Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> * DEV-27807 Allow correct sorting by license status if the user has the license type Named user (#88) * docs: add note on sort by licenseType * docs: add fullstop * docs: note formatting Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> * DEV-27658: allowed special characters in custom field keys (#90) * docs: add note on allowed special chars for custom fields * docs: move special char text to a paragraph * Edits from docs team (#92) * Update apiary.apib * Update apiary.apib Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> * 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> * DEV-27658 Replace null custom field value with empty string (#93) * docs: add description when custom field has empty values Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> * term API doc: added referenced ACTIF sample file (#89) * term API doc: added referenced ACTIF sample file * term API doc: clarified "create entries" response * addressed Madeline's questions * apply Madeline's final suggestions for clarity/style Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * DEV-26980 Improve error response (#94) * docs: error message when creating user with more previleges than current user * docs: error message when you create/edit user with more previleges than you * docs: update error detail Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com> Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> Co-authored-by: mrnyax <nyakoria@gmail.com> Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: Robert Grabowski <robert.grabowski@acrolinx.com> * DEV-28485: add section on random password generation (#106) * docs: add section on random password generation * docs: bump core platform version to .03 * docs: end sentences with period in note * docs: change sub-group name to Random Passwords * docs: replace "comply with" by "meet" * docs: tweak sentence for convenient user creation * docs: update sentences to meet ux standard * docs: update 403 response comment * docs: update 503 response comment Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * DEV-29043 Custom Field API to get defined user custom fields (#111) * docs: add custom fields API to docs * docs: add note on privileges * docs: add response for missing/invalid token * docs: update CFs release version * docs: clean json response Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> * Extend documentation of CheckRequest.language (#112) Add documentation about what values to use for CheckRequest.language, extend description of the default. * Edits to custom fields API text (#113) * DEV-30814 Removing unused value * Develop (#122) * DEV-28485: add section on random password generation (#106) * docs: add section on random password generation * docs: bump core platform version to .03 * docs: end sentences with period in note * docs: change sub-group name to Random Passwords * docs: replace "comply with" by "meet" * docs: tweak sentence for convenient user creation * docs: update sentences to meet ux standard * docs: update 403 response comment * docs: update 503 response comment Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * DEV-29043 Custom Field API to get defined user custom fields (#111) * docs: add custom fields API to docs * docs: add note on privileges * docs: add response for missing/invalid token * docs: update CFs release version * docs: clean json response Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> * Extend documentation of CheckRequest.language (#112) Add documentation about what values to use for CheckRequest.language, extend description of the default. * Edits to custom fields API text (#113) * DEV-28754 Query users with missing required custom fields (#114) * docs: Add section ## Missing Required User Custom Fields + ### Count Users [HEAD /api/v1/user/custom-fields-missing] + ### Get Users [GET /api/v1/user/custom-fields-missing{?page,per_page}] * docs: Add comment see pagination details documented elsewhere * Update description Fix phrasing Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> * Update apiary.apib Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> * Update apiary.apib Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib UX writers edits Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib UX writers edits Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib UX writers edits Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib UX writers edits Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib UX writers edits Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib UX writers edits Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib UX writers edits Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: UX writers recommendation Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * DEV-29342: update pagination params error responses (#115) * style: replace char u+2019 with standard single quote apostrophe * docs: add error responses for invalid page param * docs: add error responses for invalid page param for custom-fields-missing api * docs: add section for health/status end point (#118) * docs: add section for health/status end point * docs: add description for health/status api path * docs: add Get Health Liveliness section * chore: add missing brace and format response codes * docs: ux string changes Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Add guidelineId to issues in examples (#120) Since 2022.10 Acrolinx returns a guidelineId for issues. This commit adds this field to the examples. * DEV-30375 change from optional -> recommended (#117) * Actualize main for 2021.12 rollout (#95) * Docs/dev 26614 change license type (#58) * docs: add section for update license type * docs: fix Response 400 section and indentations * docs: use "User" attribute object instead of "Role" * docs: add missing 200 response for roles request * docs: add privilege note only for license type change * docs: use enum for UserLicense * docs: add 409 response * docs: add 409 response for license contract change * style: white space formatting * docs: Add request to Postman collection Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> * Migrate Travis CI job to GitHub actions (#59) * chore: Remove travis.yml + But keep as old.travis.yml * feat: Add initial GitHub actions.yml + Name: Lint API Blueprint + Uses: node 12.x + Steps: npm run lint * chore: Add npm ci step to install deps * chore: Delete old.travis.yml * feat: Run only on push apiary.apib * chore: Added ending newline * Revert "feat: Run only on push apiary.apib" This reverts commit a1e5c991878d4b96064c698d2c21d2479881f4d5. Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> * docs/remove specific changes (#60) * docs: remove section * docs: apply changes to postman collection * Build preview from develop branch * Added info about pagination (#62) * docs: added docs for pagination parameters and how response changes * docs: added more details about pagination * added explanation of query parameters to the `Request` section * added example URLs to `links` object in `Response` section * added a note that the example response contains URLs for pagination * docs: add pagination data structure for links attribute * docs: added pagination parameters to request section Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> * DEV-26948 Add missing auth headers to requests (#64) * Add X-Acrolinx-Auth header to User API requests + Add '+ Requests' where missing * Add X-Acrolinx-Auth header to Role API requests + Add missing + Request block * Add X-Acrolinx-Auth header to Checking API requests * fix: URI parameters section parent should be a Resource or Action section + Fixng parameters or its description not showing up in some request cases * fix: Add parameters section to some Role API resources * fix: Move parameters out from request section + Fix parameter not showing up for request Get Link to Content Analysis Dashboard Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> * Develop to Main (#61) (#65) * docs/dev 26614 change license type (#58) * docs: add section for update license type * docs: fix Response 400 section and indentations * docs: use "User" attribute object instead of "Role" * docs: add missing 200 response for roles request * docs: add privilege note only for license type change * docs: use enum for UserLicense * docs: add 409 response * docs: add 409 response for license contract change * style: white space formatting * docs: Add request to Postman collection * Migrate Travis CI job to GitHub actions (#59) * chore: Remove travis.yml + But keep as old.travis.yml * feat: Add initial GitHub actions.yml + Name: Lint API Blueprint + Uses: node 12.x + Steps: npm run lint * chore: Add npm ci step to install deps * chore: Delete old.travis.yml * feat: Run only on push apiary.apib * chore: Added ending newline * Revert "feat: Run only on push apiary.apib" This reverts commit a1e5c991878d4b96064c698d2c21d2479881f4d5. * docs/remove specific changes (#60) * docs: remove section * docs: apply changes to postman collection * Build preview from develop branch Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com> * Ux writers edits (#66) * Develop to Main (#61) * docs/dev 26614 change license type (#58) * docs: add section for update license type * docs: fix Response 400 section and indentations * docs: use "User" attribute object instead of "Role" * docs: add missing 200 response for roles request * docs: add privilege note only for license type change * docs: use enum for UserLicense * docs: add 409 response * docs: add 409 response for license contract change * style: white space formatting * docs: Add request to Postman collection * Migrate Travis CI job to GitHub actions (#59) * chore: Remove travis.yml + But keep as old.travis.yml * feat: Add initial GitHub actions.yml + Name: Lint API Blueprint + Uses: node 12.x + Steps: npm run lint * chore: Add npm ci step to install deps * chore: Delete old.travis.yml * feat: Run only on push apiary.apib * chore: Added ending newline * Revert "feat: Run only on push apiary.apib" This reverts commit a1e5c991878d4b96064c698d2c21d2479881f4d5. * docs/remove specific changes (#60) * docs: remove section * docs: apply changes to postman collection * Build preview from develop branch * Added notes about authentication to user/role api * Update apiary.apib * docs: resolve minor typos * docs: remove datastructures url comment * Update apiary.apib * docs: remove duplicate /api/v1/user/self Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com> Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> * DEV-27221: User API pagination update (#67) * docs: add 400 response for per_page param and note on omitted links * docs: remove other draft api section * docs: add line to include headers for next/prev values * docs: add note on data source change during pagination call (#68) * docs: add note on data source change during pagination call * docs: sentence changes * UX writer edits to pagination draft (#69) * DEV-26981 Create user with custom field values (#70) * docs: Add Request Create a user with specified custom field values + Example response: Value not in Possible values error with status code 400 * fix: Linting issue * docs: Add error response example for unkown custom field speciefied on user create * fix: Correct a typo * Update apiary.apib Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> * fix: Omit empty privielges from User.roles[] response model (#73) Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> * DEV-27658: add functionality to sort by user custom fields (#77) * feat: Add custom key(customFields.{key}) as sortable parameter * fix: modify regex to allow sort with '.' * refactor: add note on how to use customFields.{key} * docs: add error response for invalid custom field value * docs: edit sort note * docs: rename comment * docs: edit error message * docs: add error response for null or empty custom field * docs: edit error message when custom field cannot be found * docs: add note about using custom fields to sort * docs: edit sort note * style: indentation fix Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> * devx: add build badge (#78) * docs: update regex (#83) * docs: update regex * docs: update sort API description Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> * DEV-27630 Document User API endpoint(s) for request user(s) to update custom field value (#86) * docs: Add section Request actualize Custom field values (single user) + Under the User Commands group + Example request and response * docs: Add some notes to the request + Mentioning the required privilege to perform the request * fix: Fix some typos * docs: Add the bulk request variant + Example request and success response * docs: Fix bulk response status codes after copy&paste * docs: Add example bulk request with invalid userids to showcase possible errors + Change in note to be gender neutral * fix: Linting issue * docs: Fix style issues * docs: User Information Update Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix description Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix request name Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix bulk request name Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix description in bulk Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix note in single request Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix bulk note about limitations Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix request naming Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Rename to Request User Information Update in Bulk * Update apiary.apib Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix error example should be singular * Update apiary.apib Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * DEV-27677 I can delete users in bulk (#87) * docs: add bulk delete API documentation * style: adjust indentation * style: adjust result indentation * docs: update result description * docs: cleanup documentation * docs: remove location field with null values * style: indentation adjustment * docs: lowercase for starting comments * docs: add documentation for bulk delete unknown/invalid user ids * docs: update null as bad request * docs: apply review suggestions * docs: add sample request with errors in response * docs: update description for API request * docs: moved comment to description section * docs: rename delete to deleted * docs: update sentence for request of users that cannot be deleted Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> * DEV-27807 Allow correct sorting by license status if the user has the license type Named user (#88) * docs: add note on sort by licenseType * docs: add fullstop * docs: note formatting Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> * DEV-27658: allowed special characters in custom field keys (#90) * docs: add note on allowed special chars for custom fields * docs: move special char text to a paragraph * Edits from docs team (#92) * Update apiary.apib * Update apiary.apib Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> * 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> * DEV-27658 Replace null custom field value with empty string (#93) * docs: add description when custom field has empty values Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> * term API doc: added referenced ACTIF sample file (#89) * term API doc: added referenced ACTIF sample file * term API doc: clarified "create entries" response * addressed Madeline's questions * apply Madeline's final suggestions for clarity/style Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * DEV-26980 Improve error response (#94) * docs: error message when creating user with more previleges than current user * docs: error message when you create/edit user with more previleges than you * docs: update error detail Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com> Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> Co-authored-by: mrnyax <nyakoria@gmail.com> Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: Robert Grabowski <robert.grabowski@acrolinx.com> * DEV-28485: add section on random password generation (#106) * docs: add section on random password generation * docs: bump core platform version to .03 * docs: end sentences with period in note * docs: change sub-group name to Random Passwords * docs: replace "comply with" by "meet" * docs: tweak sentence for convenient user creation * docs: update sentences to meet ux standard * docs: update 403 response comment * docs: update 503 response comment Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * DEV-29043 Custom Field API to get defined user custom fields (#111) * docs: add custom fields API to docs * docs: add note on privileges * docs: add response for missing/invalid token * docs: update CFs release version * docs: clean json response Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> * Extend documentation of CheckRequest.language (#112) Add documentation about what values to use for CheckRequest.language, extend description of the default. * Edits to custom fields API text (#113) * DEV-30375 change from ooptional -> recommended --------- Co-authored-by: Tóth Krisztián Gyula <t.krisztian95@gmail.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com> Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> Co-authored-by: mrnyax <nyakoria@gmail.com> Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: Robert Grabowski <robert.grabowski@acrolinx.com> Co-authored-by: replrep <32941710+replrep@users.noreply.github.com> * docs: remove duplicate section for random passwords api (#123) --------- Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> Co-authored-by: mrnyax <nyakoria@gmail.com> Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: replrep <32941710+replrep@users.noreply.github.com> Co-authored-by: Tóth Krisztián Gyula <t.krisztian95@gmail.com> Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: Alexander Kauer <alexander.kauer@acrolinx.com> Co-authored-by: Abhijeet Narvekar <abhijeet7222@gmail.com> Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com> Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> Co-authored-by: Robert Grabowski <robert.grabowski@acrolinx.com> * fix: Remove duplicate of Random Passwords (#124) * fix: Remove duplicate of ## Random Passwords * fix: Delete leftover part * fix: Locales is an array (#128) * fix: Remove contetn type for Response 204 (#129) * fix: Remove extra bracket (#130) * fix: Use array with fixed type CustomField (#131) --------- Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com> Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> Co-authored-by: mrnyax <nyakoria@gmail.com> Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: Robert Grabowski <robert.grabowski@acrolinx.com> Co-authored-by: replrep <32941710+replrep@users.noreply.github.com> Co-authored-by: Paresh Deshmukh <paresh.deshmukh@acrolinx.com> Co-authored-by: hjohannsen <39583180+hjohannsen@users.noreply.github.com> Co-authored-by: Alexander Kauer <alexander.kauer@acrolinx.com> Co-authored-by: Abhijeet Narvekar <abhijeet7222@gmail.com> --------- Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> Co-authored-by: mrnyax <nyakoria@gmail.com> Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: replrep <32941710+replrep@users.noreply.github.com> Co-authored-by: Tóth Krisztián Gyula <t.krisztian95@gmail.com> Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: Alexander Kauer <alexander.kauer@acrolinx.com> Co-authored-by: Abhijeet Narvekar <abhijeet7222@gmail.com> Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com> Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> Co-authored-by: Robert Grabowski <robert.grabowski@acrolinx.com> Co-authored-by: Thilo-Acrolinx <125662076+Thilo-Acrolinx@users.noreply.github.com> Co-authored-by: Tóth Krisztián Gyula <ktothdev@gmail.com> Co-authored-by: Paresh Deshmukh <paresh.deshmukh@acrolinx.com>
rbarbey
added a commit
that referenced
this pull request
Oct 18, 2023
* DEV-28485: add section on random password generation (#106) * docs: add section on random password generation * docs: bump core platform version to .03 * docs: end sentences with period in note * docs: change sub-group name to Random Passwords * docs: replace "comply with" by "meet" * docs: tweak sentence for convenient user creation * docs: update sentences to meet ux standard * docs: update 403 response comment * docs: update 503 response comment Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * DEV-29043 Custom Field API to get defined user custom fields (#111) * docs: add custom fields API to docs * docs: add note on privileges * docs: add response for missing/invalid token * docs: update CFs release version * docs: clean json response Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> * Extend documentation of CheckRequest.language (#112) Add documentation about what values to use for CheckRequest.language, extend description of the default. * Edits to custom fields API text (#113) * DEV-28754 Query users with missing required custom fields (#114) * docs: Add section ## Missing Required User Custom Fields + ### Count Users [HEAD /api/v1/user/custom-fields-missing] + ### Get Users [GET /api/v1/user/custom-fields-missing{?page,per_page}] * docs: Add comment see pagination details documented elsewhere * Update description Fix phrasing Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> * Update apiary.apib Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> * Update apiary.apib Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib UX writers edits Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib UX writers edits Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib UX writers edits Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib UX writers edits Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib UX writers edits Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib UX writers edits Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib UX writers edits Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: UX writers recommendation Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * DEV-29342: update pagination params error responses (#115) * style: replace char u+2019 with standard single quote apostrophe * docs: add error responses for invalid page param * docs: add error responses for invalid page param for custom-fields-missing api * docs: add section for health/status end point (#118) * docs: add section for health/status end point * docs: add description for health/status api path * docs: add Get Health Liveliness section * chore: add missing brace and format response codes * docs: ux string changes Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Add guidelineId to issues in examples (#120) Since 2022.10 Acrolinx returns a guidelineId for issues. This commit adds this field to the examples. * DEV-30375 change from optional -> recommended (#117) * Actualize main for 2021.12 rollout (#95) * Docs/dev 26614 change license type (#58) * docs: add section for update license type * docs: fix Response 400 section and indentations * docs: use "User" attribute object instead of "Role" * docs: add missing 200 response for roles request * docs: add privilege note only for license type change * docs: use enum for UserLicense * docs: add 409 response * docs: add 409 response for license contract change * style: white space formatting * docs: Add request to Postman collection Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> * Migrate Travis CI job to GitHub actions (#59) * chore: Remove travis.yml + But keep as old.travis.yml * feat: Add initial GitHub actions.yml + Name: Lint API Blueprint + Uses: node 12.x + Steps: npm run lint * chore: Add npm ci step to install deps * chore: Delete old.travis.yml * feat: Run only on push apiary.apib * chore: Added ending newline * Revert "feat: Run only on push apiary.apib" This reverts commit a1e5c991878d4b96064c698d2c21d2479881f4d5. Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> * docs/remove specific changes (#60) * docs: remove section * docs: apply changes to postman collection * Build preview from develop branch * Added info about pagination (#62) * docs: added docs for pagination parameters and how response changes * docs: added more details about pagination * added explanation of query parameters to the `Request` section * added example URLs to `links` object in `Response` section * added a note that the example response contains URLs for pagination * docs: add pagination data structure for links attribute * docs: added pagination parameters to request section Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> * DEV-26948 Add missing auth headers to requests (#64) * Add X-Acrolinx-Auth header to User API requests + Add '+ Requests' where missing * Add X-Acrolinx-Auth header to Role API requests + Add missing + Request block * Add X-Acrolinx-Auth header to Checking API requests * fix: URI parameters section parent should be a Resource or Action section + Fixng parameters or its description not showing up in some request cases * fix: Add parameters section to some Role API resources * fix: Move parameters out from request section + Fix parameter not showing up for request Get Link to Content Analysis Dashboard Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> * Develop to Main (#61) (#65) * docs/dev 26614 change license type (#58) * docs: add section for update license type * docs: fix Response 400 section and indentations * docs: use "User" attribute object instead of "Role" * docs: add missing 200 response for roles request * docs: add privilege note only for license type change * docs: use enum for UserLicense * docs: add 409 response * docs: add 409 response for license contract change * style: white space formatting * docs: Add request to Postman collection * Migrate Travis CI job to GitHub actions (#59) * chore: Remove travis.yml + But keep as old.travis.yml * feat: Add initial GitHub actions.yml + Name: Lint API Blueprint + Uses: node 12.x + Steps: npm run lint * chore: Add npm ci step to install deps * chore: Delete old.travis.yml * feat: Run only on push apiary.apib * chore: Added ending newline * Revert "feat: Run only on push apiary.apib" This reverts commit a1e5c991878d4b96064c698d2c21d2479881f4d5. * docs/remove specific changes (#60) * docs: remove section * docs: apply changes to postman collection * Build preview from develop branch Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com> * Ux writers edits (#66) * Develop to Main (#61) * docs/dev 26614 change license type (#58) * docs: add section for update license type * docs: fix Response 400 section and indentations * docs: use "User" attribute object instead of "Role" * docs: add missing 200 response for roles request * docs: add privilege note only for license type change * docs: use enum for UserLicense * docs: add 409 response * docs: add 409 response for license contract change * style: white space formatting * docs: Add request to Postman collection * Migrate Travis CI job to GitHub actions (#59) * chore: Remove travis.yml + But keep as old.travis.yml * feat: Add initial GitHub actions.yml + Name: Lint API Blueprint + Uses: node 12.x + Steps: npm run lint * chore: Add npm ci step to install deps * chore: Delete old.travis.yml * feat: Run only on push apiary.apib * chore: Added ending newline * Revert "feat: Run only on push apiary.apib" This reverts commit a1e5c991878d4b96064c698d2c21d2479881f4d5. * docs/remove specific changes (#60) * docs: remove section * docs: apply changes to postman collection * Build preview from develop branch * Added notes about authentication to user/role api * Update apiary.apib * docs: resolve minor typos * docs: remove datastructures url comment * Update apiary.apib * docs: remove duplicate /api/v1/user/self Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com> Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> * DEV-27221: User API pagination update (#67) * docs: add 400 response for per_page param and note on omitted links * docs: remove other draft api section * docs: add line to include headers for next/prev values * docs: add note on data source change during pagination call (#68) * docs: add note on data source change during pagination call * docs: sentence changes * UX writer edits to pagination draft (#69) * DEV-26981 Create user with custom field values (#70) * docs: Add Request Create a user with specified custom field values + Example response: Value not in Possible values error with status code 400 * fix: Linting issue * docs: Add error response example for unkown custom field speciefied on user create * fix: Correct a typo * Update apiary.apib Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> * fix: Omit empty privielges from User.roles[] response model (#73) Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> * DEV-27658: add functionality to sort by user custom fields (#77) * feat: Add custom key(customFields.{key}) as sortable parameter * fix: modify regex to allow sort with '.' * refactor: add note on how to use customFields.{key} * docs: add error response for invalid custom field value * docs: edit sort note * docs: rename comment * docs: edit error message * docs: add error response for null or empty custom field * docs: edit error message when custom field cannot be found * docs: add note about using custom fields to sort * docs: edit sort note * style: indentation fix Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> * devx: add build badge (#78) * docs: update regex (#83) * docs: update regex * docs: update sort API description Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> * DEV-27630 Document User API endpoint(s) for request user(s) to update custom field value (#86) * docs: Add section Request actualize Custom field values (single user) + Under the User Commands group + Example request and response * docs: Add some notes to the request + Mentioning the required privilege to perform the request * fix: Fix some typos * docs: Add the bulk request variant + Example request and success response * docs: Fix bulk response status codes after copy&paste * docs: Add example bulk request with invalid userids to showcase possible errors + Change in note to be gender neutral * fix: Linting issue * docs: Fix style issues * docs: User Information Update Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix description Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix request name Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix bulk request name Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix description in bulk Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix note in single request Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix bulk note about limitations Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix request naming Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Rename to Request User Information Update in Bulk * Update apiary.apib Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix error example should be singular * Update apiary.apib Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * DEV-27677 I can delete users in bulk (#87) * docs: add bulk delete API documentation * style: adjust indentation * style: adjust result indentation * docs: update result description * docs: cleanup documentation * docs: remove location field with null values * style: indentation adjustment * docs: lowercase for starting comments * docs: add documentation for bulk delete unknown/invalid user ids * docs: update null as bad request * docs: apply review suggestions * docs: add sample request with errors in response * docs: update description for API request * docs: moved comment to description section * docs: rename delete to deleted * docs: update sentence for request of users that cannot be deleted Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> * DEV-27807 Allow correct sorting by license status if the user has the license type Named user (#88) * docs: add note on sort by licenseType * docs: add fullstop * docs: note formatting Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> * DEV-27658: allowed special characters in custom field keys (#90) * docs: add note on allowed special chars for custom fields * docs: move special char text to a paragraph * Edits from docs team (#92) * Update apiary.apib * Update apiary.apib Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> * 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> * DEV-27658 Replace null custom field value with empty string (#93) * docs: add description when custom field has empty values Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> * term API doc: added referenced ACTIF sample file (#89) * term API doc: added referenced ACTIF sample file * term API doc: clarified "create entries" response * addressed Madeline's questions * apply Madeline's final suggestions for clarity/style Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * DEV-26980 Improve error response (#94) * docs: error message when creating user with more previleges than current user * docs: error message when you create/edit user with more previleges than you * docs: update error detail Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com> Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> Co-authored-by: mrnyax <nyakoria@gmail.com> Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: Robert Grabowski <robert.grabowski@acrolinx.com> * DEV-28485: add section on random password generation (#106) * docs: add section on random password generation * docs: bump core platform version to .03 * docs: end sentences with period in note * docs: change sub-group name to Random Passwords * docs: replace "comply with" by "meet" * docs: tweak sentence for convenient user creation * docs: update sentences to meet ux standard * docs: update 403 response comment * docs: update 503 response comment Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * DEV-29043 Custom Field API to get defined user custom fields (#111) * docs: add custom fields API to docs * docs: add note on privileges * docs: add response for missing/invalid token * docs: update CFs release version * docs: clean json response Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> * Extend documentation of CheckRequest.language (#112) Add documentation about what values to use for CheckRequest.language, extend description of the default. * Edits to custom fields API text (#113) * DEV-30375 change from ooptional -> recommended --------- Co-authored-by: Tóth Krisztián Gyula <t.krisztian95@gmail.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com> Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> Co-authored-by: mrnyax <nyakoria@gmail.com> Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: Robert Grabowski <robert.grabowski@acrolinx.com> Co-authored-by: replrep <32941710+replrep@users.noreply.github.com> * docs: remove duplicate section for random passwords api (#123) * Minor text improvements in the Acrolinx Platform API description (#125) Minor improvements in the Acrolinx Platform API description, fix broken links * docs: error response when external auth is enabled (#126) * docs: error response when external auth is enabled In this case, the external authentication system is used to manage password change * style: fix semantic issues * edit error message Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * edit error message Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * edit doc comment Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> --------- Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> Co-authored-by: Tóth Krisztián Gyula <ktothdev@gmail.com> * Update for removed check for privilege escalation for creating a user and editing assigned roles (#127) * docs: error response when external auth is enabled In this case, the external authentication system is used to manage password change * style: fix semantic issues * edit error message Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * edit error message Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * edit doc comment Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * doc: adjust error message for removed privilege escalation * doc: move response to appropriate area * doc: update description * doc: delete error response * refactor: group status response --------- Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Get all users include/exclude nested data (#132) * docs: Get all users include/exclude nested data * Update apiary.apib Co-authored-by: mrnyax <nyakoria@gmail.com> * Update apiary.apib Co-authored-by: mrnyax <nyakoria@gmail.com> * style: Simplify * Update apiary.apib Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> --------- Co-authored-by: mrnyax <nyakoria@gmail.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Remove note about valid access token needed (#136) + In context this should be clear its neccessarry for the action * Fix three minor typos on line 261. (#137) * Resolve conflicts with main (#138) * Actualize main for 2021.12 rollout (#95) * Docs/dev 26614 change license type (#58) * docs: add section for update license type * docs: fix Response 400 section and indentations * docs: use "User" attribute object instead of "Role" * docs: add missing 200 response for roles request * docs: add privilege note only for license type change * docs: use enum for UserLicense * docs: add 409 response * docs: add 409 response for license contract change * style: white space formatting * docs: Add request to Postman collection Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> * Migrate Travis CI job to GitHub actions (#59) * chore: Remove travis.yml + But keep as old.travis.yml * feat: Add initial GitHub actions.yml + Name: Lint API Blueprint + Uses: node 12.x + Steps: npm run lint * chore: Add npm ci step to install deps * chore: Delete old.travis.yml * feat: Run only on push apiary.apib * chore: Added ending newline * Revert "feat: Run only on push apiary.apib" This reverts commit a1e5c991878d4b96064c698d2c21d2479881f4d5. Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> * docs/remove specific changes (#60) * docs: remove section * docs: apply changes to postman collection * Build preview from develop branch * Added info about pagination (#62) * docs: added docs for pagination parameters and how response changes * docs: added more details about pagination * added explanation of query parameters to the `Request` section * added example URLs to `links` object in `Response` section * added a note that the example response contains URLs for pagination * docs: add pagination data structure for links attribute * docs: added pagination parameters to request section Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> * DEV-26948 Add missing auth headers to requests (#64) * Add X-Acrolinx-Auth header to User API requests + Add '+ Requests' where missing * Add X-Acrolinx-Auth header to Role API requests + Add missing + Request block * Add X-Acrolinx-Auth header to Checking API requests * fix: URI parameters section parent should be a Resource or Action section + Fixng parameters or its description not showing up in some request cases * fix: Add parameters section to some Role API resources * fix: Move parameters out from request section + Fix parameter not showing up for request Get Link to Content Analysis Dashboard Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> * Develop to Main (#61) (#65) * docs/dev 26614 change license type (#58) * docs: add section for update license type * docs: fix Response 400 section and indentations * docs: use "User" attribute object instead of "Role" * docs: add missing 200 response for roles request * docs: add privilege note only for license type change * docs: use enum for UserLicense * docs: add 409 response * docs: add 409 response for license contract change * style: white space formatting * docs: Add request to Postman collection * Migrate Travis CI job to GitHub actions (#59) * chore: Remove travis.yml + But keep as old.travis.yml * feat: Add initial GitHub actions.yml + Name: Lint API Blueprint + Uses: node 12.x + Steps: npm run lint * chore: Add npm ci step to install deps * chore: Delete old.travis.yml * feat: Run only on push apiary.apib * chore: Added ending newline * Revert "feat: Run only on push apiary.apib" This reverts commit a1e5c991878d4b96064c698d2c21d2479881f4d5. * docs/remove specific changes (#60) * docs: remove section * docs: apply changes to postman collection * Build preview from develop branch Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com> * Ux writers edits (#66) * Develop to Main (#61) * docs/dev 26614 change license type (#58) * docs: add section for update license type * docs: fix Response 400 section and indentations * docs: use "User" attribute object instead of "Role" * docs: add missing 200 response for roles request * docs: add privilege note only for license type change * docs: use enum for UserLicense * docs: add 409 response * docs: add 409 response for license contract change * style: white space formatting * docs: Add request to Postman collection * Migrate Travis CI job to GitHub actions (#59) * chore: Remove travis.yml + But keep as old.travis.yml * feat: Add initial GitHub actions.yml + Name: Lint API Blueprint + Uses: node 12.x + Steps: npm run lint * chore: Add npm ci step to install deps * chore: Delete old.travis.yml * feat: Run only on push apiary.apib * chore: Added ending newline * Revert "feat: Run only on push apiary.apib" This reverts commit a1e5c991878d4b96064c698d2c21d2479881f4d5. * docs/remove specific changes (#60) * docs: remove section * docs: apply changes to postman collection * Build preview from develop branch * Added notes about authentication to user/role api * Update apiary.apib * docs: resolve minor typos * docs: remove datastructures url comment * Update apiary.apib * docs: remove duplicate /api/v1/user/self Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com> Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> * DEV-27221: User API pagination update (#67) * docs: add 400 response for per_page param and note on omitted links * docs: remove other draft api section * docs: add line to include headers for next/prev values * docs: add note on data source change during pagination call (#68) * docs: add note on data source change during pagination call * docs: sentence changes * UX writer edits to pagination draft (#69) * DEV-26981 Create user with custom field values (#70) * docs: Add Request Create a user with specified custom field values + Example response: Value not in Possible values error with status code 400 * fix: Linting issue * docs: Add error response example for unkown custom field speciefied on user create * fix: Correct a typo * Update apiary.apib Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> * fix: Omit empty privielges from User.roles[] response model (#73) Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> * DEV-27658: add functionality to sort by user custom fields (#77) * feat: Add custom key(customFields.{key}) as sortable parameter * fix: modify regex to allow sort with '.' * refactor: add note on how to use customFields.{key} * docs: add error response for invalid custom field value * docs: edit sort note * docs: rename comment * docs: edit error message * docs: add error response for null or empty custom field * docs: edit error message when custom field cannot be found * docs: add note about using custom fields to sort * docs: edit sort note * style: indentation fix Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> * devx: add build badge (#78) * docs: update regex (#83) * docs: update regex * docs: update sort API description Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> * DEV-27630 Document User API endpoint(s) for request user(s) to update custom field value (#86) * docs: Add section Request actualize Custom field values (single user) + Under the User Commands group + Example request and response * docs: Add some notes to the request + Mentioning the required privilege to perform the request * fix: Fix some typos * docs: Add the bulk request variant + Example request and success response * docs: Fix bulk response status codes after copy&paste * docs: Add example bulk request with invalid userids to showcase possible errors + Change in note to be gender neutral * fix: Linting issue * docs: Fix style issues * docs: User Information Update Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix description Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix request name Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix bulk request name Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix description in bulk Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix note in single request Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix bulk note about limitations Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix request naming Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Rename to Request User Information Update in Bulk * Update apiary.apib Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix error example should be singular * Update apiary.apib Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * DEV-27677 I can delete users in bulk (#87) * docs: add bulk delete API documentation * style: adjust indentation * style: adjust result indentation * docs: update result description * docs: cleanup documentation * docs: remove location field with null values * style: indentation adjustment * docs: lowercase for starting comments * docs: add documentation for bulk delete unknown/invalid user ids * docs: update null as bad request * docs: apply review suggestions * docs: add sample request with errors in response * docs: update description for API request * docs: moved comment to description section * docs: rename delete to deleted * docs: update sentence for request of users that cannot be deleted Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> * DEV-27807 Allow correct sorting by license status if the user has the license type Named user (#88) * docs: add note on sort by licenseType * docs: add fullstop * docs: note formatting Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> * DEV-27658: allowed special characters in custom field keys (#90) * docs: add note on allowed special chars for custom fields * docs: move special char text to a paragraph * Edits from docs team (#92) * Update apiary.apib * Update apiary.apib Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> * 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> * DEV-27658 Replace null custom field value with empty string (#93) * docs: add description when custom field has empty values Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> * term API doc: added referenced ACTIF sample file (#89) * term API doc: added referenced ACTIF sample file * term API doc: clarified "create entries" response * addressed Madeline's questions * apply Madeline's final suggestions for clarity/style Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * DEV-26980 Improve error response (#94) * docs: error message when creating user with more previleges than current user * docs: error message when you create/edit user with more previleges than you * docs: update error detail Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com> Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> Co-authored-by: mrnyax <nyakoria@gmail.com> Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: Robert Grabowski <robert.grabowski@acrolinx.com> * DEV-28485: add section on random password generation (#106) * docs: add section on random password generation * docs: bump core platform version to .03 * docs: end sentences with period in note * docs: change sub-group name to Random Passwords * docs: replace "comply with" by "meet" * docs: tweak sentence for convenient user creation * docs: update sentences to meet ux standard * docs: update 403 response comment * docs: update 503 response comment Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * DEV-29043 Custom Field API to get defined user custom fields (#111) * docs: add custom fields API to docs * docs: add note on privileges * docs: add response for missing/invalid token * docs: update CFs release version * docs: clean json response Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> * Extend documentation of CheckRequest.language (#112) Add documentation about what values to use for CheckRequest.language, extend description of the default. * Edits to custom fields API text (#113) * DEV-30814 Removing unused value * Develop (#122) * DEV-28485: add section on random password generation (#106) * docs: add section on random password generation * docs: bump core platform version to .03 * docs: end sentences with period in note * docs: change sub-group name to Random Passwords * docs: replace "comply with" by "meet" * docs: tweak sentence for convenient user creation * docs: update sentences to meet ux standard * docs: update 403 response comment * docs: update 503 response comment Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * DEV-29043 Custom Field API to get defined user custom fields (#111) * docs: add custom fields API to docs * docs: add note on privileges * docs: add response for missing/invalid token * docs: update CFs release version * docs: clean json response Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> * Extend documentation of CheckRequest.language (#112) Add documentation about what values to use for CheckRequest.language, extend description of the default. * Edits to custom fields API text (#113) * DEV-28754 Query users with missing required custom fields (#114) * docs: Add section ## Missing Required User Custom Fields + ### Count Users [HEAD /api/v1/user/custom-fields-missing] + ### Get Users [GET /api/v1/user/custom-fields-missing{?page,per_page}] * docs: Add comment see pagination details documented elsewhere * Update description Fix phrasing Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> * Update apiary.apib Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> * Update apiary.apib Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib UX writers edits Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib UX writers edits Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib UX writers edits Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib UX writers edits Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib UX writers edits Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib UX writers edits Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib UX writers edits Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: UX writers recommendation Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * DEV-29342: update pagination params error responses (#115) * style: replace char u+2019 with standard single quote apostrophe * docs: add error responses for invalid page param * docs: add error responses for invalid page param for custom-fields-missing api * docs: add section for health/status end point (#118) * docs: add section for health/status end point * docs: add description for health/status api path * docs: add Get Health Liveliness section * chore: add missing brace and format response codes * docs: ux string changes Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Add guidelineId to issues in examples (#120) Since 2022.10 Acrolinx returns a guidelineId for issues. This commit adds this field to the examples. * DEV-30375 change from optional -> recommended (#117) * Actualize main for 2021.12 rollout (#95) * Docs/dev 26614 change license type (#58) * docs: add section for update license type * docs: fix Response 400 section and indentations * docs: use "User" attribute object instead of "Role" * docs: add missing 200 response for roles request * docs: add privilege note only for license type change * docs: use enum for UserLicense * docs: add 409 response * docs: add 409 response for license contract change * style: white space formatting * docs: Add request to Postman collection Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> * Migrate Travis CI job to GitHub actions (#59) * chore: Remove travis.yml + But keep as old.travis.yml * feat: Add initial GitHub actions.yml + Name: Lint API Blueprint + Uses: node 12.x + Steps: npm run lint * chore: Add npm ci step to install deps * chore: Delete old.travis.yml * feat: Run only on push apiary.apib * chore: Added ending newline * Revert "feat: Run only on push apiary.apib" This reverts commit a1e5c991878d4b96064c698d2c21d2479881f4d5. Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> * docs/remove specific changes (#60) * docs: remove section * docs: apply changes to postman collection * Build preview from develop branch * Added info about pagination (#62) * docs: added docs for pagination parameters and how response changes * docs: added more details about pagination * added explanation of query parameters to the `Request` section * added example URLs to `links` object in `Response` section * added a note that the example response contains URLs for pagination * docs: add pagination data structure for links attribute * docs: added pagination parameters to request section Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> * DEV-26948 Add missing auth headers to requests (#64) * Add X-Acrolinx-Auth header to User API requests + Add '+ Requests' where missing * Add X-Acrolinx-Auth header to Role API requests + Add missing + Request block * Add X-Acrolinx-Auth header to Checking API requests * fix: URI parameters section parent should be a Resource or Action section + Fixng parameters or its description not showing up in some request cases * fix: Add parameters section to some Role API resources * fix: Move parameters out from request section + Fix parameter not showing up for request Get Link to Content Analysis Dashboard Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> * Develop to Main (#61) (#65) * docs/dev 26614 change license type (#58) * docs: add section for update license type * docs: fix Response 400 section and indentations * docs: use "User" attribute object instead of "Role" * docs: add missing 200 response for roles request * docs: add privilege note only for license type change * docs: use enum for UserLicense * docs: add 409 response * docs: add 409 response for license contract change * style: white space formatting * docs: Add request to Postman collection * Migrate Travis CI job to GitHub actions (#59) * chore: Remove travis.yml + But keep as old.travis.yml * feat: Add initial GitHub actions.yml + Name: Lint API Blueprint + Uses: node 12.x + Steps: npm run lint * chore: Add npm ci step to install deps * chore: Delete old.travis.yml * feat: Run only on push apiary.apib * chore: Added ending newline * Revert "feat: Run only on push apiary.apib" This reverts commit a1e5c991878d4b96064c698d2c21d2479881f4d5. * docs/remove specific changes (#60) * docs: remove section * docs: apply changes to postman collection * Build preview from develop branch Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com> * Ux writers edits (#66) * Develop to Main (#61) * docs/dev 26614 change license type (#58) * docs: add section for update license type * docs: fix Response 400 section and indentations * docs: use "User" attribute object instead of "Role" * docs: add missing 200 response for roles request * docs: add privilege note only for license type change * docs: use enum for UserLicense * docs: add 409 response * docs: add 409 response for license contract change * style: white space formatting * docs: Add request to Postman collection * Migrate Travis CI job to GitHub actions (#59) * chore: Remove travis.yml + But keep as old.travis.yml * feat: Add initial GitHub actions.yml + Name: Lint API Blueprint + Uses: node 12.x + Steps: npm run lint * chore: Add npm ci step to install deps * chore: Delete old.travis.yml * feat: Run only on push apiary.apib * chore: Added ending newline * Revert "feat: Run only on push apiary.apib" This reverts commit a1e5c991878d4b96064c698d2c21d2479881f4d5. * docs/remove specific changes (#60) * docs: remove section * docs: apply changes to postman collection * Build preview from develop branch * Added notes about authentication to user/role api * Update apiary.apib * docs: resolve minor typos * docs: remove datastructures url comment * Update apiary.apib * docs: remove duplicate /api/v1/user/self Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com> Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> * DEV-27221: User API pagination update (#67) * docs: add 400 response for per_page param and note on omitted links * docs: remove other draft api section * docs: add line to include headers for next/prev values * docs: add note on data source change during pagination call (#68) * docs: add note on data source change during pagination call * docs: sentence changes * UX writer edits to pagination draft (#69) * DEV-26981 Create user with custom field values (#70) * docs: Add Request Create a user with specified custom field values + Example response: Value not in Possible values error with status code 400 * fix: Linting issue * docs: Add error response example for unkown custom field speciefied on user create * fix: Correct a typo * Update apiary.apib Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> * fix: Omit empty privielges from User.roles[] response model (#73) Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> * DEV-27658: add functionality to sort by user custom fields (#77) * feat: Add custom key(customFields.{key}) as sortable parameter * fix: modify regex to allow sort with '.' * refactor: add note on how to use customFields.{key} * docs: add error response for invalid custom field value * docs: edit sort note * docs: rename comment * docs: edit error message * docs: add error response for null or empty custom field * docs: edit error message when custom field cannot be found * docs: add note about using custom fields to sort * docs: edit sort note * style: indentation fix Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> * devx: add build badge (#78) * docs: update regex (#83) * docs: update regex * docs: update sort API description Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> * DEV-27630 Document User API endpoint(s) for request user(s) to update custom field value (#86) * docs: Add section Request actualize Custom field values (single user) + Under the User Commands group + Example request and response * docs: Add some notes to the request + Mentioning the required privilege to perform the request * fix: Fix some typos * docs: Add the bulk request variant + Example request and success response * docs: Fix bulk response status codes after copy&paste * docs: Add example bulk request with invalid userids to showcase possible errors + Change in note to be gender neutral * fix: Linting issue * docs: Fix style issues * docs: User Information Update Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix description Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix request name Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix bulk request name Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix description in bulk Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix note in single request Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix bulk note about limitations Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix request naming Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Rename to Request User Information Update in Bulk * Update apiary.apib Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix error example should be singular * Update apiary.apib Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * DEV-27677 I can delete users in bulk (#87) * docs: add bulk delete API documentation * style: adjust indentation * style: adjust result indentation * docs: update result description * docs: cleanup documentation * docs: remove location field with null values * style: indentation adjustment * docs: lowercase for starting comments * docs: add documentation for bulk delete unknown/invalid user ids * docs: update null as bad request * docs: apply review suggestions * docs: add sample request with errors in response * docs: update description for API request * docs: moved comment to description section * docs: rename delete to deleted * docs: update sentence for request of users that cannot be deleted Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> * DEV-27807 Allow correct sorting by license status if the user has the license type Named user (#88) * docs: add note on sort by licenseType * docs: add fullstop * docs: note formatting Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> * DEV-27658: allowed special characters in custom field keys (#90) * docs: add note on allowed special chars for custom fields * docs: move special char text to a paragraph * Edits from docs team (#92) * Update apiary.apib * Update apiary.apib Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> * 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> * DEV-27658 Replace null custom field value with empty string (#93) * docs: add description when custom field has empty values Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> * term API doc: added referenced ACTIF sample file (#89) * term API doc: added referenced ACTIF sample file * term API doc: clarified "create entries" response * addressed Madeline's questions * apply Madeline's final suggestions for clarity/style Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * DEV-26980 Improve error response (#94) * docs: error message when creating user with more previleges than current user * docs: error message when you create/edit user with more previleges than you * docs: update error detail Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com> Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> Co-authored-by: mrnyax <nyakoria@gmail.com> Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: Robert Grabowski <robert.grabowski@acrolinx.com> * DEV-28485: add section on random password generation (#106) * docs: add section on random password generation * docs: bump core platform version to .03 * docs: end sentences with period in note * docs: change sub-group name to Random Passwords * docs: replace "comply with" by "meet" * docs: tweak sentence for convenient user creation * docs: update sentences to meet ux standard * docs: update 403 response comment * docs: update 503 response comment Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * DEV-29043 Custom Field API to get defined user custom fields (#111) * docs: add custom fields API to docs * docs: add note on privileges * docs: add response for missing/invalid token * docs: update CFs release version * docs: clean json response Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> * Extend documentation of CheckRequest.language (#112) Add documentation about what values to use for CheckRequest.language, extend description of the default. * Edits to custom fields API text (#113) * DEV-30375 change from ooptional -> recommended --------- Co-authored-by: Tóth Krisztián Gyula <t.krisztian95@gmail.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com> Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> Co-authored-by: mrnyax <nyakoria@gmail.com> Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: Robert Grabowski <robert.grabowski@acrolinx.com> Co-authored-by: replrep <32941710+replrep@users.noreply.github.com> * docs: remove duplicate section for random passwords api (#123) --------- Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> Co-authored-by: mrnyax <nyakoria@gmail.com> Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: replrep <32941710+replrep@users.noreply.github.com> Co-authored-by: Tóth Krisztián Gyula <t.krisztian95@gmail.com> Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: Alexander Kauer <alexander.kauer@acrolinx.com> Co-authored-by: Abhijeet Narvekar <abhijeet7222@gmail.com> Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com> Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> Co-authored-by: Robert Grabowski <robert.grabowski@acrolinx.com> * fix: Remove duplicate of Random Passwords (#124) * fix: Remove duplicate of ## Random Passwords * fix: Delete leftover part * fix: Locales is an array (#128) * fix: Remove contetn type for Response 204 (#129) * fix: Remove extra bracket (#130) * fix: Use array with fixed type CustomField (#131) --------- Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com> Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> Co-authored-by: mrnyax <nyakoria@gmail.com> Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: Robert Grabowski <robert.grabowski@acrolinx.com> Co-authored-by: replrep <32941710+replrep@users.noreply.github.com> Co-authored-by: Paresh Deshmukh <paresh.deshmukh@acrolinx.com> Co-authored-by: hjohannsen <39583180+hjohannsen@users.noreply.github.com> Co-authored-by: Alexander Kauer <alexander.kauer@acrolinx.com> Co-authored-by: Abhijeet Narvekar <abhijeet7222@gmail.com> --------- Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> Co-authored-by: mrnyax <nyakoria@gmail.com> Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: replrep <32941710+replrep@users.noreply.github.com> Co-authored-by: Tóth Krisztián Gyula <t.krisztian95@gmail.com> Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: Alexander Kauer <alexander.kauer@acrolinx.com> Co-authored-by: Abhijeet Narvekar <abhijeet7222@gmail.com> Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com> Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> Co-authored-by: Robert Grabowski <robert.grabowski@acrolinx.com> Co-authored-by: Thilo-Acrolinx <125662076+Thilo-Acrolinx@users.noreply.github.com> Co-authored-by: Tóth Krisztián Gyula <ktothdev@gmail.com> Co-authored-by: Paresh Deshmukh <paresh.deshmukh@acrolinx.com>
tkrisztian95
pushed a commit
that referenced
this pull request
Oct 18, 2023
… and editing assigned roles (#127) * docs: error response when external auth is enabled In this case, the external authentication system is used to manage password change * style: fix semantic issues * edit error message Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * edit error message Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * edit doc comment Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * doc: adjust error message for removed privilege escalation * doc: move response to appropriate area * doc: update description * doc: delete error response * refactor: group status response --------- Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>
tkrisztian95
added a commit
that referenced
this pull request
Oct 19, 2023
* DEV-28485: add section on random password generation (#106) * docs: add section on random password generation * docs: bump core platform version to .03 * docs: end sentences with period in note * docs: change sub-group name to Random Passwords * docs: replace "comply with" by "meet" * docs: tweak sentence for convenient user creation * docs: update sentences to meet ux standard * docs: update 403 response comment * docs: update 503 response comment Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * DEV-29043 Custom Field API to get defined user custom fields (#111) * docs: add custom fields API to docs * docs: add note on privileges * docs: add response for missing/invalid token * docs: update CFs release version * docs: clean json response Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> * Extend documentation of CheckRequest.language (#112) Add documentation about what values to use for CheckRequest.language, extend description of the default. * Edits to custom fields API text (#113) * DEV-28754 Query users with missing required custom fields (#114) * docs: Add section ## Missing Required User Custom Fields + ### Count Users [HEAD /api/v1/user/custom-fields-missing] + ### Get Users [GET /api/v1/user/custom-fields-missing{?page,per_page}] * docs: Add comment see pagination details documented elsewhere * Update description Fix phrasing Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> * Update apiary.apib Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> * Update apiary.apib Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib UX writers edits Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib UX writers edits Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib UX writers edits Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib UX writers edits Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib UX writers edits Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib UX writers edits Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib UX writers edits Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: UX writers recommendation Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * DEV-29342: update pagination params error responses (#115) * style: replace char u+2019 with standard single quote apostrophe * docs: add error responses for invalid page param * docs: add error responses for invalid page param for custom-fields-missing api * docs: add section for health/status end point (#118) * docs: add section for health/status end point * docs: add description for health/status api path * docs: add Get Health Liveliness section * chore: add missing brace and format response codes * docs: ux string changes Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Add guidelineId to issues in examples (#120) Since 2022.10 Acrolinx returns a guidelineId for issues. This commit adds this field to the examples. * DEV-30375 change from optional -> recommended (#117) * Actualize main for 2021.12 rollout (#95) * Docs/dev 26614 change license type (#58) * docs: add section for update license type * docs: fix Response 400 section and indentations * docs: use "User" attribute object instead of "Role" * docs: add missing 200 response for roles request * docs: add privilege note only for license type change * docs: use enum for UserLicense * docs: add 409 response * docs: add 409 response for license contract change * style: white space formatting * docs: Add request to Postman collection Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> * Migrate Travis CI job to GitHub actions (#59) * chore: Remove travis.yml + But keep as old.travis.yml * feat: Add initial GitHub actions.yml + Name: Lint API Blueprint + Uses: node 12.x + Steps: npm run lint * chore: Add npm ci step to install deps * chore: Delete old.travis.yml * feat: Run only on push apiary.apib * chore: Added ending newline * Revert "feat: Run only on push apiary.apib" This reverts commit a1e5c991878d4b96064c698d2c21d2479881f4d5. Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> * docs/remove specific changes (#60) * docs: remove section * docs: apply changes to postman collection * Build preview from develop branch * Added info about pagination (#62) * docs: added docs for pagination parameters and how response changes * docs: added more details about pagination * added explanation of query parameters to the `Request` section * added example URLs to `links` object in `Response` section * added a note that the example response contains URLs for pagination * docs: add pagination data structure for links attribute * docs: added pagination parameters to request section Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> * DEV-26948 Add missing auth headers to requests (#64) * Add X-Acrolinx-Auth header to User API requests + Add '+ Requests' where missing * Add X-Acrolinx-Auth header to Role API requests + Add missing + Request block * Add X-Acrolinx-Auth header to Checking API requests * fix: URI parameters section parent should be a Resource or Action section + Fixng parameters or its description not showing up in some request cases * fix: Add parameters section to some Role API resources * fix: Move parameters out from request section + Fix parameter not showing up for request Get Link to Content Analysis Dashboard Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> * Develop to Main (#61) (#65) * docs/dev 26614 change license type (#58) * docs: add section for update license type * docs: fix Response 400 section and indentations * docs: use "User" attribute object instead of "Role" * docs: add missing 200 response for roles request * docs: add privilege note only for license type change * docs: use enum for UserLicense * docs: add 409 response * docs: add 409 response for license contract change * style: white space formatting * docs: Add request to Postman collection * Migrate Travis CI job to GitHub actions (#59) * chore: Remove travis.yml + But keep as old.travis.yml * feat: Add initial GitHub actions.yml + Name: Lint API Blueprint + Uses: node 12.x + Steps: npm run lint * chore: Add npm ci step to install deps * chore: Delete old.travis.yml * feat: Run only on push apiary.apib * chore: Added ending newline * Revert "feat: Run only on push apiary.apib" This reverts commit a1e5c991878d4b96064c698d2c21d2479881f4d5. * docs/remove specific changes (#60) * docs: remove section * docs: apply changes to postman collection * Build preview from develop branch Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com> * Ux writers edits (#66) * Develop to Main (#61) * docs/dev 26614 change license type (#58) * docs: add section for update license type * docs: fix Response 400 section and indentations * docs: use "User" attribute object instead of "Role" * docs: add missing 200 response for roles request * docs: add privilege note only for license type change * docs: use enum for UserLicense * docs: add 409 response * docs: add 409 response for license contract change * style: white space formatting * docs: Add request to Postman collection * Migrate Travis CI job to GitHub actions (#59) * chore: Remove travis.yml + But keep as old.travis.yml * feat: Add initial GitHub actions.yml + Name: Lint API Blueprint + Uses: node 12.x + Steps: npm run lint * chore: Add npm ci step to install deps * chore: Delete old.travis.yml * feat: Run only on push apiary.apib * chore: Added ending newline * Revert "feat: Run only on push apiary.apib" This reverts commit a1e5c991878d4b96064c698d2c21d2479881f4d5. * docs/remove specific changes (#60) * docs: remove section * docs: apply changes to postman collection * Build preview from develop branch * Added notes about authentication to user/role api * Update apiary.apib * docs: resolve minor typos * docs: remove datastructures url comment * Update apiary.apib * docs: remove duplicate /api/v1/user/self Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com> Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> * DEV-27221: User API pagination update (#67) * docs: add 400 response for per_page param and note on omitted links * docs: remove other draft api section * docs: add line to include headers for next/prev values * docs: add note on data source change during pagination call (#68) * docs: add note on data source change during pagination call * docs: sentence changes * UX writer edits to pagination draft (#69) * DEV-26981 Create user with custom field values (#70) * docs: Add Request Create a user with specified custom field values + Example response: Value not in Possible values error with status code 400 * fix: Linting issue * docs: Add error response example for unkown custom field speciefied on user create * fix: Correct a typo * Update apiary.apib Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> * fix: Omit empty privielges from User.roles[] response model (#73) Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> * DEV-27658: add functionality to sort by user custom fields (#77) * feat: Add custom key(customFields.{key}) as sortable parameter * fix: modify regex to allow sort with '.' * refactor: add note on how to use customFields.{key} * docs: add error response for invalid custom field value * docs: edit sort note * docs: rename comment * docs: edit error message * docs: add error response for null or empty custom field * docs: edit error message when custom field cannot be found * docs: add note about using custom fields to sort * docs: edit sort note * style: indentation fix Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> * devx: add build badge (#78) * docs: update regex (#83) * docs: update regex * docs: update sort API description Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> * DEV-27630 Document User API endpoint(s) for request user(s) to update custom field value (#86) * docs: Add section Request actualize Custom field values (single user) + Under the User Commands group + Example request and response * docs: Add some notes to the request + Mentioning the required privilege to perform the request * fix: Fix some typos * docs: Add the bulk request variant + Example request and success response * docs: Fix bulk response status codes after copy&paste * docs: Add example bulk request with invalid userids to showcase possible errors + Change in note to be gender neutral * fix: Linting issue * docs: Fix style issues * docs: User Information Update Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix description Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix request name Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix bulk request name Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix description in bulk Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix note in single request Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix bulk note about limitations Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix request naming Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Rename to Request User Information Update in Bulk * Update apiary.apib Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix error example should be singular * Update apiary.apib Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * DEV-27677 I can delete users in bulk (#87) * docs: add bulk delete API documentation * style: adjust indentation * style: adjust result indentation * docs: update result description * docs: cleanup documentation * docs: remove location field with null values * style: indentation adjustment * docs: lowercase for starting comments * docs: add documentation for bulk delete unknown/invalid user ids * docs: update null as bad request * docs: apply review suggestions * docs: add sample request with errors in response * docs: update description for API request * docs: moved comment to description section * docs: rename delete to deleted * docs: update sentence for request of users that cannot be deleted Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> * DEV-27807 Allow correct sorting by license status if the user has the license type Named user (#88) * docs: add note on sort by licenseType * docs: add fullstop * docs: note formatting Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> * DEV-27658: allowed special characters in custom field keys (#90) * docs: add note on allowed special chars for custom fields * docs: move special char text to a paragraph * Edits from docs team (#92) * Update apiary.apib * Update apiary.apib Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> * 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> * DEV-27658 Replace null custom field value with empty string (#93) * docs: add description when custom field has empty values Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> * term API doc: added referenced ACTIF sample file (#89) * term API doc: added referenced ACTIF sample file * term API doc: clarified "create entries" response * addressed Madeline's questions * apply Madeline's final suggestions for clarity/style Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * DEV-26980 Improve error response (#94) * docs: error message when creating user with more previleges than current user * docs: error message when you create/edit user with more previleges than you * docs: update error detail Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com> Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> Co-authored-by: mrnyax <nyakoria@gmail.com> Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: Robert Grabowski <robert.grabowski@acrolinx.com> * DEV-28485: add section on random password generation (#106) * docs: add section on random password generation * docs: bump core platform version to .03 * docs: end sentences with period in note * docs: change sub-group name to Random Passwords * docs: replace "comply with" by "meet" * docs: tweak sentence for convenient user creation * docs: update sentences to meet ux standard * docs: update 403 response comment * docs: update 503 response comment Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * DEV-29043 Custom Field API to get defined user custom fields (#111) * docs: add custom fields API to docs * docs: add note on privileges * docs: add response for missing/invalid token * docs: update CFs release version * docs: clean json response Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> * Extend documentation of CheckRequest.language (#112) Add documentation about what values to use for CheckRequest.language, extend description of the default. * Edits to custom fields API text (#113) * DEV-30375 change from ooptional -> recommended --------- Co-authored-by: Tóth Krisztián Gyula <t.krisztian95@gmail.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com> Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> Co-authored-by: mrnyax <nyakoria@gmail.com> Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: Robert Grabowski <robert.grabowski@acrolinx.com> Co-authored-by: replrep <32941710+replrep@users.noreply.github.com> * docs: remove duplicate section for random passwords api (#123) * Minor text improvements in the Acrolinx Platform API description (#125) Minor improvements in the Acrolinx Platform API description, fix broken links * docs: error response when external auth is enabled (#126) * docs: error response when external auth is enabled In this case, the external authentication system is used to manage password change * style: fix semantic issues * edit error message Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * edit error message Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * edit doc comment Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> --------- Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> Co-authored-by: Tóth Krisztián Gyula <ktothdev@gmail.com> * Update for removed check for privilege escalation for creating a user and editing assigned roles (#127) * docs: error response when external auth is enabled In this case, the external authentication system is used to manage password change * style: fix semantic issues * edit error message Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * edit error message Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * edit doc comment Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * doc: adjust error message for removed privilege escalation * doc: move response to appropriate area * doc: update description * doc: delete error response * refactor: group status response --------- Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Get all users include/exclude nested data (#132) * docs: Get all users include/exclude nested data * Update apiary.apib Co-authored-by: mrnyax <nyakoria@gmail.com> * Update apiary.apib Co-authored-by: mrnyax <nyakoria@gmail.com> * style: Simplify * Update apiary.apib Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> --------- Co-authored-by: mrnyax <nyakoria@gmail.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Remove note about valid access token needed (#136) + In context this should be clear its neccessarry for the action * Fix three minor typos on line 261. (#137) * Resolve conflicts with main (#138) * Actualize main for 2021.12 rollout (#95) * Docs/dev 26614 change license type (#58) * docs: add section for update license type * docs: fix Response 400 section and indentations * docs: use "User" attribute object instead of "Role" * docs: add missing 200 response for roles request * docs: add privilege note only for license type change * docs: use enum for UserLicense * docs: add 409 response * docs: add 409 response for license contract change * style: white space formatting * docs: Add request to Postman collection Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> * Migrate Travis CI job to GitHub actions (#59) * chore: Remove travis.yml + But keep as old.travis.yml * feat: Add initial GitHub actions.yml + Name: Lint API Blueprint + Uses: node 12.x + Steps: npm run lint * chore: Add npm ci step to install deps * chore: Delete old.travis.yml * feat: Run only on push apiary.apib * chore: Added ending newline * Revert "feat: Run only on push apiary.apib" This reverts commit a1e5c991878d4b96064c698d2c21d2479881f4d5. Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> * docs/remove specific changes (#60) * docs: remove section * docs: apply changes to postman collection * Build preview from develop branch * Added info about pagination (#62) * docs: added docs for pagination parameters and how response changes * docs: added more details about pagination * added explanation of query parameters to the `Request` section * added example URLs to `links` object in `Response` section * added a note that the example response contains URLs for pagination * docs: add pagination data structure for links attribute * docs: added pagination parameters to request section Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> * DEV-26948 Add missing auth headers to requests (#64) * Add X-Acrolinx-Auth header to User API requests + Add '+ Requests' where missing * Add X-Acrolinx-Auth header to Role API requests + Add missing + Request block * Add X-Acrolinx-Auth header to Checking API requests * fix: URI parameters section parent should be a Resource or Action section + Fixng parameters or its description not showing up in some request cases * fix: Add parameters section to some Role API resources * fix: Move parameters out from request section + Fix parameter not showing up for request Get Link to Content Analysis Dashboard Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> * Develop to Main (#61) (#65) * docs/dev 26614 change license type (#58) * docs: add section for update license type * docs: fix Response 400 section and indentations * docs: use "User" attribute object instead of "Role" * docs: add missing 200 response for roles request * docs: add privilege note only for license type change * docs: use enum for UserLicense * docs: add 409 response * docs: add 409 response for license contract change * style: white space formatting * docs: Add request to Postman collection * Migrate Travis CI job to GitHub actions (#59) * chore: Remove travis.yml + But keep as old.travis.yml * feat: Add initial GitHub actions.yml + Name: Lint API Blueprint + Uses: node 12.x + Steps: npm run lint * chore: Add npm ci step to install deps * chore: Delete old.travis.yml * feat: Run only on push apiary.apib * chore: Added ending newline * Revert "feat: Run only on push apiary.apib" This reverts commit a1e5c991878d4b96064c698d2c21d2479881f4d5. * docs/remove specific changes (#60) * docs: remove section * docs: apply changes to postman collection * Build preview from develop branch Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com> * Ux writers edits (#66) * Develop to Main (#61) * docs/dev 26614 change license type (#58) * docs: add section for update license type * docs: fix Response 400 section and indentations * docs: use "User" attribute object instead of "Role" * docs: add missing 200 response for roles request * docs: add privilege note only for license type change * docs: use enum for UserLicense * docs: add 409 response * docs: add 409 response for license contract change * style: white space formatting * docs: Add request to Postman collection * Migrate Travis CI job to GitHub actions (#59) * chore: Remove travis.yml + But keep as old.travis.yml * feat: Add initial GitHub actions.yml + Name: Lint API Blueprint + Uses: node 12.x + Steps: npm run lint * chore: Add npm ci step to install deps * chore: Delete old.travis.yml * feat: Run only on push apiary.apib * chore: Added ending newline * Revert "feat: Run only on push apiary.apib" This reverts commit a1e5c991878d4b96064c698d2c21d2479881f4d5. * docs/remove specific changes (#60) * docs: remove section * docs: apply changes to postman collection * Build preview from develop branch * Added notes about authentication to user/role api * Update apiary.apib * docs: resolve minor typos * docs: remove datastructures url comment * Update apiary.apib * docs: remove duplicate /api/v1/user/self Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com> Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> * DEV-27221: User API pagination update (#67) * docs: add 400 response for per_page param and note on omitted links * docs: remove other draft api section * docs: add line to include headers for next/prev values * docs: add note on data source change during pagination call (#68) * docs: add note on data source change during pagination call * docs: sentence changes * UX writer edits to pagination draft (#69) * DEV-26981 Create user with custom field values (#70) * docs: Add Request Create a user with specified custom field values + Example response: Value not in Possible values error with status code 400 * fix: Linting issue * docs: Add error response example for unkown custom field speciefied on user create * fix: Correct a typo * Update apiary.apib Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> * fix: Omit empty privielges from User.roles[] response model (#73) Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> * DEV-27658: add functionality to sort by user custom fields (#77) * feat: Add custom key(customFields.{key}) as sortable parameter * fix: modify regex to allow sort with '.' * refactor: add note on how to use customFields.{key} * docs: add error response for invalid custom field value * docs: edit sort note * docs: rename comment * docs: edit error message * docs: add error response for null or empty custom field * docs: edit error message when custom field cannot be found * docs: add note about using custom fields to sort * docs: edit sort note * style: indentation fix Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> * devx: add build badge (#78) * docs: update regex (#83) * docs: update regex * docs: update sort API description Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> * DEV-27630 Document User API endpoint(s) for request user(s) to update custom field value (#86) * docs: Add section Request actualize Custom field values (single user) + Under the User Commands group + Example request and response * docs: Add some notes to the request + Mentioning the required privilege to perform the request * fix: Fix some typos * docs: Add the bulk request variant + Example request and success response * docs: Fix bulk response status codes after copy&paste * docs: Add example bulk request with invalid userids to showcase possible errors + Change in note to be gender neutral * fix: Linting issue * docs: Fix style issues * docs: User Information Update Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix description Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix request name Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix bulk request name Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix description in bulk Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix note in single request Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix bulk note about limitations Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix request naming Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Rename to Request User Information Update in Bulk * Update apiary.apib Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix error example should be singular * Update apiary.apib Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * DEV-27677 I can delete users in bulk (#87) * docs: add bulk delete API documentation * style: adjust indentation * style: adjust result indentation * docs: update result description * docs: cleanup documentation * docs: remove location field with null values * style: indentation adjustment * docs: lowercase for starting comments * docs: add documentation for bulk delete unknown/invalid user ids * docs: update null as bad request * docs: apply review suggestions * docs: add sample request with errors in response * docs: update description for API request * docs: moved comment to description section * docs: rename delete to deleted * docs: update sentence for request of users that cannot be deleted Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> * DEV-27807 Allow correct sorting by license status if the user has the license type Named user (#88) * docs: add note on sort by licenseType * docs: add fullstop * docs: note formatting Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> * DEV-27658: allowed special characters in custom field keys (#90) * docs: add note on allowed special chars for custom fields * docs: move special char text to a paragraph * Edits from docs team (#92) * Update apiary.apib * Update apiary.apib Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> * 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> * DEV-27658 Replace null custom field value with empty string (#93) * docs: add description when custom field has empty values Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> * term API doc: added referenced ACTIF sample file (#89) * term API doc: added referenced ACTIF sample file * term API doc: clarified "create entries" response * addressed Madeline's questions * apply Madeline's final suggestions for clarity/style Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * DEV-26980 Improve error response (#94) * docs: error message when creating user with more previleges than current user * docs: error message when you create/edit user with more previleges than you * docs: update error detail Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com> Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> Co-authored-by: mrnyax <nyakoria@gmail.com> Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: Robert Grabowski <robert.grabowski@acrolinx.com> * DEV-28485: add section on random password generation (#106) * docs: add section on random password generation * docs: bump core platform version to .03 * docs: end sentences with period in note * docs: change sub-group name to Random Passwords * docs: replace "comply with" by "meet" * docs: tweak sentence for convenient user creation * docs: update sentences to meet ux standard * docs: update 403 response comment * docs: update 503 response comment Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * DEV-29043 Custom Field API to get defined user custom fields (#111) * docs: add custom fields API to docs * docs: add note on privileges * docs: add response for missing/invalid token * docs: update CFs release version * docs: clean json response Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> * Extend documentation of CheckRequest.language (#112) Add documentation about what values to use for CheckRequest.language, extend description of the default. * Edits to custom fields API text (#113) * DEV-30814 Removing unused value * Develop (#122) * DEV-28485: add section on random password generation (#106) * docs: add section on random password generation * docs: bump core platform version to .03 * docs: end sentences with period in note * docs: change sub-group name to Random Passwords * docs: replace "comply with" by "meet" * docs: tweak sentence for convenient user creation * docs: update sentences to meet ux standard * docs: update 403 response comment * docs: update 503 response comment Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * DEV-29043 Custom Field API to get defined user custom fields (#111) * docs: add custom fields API to docs * docs: add note on privileges * docs: add response for missing/invalid token * docs: update CFs release version * docs: clean json response Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> * Extend documentation of CheckRequest.language (#112) Add documentation about what values to use for CheckRequest.language, extend description of the default. * Edits to custom fields API text (#113) * DEV-28754 Query users with missing required custom fields (#114) * docs: Add section ## Missing Required User Custom Fields + ### Count Users [HEAD /api/v1/user/custom-fields-missing] + ### Get Users [GET /api/v1/user/custom-fields-missing{?page,per_page}] * docs: Add comment see pagination details documented elsewhere * Update description Fix phrasing Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> * Update apiary.apib Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> * Update apiary.apib Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib UX writers edits Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib UX writers edits Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib UX writers edits Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib UX writers edits Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib UX writers edits Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib UX writers edits Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib UX writers edits Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: UX writers recommendation Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * DEV-29342: update pagination params error responses (#115) * style: replace char u+2019 with standard single quote apostrophe * docs: add error responses for invalid page param * docs: add error responses for invalid page param for custom-fields-missing api * docs: add section for health/status end point (#118) * docs: add section for health/status end point * docs: add description for health/status api path * docs: add Get Health Liveliness section * chore: add missing brace and format response codes * docs: ux string changes Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Add guidelineId to issues in examples (#120) Since 2022.10 Acrolinx returns a guidelineId for issues. This commit adds this field to the examples. * DEV-30375 change from optional -> recommended (#117) * Actualize main for 2021.12 rollout (#95) * Docs/dev 26614 change license type (#58) * docs: add section for update license type * docs: fix Response 400 section and indentations * docs: use "User" attribute object instead of "Role" * docs: add missing 200 response for roles request * docs: add privilege note only for license type change * docs: use enum for UserLicense * docs: add 409 response * docs: add 409 response for license contract change * style: white space formatting * docs: Add request to Postman collection Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> * Migrate Travis CI job to GitHub actions (#59) * chore: Remove travis.yml + But keep as old.travis.yml * feat: Add initial GitHub actions.yml + Name: Lint API Blueprint + Uses: node 12.x + Steps: npm run lint * chore: Add npm ci step to install deps * chore: Delete old.travis.yml * feat: Run only on push apiary.apib * chore: Added ending newline * Revert "feat: Run only on push apiary.apib" This reverts commit a1e5c991878d4b96064c698d2c21d2479881f4d5. Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> * docs/remove specific changes (#60) * docs: remove section * docs: apply changes to postman collection * Build preview from develop branch * Added info about pagination (#62) * docs: added docs for pagination parameters and how response changes * docs: added more details about pagination * added explanation of query parameters to the `Request` section * added example URLs to `links` object in `Response` section * added a note that the example response contains URLs for pagination * docs: add pagination data structure for links attribute * docs: added pagination parameters to request section Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> * DEV-26948 Add missing auth headers to requests (#64) * Add X-Acrolinx-Auth header to User API requests + Add '+ Requests' where missing * Add X-Acrolinx-Auth header to Role API requests + Add missing + Request block * Add X-Acrolinx-Auth header to Checking API requests * fix: URI parameters section parent should be a Resource or Action section + Fixng parameters or its description not showing up in some request cases * fix: Add parameters section to some Role API resources * fix: Move parameters out from request section + Fix parameter not showing up for request Get Link to Content Analysis Dashboard Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> * Develop to Main (#61) (#65) * docs/dev 26614 change license type (#58) * docs: add section for update license type * docs: fix Response 400 section and indentations * docs: use "User" attribute object instead of "Role" * docs: add missing 200 response for roles request * docs: add privilege note only for license type change * docs: use enum for UserLicense * docs: add 409 response * docs: add 409 response for license contract change * style: white space formatting * docs: Add request to Postman collection * Migrate Travis CI job to GitHub actions (#59) * chore: Remove travis.yml + But keep as old.travis.yml * feat: Add initial GitHub actions.yml + Name: Lint API Blueprint + Uses: node 12.x + Steps: npm run lint * chore: Add npm ci step to install deps * chore: Delete old.travis.yml * feat: Run only on push apiary.apib * chore: Added ending newline * Revert "feat: Run only on push apiary.apib" This reverts commit a1e5c991878d4b96064c698d2c21d2479881f4d5. * docs/remove specific changes (#60) * docs: remove section * docs: apply changes to postman collection * Build preview from develop branch Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com> * Ux writers edits (#66) * Develop to Main (#61) * docs/dev 26614 change license type (#58) * docs: add section for update license type * docs: fix Response 400 section and indentations * docs: use "User" attribute object instead of "Role" * docs: add missing 200 response for roles request * docs: add privilege note only for license type change * docs: use enum for UserLicense * docs: add 409 response * docs: add 409 response for license contract change * style: white space formatting * docs: Add request to Postman collection * Migrate Travis CI job to GitHub actions (#59) * chore: Remove travis.yml + But keep as old.travis.yml * feat: Add initial GitHub actions.yml + Name: Lint API Blueprint + Uses: node 12.x + Steps: npm run lint * chore: Add npm ci step to install deps * chore: Delete old.travis.yml * feat: Run only on push apiary.apib * chore: Added ending newline * Revert "feat: Run only on push apiary.apib" This reverts commit a1e5c991878d4b96064c698d2c21d2479881f4d5. * docs/remove specific changes (#60) * docs: remove section * docs: apply changes to postman collection * Build preview from develop branch * Added notes about authentication to user/role api * Update apiary.apib * docs: resolve minor typos * docs: remove datastructures url comment * Update apiary.apib * docs: remove duplicate /api/v1/user/self Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com> Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> * DEV-27221: User API pagination update (#67) * docs: add 400 response for per_page param and note on omitted links * docs: remove other draft api section * docs: add line to include headers for next/prev values * docs: add note on data source change during pagination call (#68) * docs: add note on data source change during pagination call * docs: sentence changes * UX writer edits to pagination draft (#69) * DEV-26981 Create user with custom field values (#70) * docs: Add Request Create a user with specified custom field values + Example response: Value not in Possible values error with status code 400 * fix: Linting issue * docs: Add error response example for unkown custom field speciefied on user create * fix: Correct a typo * Update apiary.apib Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> * fix: Omit empty privielges from User.roles[] response model (#73) Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> * DEV-27658: add functionality to sort by user custom fields (#77) * feat: Add custom key(customFields.{key}) as sortable parameter * fix: modify regex to allow sort with '.' * refactor: add note on how to use customFields.{key} * docs: add error response for invalid custom field value * docs: edit sort note * docs: rename comment * docs: edit error message * docs: add error response for null or empty custom field * docs: edit error message when custom field cannot be found * docs: add note about using custom fields to sort * docs: edit sort note * style: indentation fix Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> * devx: add build badge (#78) * docs: update regex (#83) * docs: update regex * docs: update sort API description Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> * DEV-27630 Document User API endpoint(s) for request user(s) to update custom field value (#86) * docs: Add section Request actualize Custom field values (single user) + Under the User Commands group + Example request and response * docs: Add some notes to the request + Mentioning the required privilege to perform the request * fix: Fix some typos * docs: Add the bulk request variant + Example request and success response * docs: Fix bulk response status codes after copy&paste * docs: Add example bulk request with invalid userids to showcase possible errors + Change in note to be gender neutral * fix: Linting issue * docs: Fix style issues * docs: User Information Update Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix description Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix request name Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix bulk request name Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix description in bulk Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix note in single request Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix bulk note about limitations Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix request naming Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Rename to Request User Information Update in Bulk * Update apiary.apib Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix error example should be singular * Update apiary.apib Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * DEV-27677 I can delete users in bulk (#87) * docs: add bulk delete API documentation * style: adjust indentation * style: adjust result indentation * docs: update result description * docs: cleanup documentation * docs: remove location field with null values * style: indentation adjustment * docs: lowercase for starting comments * docs: add documentation for bulk delete unknown/invalid user ids * docs: update null as bad request * docs: apply review suggestions * docs: add sample request with errors in response * docs: update description for API request * docs: moved comment to description section * docs: rename delete to deleted * docs: update sentence for request of users that cannot be deleted Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> * DEV-27807 Allow correct sorting by license status if the user has the license type Named user (#88) * docs: add note on sort by licenseType * docs: add fullstop * docs: note formatting Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> * DEV-27658: allowed special characters in custom field keys (#90) * docs: add note on allowed special chars for custom fields * docs: move special char text to a paragraph * Edits from docs team (#92) * Update apiary.apib * Update apiary.apib Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> * 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> * DEV-27658 Replace null custom field value with empty string (#93) * docs: add description when custom field has empty values Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> * term API doc: added referenced ACTIF sample file (#89) * term API doc: added referenced ACTIF sample file * term API doc: clarified "create entries" response * addressed Madeline's questions * apply Madeline's final suggestions for clarity/style Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * DEV-26980 Improve error response (#94) * docs: error message when creating user with more previleges than current user * docs: error message when you create/edit user with more previleges than you * docs: update error detail Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com> Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> Co-authored-by: mrnyax <nyakoria@gmail.com> Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: Robert Grabowski <robert.grabowski@acrolinx.com> * DEV-28485: add section on random password generation (#106) * docs: add section on random password generation * docs: bump core platform version to .03 * docs: end sentences with period in note * docs: change sub-group name to Random Passwords * docs: replace "comply with" by "meet" * docs: tweak sentence for convenient user creation * docs: update sentences to meet ux standard * docs: update 403 response comment * docs: update 503 response comment Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * DEV-29043 Custom Field API to get defined user custom fields (#111) * docs: add custom fields API to docs * docs: add note on privileges * docs: add response for missing/invalid token * docs: update CFs release version * docs: clean json response Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> * Extend documentation of CheckRequest.language (#112) Add documentation about what values to use for CheckRequest.language, extend description of the default. * Edits to custom fields API text (#113) * DEV-30375 change from ooptional -> recommended --------- Co-authored-by: Tóth Krisztián Gyula <t.krisztian95@gmail.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com> Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> Co-authored-by: mrnyax <nyakoria@gmail.com> Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: Robert Grabowski <robert.grabowski@acrolinx.com> Co-authored-by: replrep <32941710+replrep@users.noreply.github.com> * docs: remove duplicate section for random passwords api (#123) --------- Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> Co-authored-by: mrnyax <nyakoria@gmail.com> Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: replrep <32941710+replrep@users.noreply.github.com> Co-authored-by: Tóth Krisztián Gyula <t.krisztian95@gmail.com> Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: Alexander Kauer <alexander.kauer@acrolinx.com> Co-authored-by: Abhijeet Narvekar <abhijeet7222@gmail.com> Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com> Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> Co-authored-by: Robert Grabowski <robert.grabowski@acrolinx.com> * fix: Remove duplicate of Random Passwords (#124) * fix: Remove duplicate of ## Random Passwords * fix: Delete leftover part * fix: Locales is an array (#128) * fix: Remove contetn type for Response 204 (#129) * fix: Remove extra bracket (#130) * fix: Use array with fixed type CustomField (#131) --------- Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com> Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> Co-authored-by: mrnyax <nyakoria@gmail.com> Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: Robert Grabowski <robert.grabowski@acrolinx.com> Co-authored-by: replrep <32941710+replrep@users.noreply.github.com> Co-authored-by: Paresh Deshmukh <paresh.deshmukh@acrolinx.com> Co-authored-by: hjohannsen <39583180+hjohannsen@users.noreply.github.com> Co-authored-by: Alexander Kauer <alexander.kauer@acrolinx.com> Co-authored-by: Abhijeet Narvekar <abhijeet7222@gmail.com> * Resolve merge conflicts (#141) * Actualize main for 2021.12 rollout (#95) * Docs/dev 26614 change license type (#58) * docs: add section for update license type * docs: fix Response 400 section and indentations * docs: use "User" attribute object instead of "Role" * docs: add missing 200 response for roles request * docs: add privilege note only for license type change * docs: use enum for UserLicense * docs: add 409 response * docs: add 409 response for license contract change * style: white space formatting * docs: Add request to Postman collection Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> * Migrate Travis CI job to GitHub actions (#59) * chore: Remove travis.yml + But keep as old.travis.yml * feat: Add initial GitHub actions.yml + Name: Lint API Blueprint + Uses: node 12.x + Steps: npm run lint * chore: Add npm ci step to install deps * chore: Delete old.travis.yml * feat: Run only on push apiary.apib * chore: Added ending newline * Revert "feat: Run only on push apiary.apib" This reverts commit a1e5c991878d4b96064c698d2c21d2479881f4d5. Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> * docs/remove specific changes (#60) * docs: remove section * docs: apply changes to postman collection * Build preview from develop branch * Added info about pagination (#62) * docs: added docs for pagination parameters and how response changes * docs: added more details about pagination * added explanation of query parameters to the `Request` section * added example URLs to `links` object in `Response` section * added a note that the example response contains URLs for pagination * docs: add pagination data structure for links attribute * docs: added pagination parameters to request section Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> * DEV-26948 Add missing auth headers to requests (#64) * Add X-Acrolinx-Auth header to User API requests + Add '+ Requests' where missing * Add X-Acrolinx-Auth header to Role API requests + Add missing + Request block * Add X-Acrolinx-Auth header to Checking API requests * fix: URI parameters section parent should be a Resource or Action section + Fixng parameters or its description not showing up in some request cases * fix: Add parameters section to some Role API resources * fix: Move parameters out from request section + Fix parameter not showing up for request Get Link to Content Analysis Dashboard Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> * Develop to Main (#61) (#65) * docs/dev 26614 change license type (#58) * docs: add section for update license type * docs: fix Response 400 section and indentations * docs: use "User" attribute object instead of "Role" * docs: add missing 200 response for roles request * docs: add privilege note only for license type change * docs: use enum for UserLicense * docs: add 409 response * docs: add 409 response for license contract change * style: white space formatting * docs: Add request to Postman collection * Migrate Travis CI job to GitHub actions (#59) * chore: Remove travis.yml + But keep as old.travis.yml * feat: Add initial GitHub actions.yml + Name: Lint API Blueprint + Uses: node 12.x + Steps: npm run lint * chore: Add npm ci step to install deps * chore: Delete old.travis.yml * feat: Run only on push apiary.apib * chore: Added ending newline * Revert "feat: Run only on push apiary.apib" This reverts commit a1e5c991878d4b96064c698d2c21d2479881f4d5. * docs/remove specific changes (#60) * docs: remove section * docs: apply changes to postman collection * Build preview from develop branch Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com> * Ux writers edits (#66) * Develop to Main (#61) * docs/dev 26614 change license type (#58) * docs: add section for update license type * docs: fix Response 400 section and indentations * docs: use "User" attribute object instead of "Role" * docs: add missing 200 response for roles request * docs: add privilege note only for license type change * docs: use enum for UserLicense * docs: add 409 response * docs: add 409 response for license contract change * style: white space formatting * docs: Add request to Postman collection * Migrate Travis CI job to GitHub actions (#59) * chore: Remove travis.yml + But keep as old.travis.yml * feat: Add initial GitHub actions.yml + Name: Lint API Blueprint + Uses: node 12.x + Steps: npm run lint * chore: Add npm ci step to install deps * chore: Delete old.travis.yml * feat: Run only on push apiary.apib * chore: Added ending newline * Revert "feat: Run only on push apiary.apib" This reverts commit a1e5c991878d4b96064c698d2c21d2479881f4d5. * docs/remove specific changes (#60) * docs: remove section * docs: apply changes to postman collection * Build preview from develop branch * Added notes about authentication to user/role api * Update apiary.apib * docs: resolve minor typos * docs: remove datastructures url comment * Update apiary.apib * docs: remove duplicate /api/v1/user/self Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com> Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> * DEV-27221: User API pagination update (#67) * docs: add 400 response for per_page param and note on omitted links * docs: remove other draft api section * docs: add line to include headers for next/prev values * docs: add note on data source change during pagination call (#68) * docs: add note on data source change during pagination call * docs: sentence changes * UX writer edits to pagination draft (#69) * DEV-26981 Create user with custom field values (#70) * docs: Add Request Create a user with specified custom field values + Example response: Value not in Possible values error with status code 400 * fix: Linting issue * docs: Add error response example for unkown custom field speciefied on user create * fix: Correct a typo * Update apiary.apib Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> * fix: Omit empty privielges from User.roles[] response model (#73) Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> * DEV-27658: add functionality to sort by user custom fields (#77) * feat: Add custom key(customFields.{key}) as sortable parameter * fix: modify regex to allow sort with '.' * refactor: add note on how to use customFields.{key} * docs: add error response for invalid custom field value * docs: edit sort note * docs: rename comment * docs: edit error message * docs: add error response for null or empty custom field * docs: edit error message when custom field cannot be found * docs: add note about using custom fields to sort * docs: edit sort note * style: indentation fix Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> * devx: add build badge (#78) * docs: update regex (#83) * docs: update regex * docs: update sort API description Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> * DEV-27630 Document User API endpoint(s) for request user(s) to update custom field value (#86) * docs: Add section Request actualize Custom field values (single user) + Under the User Commands group + Example request and response * docs: Add some notes to the request + …
hjohannsen
added a commit
that referenced
this pull request
Jan 3, 2024
* DEV-28485: add section on random password generation (#106) * docs: add section on random password generation * docs: bump core platform version to .03 * docs: end sentences with period in note * docs: change sub-group name to Random Passwords * docs: replace "comply with" by "meet" * docs: tweak sentence for convenient user creation * docs: update sentences to meet ux standard * docs: update 403 response comment * docs: update 503 response comment Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * DEV-29043 Custom Field API to get defined user custom fields (#111) * docs: add custom fields API to docs * docs: add note on privileges * docs: add response for missing/invalid token * docs: update CFs release version * docs: clean json response Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> * Extend documentation of CheckRequest.language (#112) Add documentation about what values to use for CheckRequest.language, extend description of the default. * Edits to custom fields API text (#113) * DEV-28754 Query users with missing required custom fields (#114) * docs: Add section ## Missing Required User Custom Fields + ### Count Users [HEAD /api/v1/user/custom-fields-missing] + ### Get Users [GET /api/v1/user/custom-fields-missing{?page,per_page}] * docs: Add comment see pagination details documented elsewhere * Update description Fix phrasing Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> * Update apiary.apib Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> * Update apiary.apib Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib UX writers edits Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib UX writers edits Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib UX writers edits Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib UX writers edits Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib UX writers edits Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib UX writers edits Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib UX writers edits Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: UX writers recommendation Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * DEV-29342: update pagination params error responses (#115) * style: replace char u+2019 with standard single quote apostrophe * docs: add error responses for invalid page param * docs: add error responses for invalid page param for custom-fields-missing api * docs: add section for health/status end point (#118) * docs: add section for health/status end point * docs: add description for health/status api path * docs: add Get Health Liveliness section * chore: add missing brace and format response codes * docs: ux string changes Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Add guidelineId to issues in examples (#120) Since 2022.10 Acrolinx returns a guidelineId for issues. This commit adds this field to the examples. * DEV-30375 change from optional -> recommended (#117) * Actualize main for 2021.12 rollout (#95) * Docs/dev 26614 change license type (#58) * docs: add section for update license type * docs: fix Response 400 section and indentations * docs: use "User" attribute object instead of "Role" * docs: add missing 200 response for roles request * docs: add privilege note only for license type change * docs: use enum for UserLicense * docs: add 409 response * docs: add 409 response for license contract change * style: white space formatting * docs: Add request to Postman collection Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> * Migrate Travis CI job to GitHub actions (#59) * chore: Remove travis.yml + But keep as old.travis.yml * feat: Add initial GitHub actions.yml + Name: Lint API Blueprint + Uses: node 12.x + Steps: npm run lint * chore: Add npm ci step to install deps * chore: Delete old.travis.yml * feat: Run only on push apiary.apib * chore: Added ending newline * Revert "feat: Run only on push apiary.apib" This reverts commit a1e5c991878d4b96064c698d2c21d2479881f4d5. Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> * docs/remove specific changes (#60) * docs: remove section * docs: apply changes to postman collection * Build preview from develop branch * Added info about pagination (#62) * docs: added docs for pagination parameters and how response changes * docs: added more details about pagination * added explanation of query parameters to the `Request` section * added example URLs to `links` object in `Response` section * added a note that the example response contains URLs for pagination * docs: add pagination data structure for links attribute * docs: added pagination parameters to request section Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> * DEV-26948 Add missing auth headers to requests (#64) * Add X-Acrolinx-Auth header to User API requests + Add '+ Requests' where missing * Add X-Acrolinx-Auth header to Role API requests + Add missing + Request block * Add X-Acrolinx-Auth header to Checking API requests * fix: URI parameters section parent should be a Resource or Action section + Fixng parameters or its description not showing up in some request cases * fix: Add parameters section to some Role API resources * fix: Move parameters out from request section + Fix parameter not showing up for request Get Link to Content Analysis Dashboard Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> * Develop to Main (#61) (#65) * docs/dev 26614 change license type (#58) * docs: add section for update license type * docs: fix Response 400 section and indentations * docs: use "User" attribute object instead of "Role" * docs: add missing 200 response for roles request * docs: add privilege note only for license type change * docs: use enum for UserLicense * docs: add 409 response * docs: add 409 response for license contract change * style: white space formatting * docs: Add request to Postman collection * Migrate Travis CI job to GitHub actions (#59) * chore: Remove travis.yml + But keep as old.travis.yml * feat: Add initial GitHub actions.yml + Name: Lint API Blueprint + Uses: node 12.x + Steps: npm run lint * chore: Add npm ci step to install deps * chore: Delete old.travis.yml * feat: Run only on push apiary.apib * chore: Added ending newline * Revert "feat: Run only on push apiary.apib" This reverts commit a1e5c991878d4b96064c698d2c21d2479881f4d5. * docs/remove specific changes (#60) * docs: remove section * docs: apply changes to postman collection * Build preview from develop branch Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com> * Ux writers edits (#66) * Develop to Main (#61) * docs/dev 26614 change license type (#58) * docs: add section for update license type * docs: fix Response 400 section and indentations * docs: use "User" attribute object instead of "Role" * docs: add missing 200 response for roles request * docs: add privilege note only for license type change * docs: use enum for UserLicense * docs: add 409 response * docs: add 409 response for license contract change * style: white space formatting * docs: Add request to Postman collection * Migrate Travis CI job to GitHub actions (#59) * chore: Remove travis.yml + But keep as old.travis.yml * feat: Add initial GitHub actions.yml + Name: Lint API Blueprint + Uses: node 12.x + Steps: npm run lint * chore: Add npm ci step to install deps * chore: Delete old.travis.yml * feat: Run only on push apiary.apib * chore: Added ending newline * Revert "feat: Run only on push apiary.apib" This reverts commit a1e5c991878d4b96064c698d2c21d2479881f4d5. * docs/remove specific changes (#60) * docs: remove section * docs: apply changes to postman collection * Build preview from develop branch * Added notes about authentication to user/role api * Update apiary.apib * docs: resolve minor typos * docs: remove datastructures url comment * Update apiary.apib * docs: remove duplicate /api/v1/user/self Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com> Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> * DEV-27221: User API pagination update (#67) * docs: add 400 response for per_page param and note on omitted links * docs: remove other draft api section * docs: add line to include headers for next/prev values * docs: add note on data source change during pagination call (#68) * docs: add note on data source change during pagination call * docs: sentence changes * UX writer edits to pagination draft (#69) * DEV-26981 Create user with custom field values (#70) * docs: Add Request Create a user with specified custom field values + Example response: Value not in Possible values error with status code 400 * fix: Linting issue * docs: Add error response example for unkown custom field speciefied on user create * fix: Correct a typo * Update apiary.apib Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> * fix: Omit empty privielges from User.roles[] response model (#73) Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> * DEV-27658: add functionality to sort by user custom fields (#77) * feat: Add custom key(customFields.{key}) as sortable parameter * fix: modify regex to allow sort with '.' * refactor: add note on how to use customFields.{key} * docs: add error response for invalid custom field value * docs: edit sort note * docs: rename comment * docs: edit error message * docs: add error response for null or empty custom field * docs: edit error message when custom field cannot be found * docs: add note about using custom fields to sort * docs: edit sort note * style: indentation fix Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> * devx: add build badge (#78) * docs: update regex (#83) * docs: update regex * docs: update sort API description Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> * DEV-27630 Document User API endpoint(s) for request user(s) to update custom field value (#86) * docs: Add section Request actualize Custom field values (single user) + Under the User Commands group + Example request and response * docs: Add some notes to the request + Mentioning the required privilege to perform the request * fix: Fix some typos * docs: Add the bulk request variant + Example request and success response * docs: Fix bulk response status codes after copy&paste * docs: Add example bulk request with invalid userids to showcase possible errors + Change in note to be gender neutral * fix: Linting issue * docs: Fix style issues * docs: User Information Update Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix description Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix request name Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix bulk request name Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix description in bulk Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix note in single request Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix bulk note about limitations Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix request naming Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Rename to Request User Information Update in Bulk * Update apiary.apib Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix error example should be singular * Update apiary.apib Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * DEV-27677 I can delete users in bulk (#87) * docs: add bulk delete API documentation * style: adjust indentation * style: adjust result indentation * docs: update result description * docs: cleanup documentation * docs: remove location field with null values * style: indentation adjustment * docs: lowercase for starting comments * docs: add documentation for bulk delete unknown/invalid user ids * docs: update null as bad request * docs: apply review suggestions * docs: add sample request with errors in response * docs: update description for API request * docs: moved comment to description section * docs: rename delete to deleted * docs: update sentence for request of users that cannot be deleted Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> * DEV-27807 Allow correct sorting by license status if the user has the license type Named user (#88) * docs: add note on sort by licenseType * docs: add fullstop * docs: note formatting Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> * DEV-27658: allowed special characters in custom field keys (#90) * docs: add note on allowed special chars for custom fields * docs: move special char text to a paragraph * Edits from docs team (#92) * Update apiary.apib * Update apiary.apib Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> * 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> * DEV-27658 Replace null custom field value with empty string (#93) * docs: add description when custom field has empty values Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> * term API doc: added referenced ACTIF sample file (#89) * term API doc: added referenced ACTIF sample file * term API doc: clarified "create entries" response * addressed Madeline's questions * apply Madeline's final suggestions for clarity/style Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * DEV-26980 Improve error response (#94) * docs: error message when creating user with more previleges than current user * docs: error message when you create/edit user with more previleges than you * docs: update error detail Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com> Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> Co-authored-by: mrnyax <nyakoria@gmail.com> Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: Robert Grabowski <robert.grabowski@acrolinx.com> * DEV-28485: add section on random password generation (#106) * docs: add section on random password generation * docs: bump core platform version to .03 * docs: end sentences with period in note * docs: change sub-group name to Random Passwords * docs: replace "comply with" by "meet" * docs: tweak sentence for convenient user creation * docs: update sentences to meet ux standard * docs: update 403 response comment * docs: update 503 response comment Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * DEV-29043 Custom Field API to get defined user custom fields (#111) * docs: add custom fields API to docs * docs: add note on privileges * docs: add response for missing/invalid token * docs: update CFs release version * docs: clean json response Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> * Extend documentation of CheckRequest.language (#112) Add documentation about what values to use for CheckRequest.language, extend description of the default. * Edits to custom fields API text (#113) * DEV-30375 change from ooptional -> recommended --------- Co-authored-by: Tóth Krisztián Gyula <t.krisztian95@gmail.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com> Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> Co-authored-by: mrnyax <nyakoria@gmail.com> Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: Robert Grabowski <robert.grabowski@acrolinx.com> Co-authored-by: replrep <32941710+replrep@users.noreply.github.com> * docs: remove duplicate section for random passwords api (#123) * Minor text improvements in the Acrolinx Platform API description (#125) Minor improvements in the Acrolinx Platform API description, fix broken links * docs: error response when external auth is enabled (#126) * docs: error response when external auth is enabled In this case, the external authentication system is used to manage password change * style: fix semantic issues * edit error message Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * edit error message Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * edit doc comment Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> --------- Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> Co-authored-by: Tóth Krisztián Gyula <ktothdev@gmail.com> * Update for removed check for privilege escalation for creating a user and editing assigned roles (#127) * docs: error response when external auth is enabled In this case, the external authentication system is used to manage password change * style: fix semantic issues * edit error message Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * edit error message Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * edit doc comment Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * doc: adjust error message for removed privilege escalation * doc: move response to appropriate area * doc: update description * doc: delete error response * refactor: group status response --------- Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Get all users include/exclude nested data (#132) * docs: Get all users include/exclude nested data * Update apiary.apib Co-authored-by: mrnyax <nyakoria@gmail.com> * Update apiary.apib Co-authored-by: mrnyax <nyakoria@gmail.com> * style: Simplify * Update apiary.apib Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> --------- Co-authored-by: mrnyax <nyakoria@gmail.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Remove note about valid access token needed (#136) + In context this should be clear its neccessarry for the action * Fix three minor typos on line 261. (#137) * Resolve conflicts with main (#138) * Actualize main for 2021.12 rollout (#95) * Docs/dev 26614 change license type (#58) * docs: add section for update license type * docs: fix Response 400 section and indentations * docs: use "User" attribute object instead of "Role" * docs: add missing 200 response for roles request * docs: add privilege note only for license type change * docs: use enum for UserLicense * docs: add 409 response * docs: add 409 response for license contract change * style: white space formatting * docs: Add request to Postman collection Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> * Migrate Travis CI job to GitHub actions (#59) * chore: Remove travis.yml + But keep as old.travis.yml * feat: Add initial GitHub actions.yml + Name: Lint API Blueprint + Uses: node 12.x + Steps: npm run lint * chore: Add npm ci step to install deps * chore: Delete old.travis.yml * feat: Run only on push apiary.apib * chore: Added ending newline * Revert "feat: Run only on push apiary.apib" This reverts commit a1e5c991878d4b96064c698d2c21d2479881f4d5. Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> * docs/remove specific changes (#60) * docs: remove section * docs: apply changes to postman collection * Build preview from develop branch * Added info about pagination (#62) * docs: added docs for pagination parameters and how response changes * docs: added more details about pagination * added explanation of query parameters to the `Request` section * added example URLs to `links` object in `Response` section * added a note that the example response contains URLs for pagination * docs: add pagination data structure for links attribute * docs: added pagination parameters to request section Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> * DEV-26948 Add missing auth headers to requests (#64) * Add X-Acrolinx-Auth header to User API requests + Add '+ Requests' where missing * Add X-Acrolinx-Auth header to Role API requests + Add missing + Request block * Add X-Acrolinx-Auth header to Checking API requests * fix: URI parameters section parent should be a Resource or Action section + Fixng parameters or its description not showing up in some request cases * fix: Add parameters section to some Role API resources * fix: Move parameters out from request section + Fix parameter not showing up for request Get Link to Content Analysis Dashboard Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> * Develop to Main (#61) (#65) * docs/dev 26614 change license type (#58) * docs: add section for update license type * docs: fix Response 400 section and indentations * docs: use "User" attribute object instead of "Role" * docs: add missing 200 response for roles request * docs: add privilege note only for license type change * docs: use enum for UserLicense * docs: add 409 response * docs: add 409 response for license contract change * style: white space formatting * docs: Add request to Postman collection * Migrate Travis CI job to GitHub actions (#59) * chore: Remove travis.yml + But keep as old.travis.yml * feat: Add initial GitHub actions.yml + Name: Lint API Blueprint + Uses: node 12.x + Steps: npm run lint * chore: Add npm ci step to install deps * chore: Delete old.travis.yml * feat: Run only on push apiary.apib * chore: Added ending newline * Revert "feat: Run only on push apiary.apib" This reverts commit a1e5c991878d4b96064c698d2c21d2479881f4d5. * docs/remove specific changes (#60) * docs: remove section * docs: apply changes to postman collection * Build preview from develop branch Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com> * Ux writers edits (#66) * Develop to Main (#61) * docs/dev 26614 change license type (#58) * docs: add section for update license type * docs: fix Response 400 section and indentations * docs: use "User" attribute object instead of "Role" * docs: add missing 200 response for roles request * docs: add privilege note only for license type change * docs: use enum for UserLicense * docs: add 409 response * docs: add 409 response for license contract change * style: white space formatting * docs: Add request to Postman collection * Migrate Travis CI job to GitHub actions (#59) * chore: Remove travis.yml + But keep as old.travis.yml * feat: Add initial GitHub actions.yml + Name: Lint API Blueprint + Uses: node 12.x + Steps: npm run lint * chore: Add npm ci step to install deps * chore: Delete old.travis.yml * feat: Run only on push apiary.apib * chore: Added ending newline * Revert "feat: Run only on push apiary.apib" This reverts commit a1e5c991878d4b96064c698d2c21d2479881f4d5. * docs/remove specific changes (#60) * docs: remove section * docs: apply changes to postman collection * Build preview from develop branch * Added notes about authentication to user/role api * Update apiary.apib * docs: resolve minor typos * docs: remove datastructures url comment * Update apiary.apib * docs: remove duplicate /api/v1/user/self Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com> Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> * DEV-27221: User API pagination update (#67) * docs: add 400 response for per_page param and note on omitted links * docs: remove other draft api section * docs: add line to include headers for next/prev values * docs: add note on data source change during pagination call (#68) * docs: add note on data source change during pagination call * docs: sentence changes * UX writer edits to pagination draft (#69) * DEV-26981 Create user with custom field values (#70) * docs: Add Request Create a user with specified custom field values + Example response: Value not in Possible values error with status code 400 * fix: Linting issue * docs: Add error response example for unkown custom field speciefied on user create * fix: Correct a typo * Update apiary.apib Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> * fix: Omit empty privielges from User.roles[] response model (#73) Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> * DEV-27658: add functionality to sort by user custom fields (#77) * feat: Add custom key(customFields.{key}) as sortable parameter * fix: modify regex to allow sort with '.' * refactor: add note on how to use customFields.{key} * docs: add error response for invalid custom field value * docs: edit sort note * docs: rename comment * docs: edit error message * docs: add error response for null or empty custom field * docs: edit error message when custom field cannot be found * docs: add note about using custom fields to sort * docs: edit sort note * style: indentation fix Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> * devx: add build badge (#78) * docs: update regex (#83) * docs: update regex * docs: update sort API description Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> * DEV-27630 Document User API endpoint(s) for request user(s) to update custom field value (#86) * docs: Add section Request actualize Custom field values (single user) + Under the User Commands group + Example request and response * docs: Add some notes to the request + Mentioning the required privilege to perform the request * fix: Fix some typos * docs: Add the bulk request variant + Example request and success response * docs: Fix bulk response status codes after copy&paste * docs: Add example bulk request with invalid userids to showcase possible errors + Change in note to be gender neutral * fix: Linting issue * docs: Fix style issues * docs: User Information Update Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix description Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix request name Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix bulk request name Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix description in bulk Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix note in single request Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix bulk note about limitations Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix request naming Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Rename to Request User Information Update in Bulk * Update apiary.apib Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix error example should be singular * Update apiary.apib Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * DEV-27677 I can delete users in bulk (#87) * docs: add bulk delete API documentation * style: adjust indentation * style: adjust result indentation * docs: update result description * docs: cleanup documentation * docs: remove location field with null values * style: indentation adjustment * docs: lowercase for starting comments * docs: add documentation for bulk delete unknown/invalid user ids * docs: update null as bad request * docs: apply review suggestions * docs: add sample request with errors in response * docs: update description for API request * docs: moved comment to description section * docs: rename delete to deleted * docs: update sentence for request of users that cannot be deleted Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> * DEV-27807 Allow correct sorting by license status if the user has the license type Named user (#88) * docs: add note on sort by licenseType * docs: add fullstop * docs: note formatting Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> * DEV-27658: allowed special characters in custom field keys (#90) * docs: add note on allowed special chars for custom fields * docs: move special char text to a paragraph * Edits from docs team (#92) * Update apiary.apib * Update apiary.apib Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> * 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> * DEV-27658 Replace null custom field value with empty string (#93) * docs: add description when custom field has empty values Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> * term API doc: added referenced ACTIF sample file (#89) * term API doc: added referenced ACTIF sample file * term API doc: clarified "create entries" response * addressed Madeline's questions * apply Madeline's final suggestions for clarity/style Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * DEV-26980 Improve error response (#94) * docs: error message when creating user with more previleges than current user * docs: error message when you create/edit user with more previleges than you * docs: update error detail Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com> Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> Co-authored-by: mrnyax <nyakoria@gmail.com> Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: Robert Grabowski <robert.grabowski@acrolinx.com> * DEV-28485: add section on random password generation (#106) * docs: add section on random password generation * docs: bump core platform version to .03 * docs: end sentences with period in note * docs: change sub-group name to Random Passwords * docs: replace "comply with" by "meet" * docs: tweak sentence for convenient user creation * docs: update sentences to meet ux standard * docs: update 403 response comment * docs: update 503 response comment Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * DEV-29043 Custom Field API to get defined user custom fields (#111) * docs: add custom fields API to docs * docs: add note on privileges * docs: add response for missing/invalid token * docs: update CFs release version * docs: clean json response Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> * Extend documentation of CheckRequest.language (#112) Add documentation about what values to use for CheckRequest.language, extend description of the default. * Edits to custom fields API text (#113) * DEV-30814 Removing unused value * Develop (#122) * DEV-28485: add section on random password generation (#106) * docs: add section on random password generation * docs: bump core platform version to .03 * docs: end sentences with period in note * docs: change sub-group name to Random Passwords * docs: replace "comply with" by "meet" * docs: tweak sentence for convenient user creation * docs: update sentences to meet ux standard * docs: update 403 response comment * docs: update 503 response comment Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * DEV-29043 Custom Field API to get defined user custom fields (#111) * docs: add custom fields API to docs * docs: add note on privileges * docs: add response for missing/invalid token * docs: update CFs release version * docs: clean json response Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> * Extend documentation of CheckRequest.language (#112) Add documentation about what values to use for CheckRequest.language, extend description of the default. * Edits to custom fields API text (#113) * DEV-28754 Query users with missing required custom fields (#114) * docs: Add section ## Missing Required User Custom Fields + ### Count Users [HEAD /api/v1/user/custom-fields-missing] + ### Get Users [GET /api/v1/user/custom-fields-missing{?page,per_page}] * docs: Add comment see pagination details documented elsewhere * Update description Fix phrasing Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> * Update apiary.apib Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> * Update apiary.apib Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib UX writers edits Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib UX writers edits Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib UX writers edits Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib UX writers edits Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib UX writers edits Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib UX writers edits Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Update apiary.apib UX writers edits Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: UX writers recommendation Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * DEV-29342: update pagination params error responses (#115) * style: replace char u+2019 with standard single quote apostrophe * docs: add error responses for invalid page param * docs: add error responses for invalid page param for custom-fields-missing api * docs: add section for health/status end point (#118) * docs: add section for health/status end point * docs: add description for health/status api path * docs: add Get Health Liveliness section * chore: add missing brace and format response codes * docs: ux string changes Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * Add guidelineId to issues in examples (#120) Since 2022.10 Acrolinx returns a guidelineId for issues. This commit adds this field to the examples. * DEV-30375 change from optional -> recommended (#117) * Actualize main for 2021.12 rollout (#95) * Docs/dev 26614 change license type (#58) * docs: add section for update license type * docs: fix Response 400 section and indentations * docs: use "User" attribute object instead of "Role" * docs: add missing 200 response for roles request * docs: add privilege note only for license type change * docs: use enum for UserLicense * docs: add 409 response * docs: add 409 response for license contract change * style: white space formatting * docs: Add request to Postman collection Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> * Migrate Travis CI job to GitHub actions (#59) * chore: Remove travis.yml + But keep as old.travis.yml * feat: Add initial GitHub actions.yml + Name: Lint API Blueprint + Uses: node 12.x + Steps: npm run lint * chore: Add npm ci step to install deps * chore: Delete old.travis.yml * feat: Run only on push apiary.apib * chore: Added ending newline * Revert "feat: Run only on push apiary.apib" This reverts commit a1e5c991878d4b96064c698d2c21d2479881f4d5. Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> * docs/remove specific changes (#60) * docs: remove section * docs: apply changes to postman collection * Build preview from develop branch * Added info about pagination (#62) * docs: added docs for pagination parameters and how response changes * docs: added more details about pagination * added explanation of query parameters to the `Request` section * added example URLs to `links` object in `Response` section * added a note that the example response contains URLs for pagination * docs: add pagination data structure for links attribute * docs: added pagination parameters to request section Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> * DEV-26948 Add missing auth headers to requests (#64) * Add X-Acrolinx-Auth header to User API requests + Add '+ Requests' where missing * Add X-Acrolinx-Auth header to Role API requests + Add missing + Request block * Add X-Acrolinx-Auth header to Checking API requests * fix: URI parameters section parent should be a Resource or Action section + Fixng parameters or its description not showing up in some request cases * fix: Add parameters section to some Role API resources * fix: Move parameters out from request section + Fix parameter not showing up for request Get Link to Content Analysis Dashboard Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> * Develop to Main (#61) (#65) * docs/dev 26614 change license type (#58) * docs: add section for update license type * docs: fix Response 400 section and indentations * docs: use "User" attribute object instead of "Role" * docs: add missing 200 response for roles request * docs: add privilege note only for license type change * docs: use enum for UserLicense * docs: add 409 response * docs: add 409 response for license contract change * style: white space formatting * docs: Add request to Postman collection * Migrate Travis CI job to GitHub actions (#59) * chore: Remove travis.yml + But keep as old.travis.yml * feat: Add initial GitHub actions.yml + Name: Lint API Blueprint + Uses: node 12.x + Steps: npm run lint * chore: Add npm ci step to install deps * chore: Delete old.travis.yml * feat: Run only on push apiary.apib * chore: Added ending newline * Revert "feat: Run only on push apiary.apib" This reverts commit a1e5c991878d4b96064c698d2c21d2479881f4d5. * docs/remove specific changes (#60) * docs: remove section * docs: apply changes to postman collection * Build preview from develop branch Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com> * Ux writers edits (#66) * Develop to Main (#61) * docs/dev 26614 change license type (#58) * docs: add section for update license type * docs: fix Response 400 section and indentations * docs: use "User" attribute object instead of "Role" * docs: add missing 200 response for roles request * docs: add privilege note only for license type change * docs: use enum for UserLicense * docs: add 409 response * docs: add 409 response for license contract change * style: white space formatting * docs: Add request to Postman collection * Migrate Travis CI job to GitHub actions (#59) * chore: Remove travis.yml + But keep as old.travis.yml * feat: Add initial GitHub actions.yml + Name: Lint API Blueprint + Uses: node 12.x + Steps: npm run lint * chore: Add npm ci step to install deps * chore: Delete old.travis.yml * feat: Run only on push apiary.apib * chore: Added ending newline * Revert "feat: Run only on push apiary.apib" This reverts commit a1e5c991878d4b96064c698d2c21d2479881f4d5. * docs/remove specific changes (#60) * docs: remove section * docs: apply changes to postman collection * Build preview from develop branch * Added notes about authentication to user/role api * Update apiary.apib * docs: resolve minor typos * docs: remove datastructures url comment * Update apiary.apib * docs: remove duplicate /api/v1/user/self Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com> Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> * DEV-27221: User API pagination update (#67) * docs: add 400 response for per_page param and note on omitted links * docs: remove other draft api section * docs: add line to include headers for next/prev values * docs: add note on data source change during pagination call (#68) * docs: add note on data source change during pagination call * docs: sentence changes * UX writer edits to pagination draft (#69) * DEV-26981 Create user with custom field values (#70) * docs: Add Request Create a user with specified custom field values + Example response: Value not in Possible values error with status code 400 * fix: Linting issue * docs: Add error response example for unkown custom field speciefied on user create * fix: Correct a typo * Update apiary.apib Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> * fix: Omit empty privielges from User.roles[] response model (#73) Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> * DEV-27658: add functionality to sort by user custom fields (#77) * feat: Add custom key(customFields.{key}) as sortable parameter * fix: modify regex to allow sort with '.' * refactor: add note on how to use customFields.{key} * docs: add error response for invalid custom field value * docs: edit sort note * docs: rename comment * docs: edit error message * docs: add error response for null or empty custom field * docs: edit error message when custom field cannot be found * docs: add note about using custom fields to sort * docs: edit sort note * style: indentation fix Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> * devx: add build badge (#78) * docs: update regex (#83) * docs: update regex * docs: update sort API description Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> * DEV-27630 Document User API endpoint(s) for request user(s) to update custom field value (#86) * docs: Add section Request actualize Custom field values (single user) + Under the User Commands group + Example request and response * docs: Add some notes to the request + Mentioning the required privilege to perform the request * fix: Fix some typos * docs: Add the bulk request variant + Example request and success response * docs: Fix bulk response status codes after copy&paste * docs: Add example bulk request with invalid userids to showcase possible errors + Change in note to be gender neutral * fix: Linting issue * docs: Fix style issues * docs: User Information Update Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix description Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix request name Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix bulk request name Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix description in bulk Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix note in single request Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix bulk note about limitations Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix request naming Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Rename to Request User Information Update in Bulk * Update apiary.apib Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * docs: Fix error example should be singular * Update apiary.apib Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * DEV-27677 I can delete users in bulk (#87) * docs: add bulk delete API documentation * style: adjust indentation * style: adjust result indentation * docs: update result description * docs: cleanup documentation * docs: remove location field with null values * style: indentation adjustment * docs: lowercase for starting comments * docs: add documentation for bulk delete unknown/invalid user ids * docs: update null as bad request * docs: apply review suggestions * docs: add sample request with errors in response * docs: update description for API request * docs: moved comment to description section * docs: rename delete to deleted * docs: update sentence for request of users that cannot be deleted Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> * DEV-27807 Allow correct sorting by license status if the user has the license type Named user (#88) * docs: add note on sort by licenseType * docs: add fullstop * docs: note formatting Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> * DEV-27658: allowed special characters in custom field keys (#90) * docs: add note on allowed special chars for custom fields * docs: move special char text to a paragraph * Edits from docs team (#92) * Update apiary.apib * Update apiary.apib Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> * 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> * DEV-27658 Replace null custom field value with empty string (#93) * docs: add description when custom field has empty values Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> * term API doc: added referenced ACTIF sample file (#89) * term API doc: added referenced ACTIF sample file * term API doc: clarified "create entries" response * addressed Madeline's questions * apply Madeline's final suggestions for clarity/style Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * DEV-26980 Improve error response (#94) * docs: error message when creating user with more previleges than current user * docs: error message when you create/edit user with more previleges than you * docs: update error detail Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com> Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> Co-authored-by: mrnyax <nyakoria@gmail.com> Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: Robert Grabowski <robert.grabowski@acrolinx.com> * DEV-28485: add section on random password generation (#106) * docs: add section on random password generation * docs: bump core platform version to .03 * docs: end sentences with period in note * docs: change sub-group name to Random Passwords * docs: replace "comply with" by "meet" * docs: tweak sentence for convenient user creation * docs: update sentences to meet ux standard * docs: update 403 response comment * docs: update 503 response comment Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> * DEV-29043 Custom Field API to get defined user custom fields (#111) * docs: add custom fields API to docs * docs: add note on privileges * docs: add response for missing/invalid token * docs: update CFs release version * docs: clean json response Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> * Extend documentation of CheckRequest.language (#112) Add documentation about what values to use for CheckRequest.language, extend description of the default. * Edits to custom fields API text (#113) * DEV-30375 change from ooptional -> recommended --------- Co-authored-by: Tóth Krisztián Gyula <t.krisztian95@gmail.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com> Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> Co-authored-by: mrnyax <nyakoria@gmail.com> Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: Robert Grabowski <robert.grabowski@acrolinx.com> Co-authored-by: replrep <32941710+replrep@users.noreply.github.com> * docs: remove duplicate section for random passwords api (#123) --------- Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> Co-authored-by: mrnyax <nyakoria@gmail.com> Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: replrep <32941710+replrep@users.noreply.github.com> Co-authored-by: Tóth Krisztián Gyula <t.krisztian95@gmail.com> Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: Alexander Kauer <alexander.kauer@acrolinx.com> Co-authored-by: Abhijeet Narvekar <abhijeet7222@gmail.com> Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com> Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> Co-authored-by: Robert Grabowski <robert.grabowski@acrolinx.com> * fix: Remove duplicate of Random Passwords (#124) * fix: Remove duplicate of ## Random Passwords * fix: Delete leftover part * fix: Locales is an array (#128) * fix: Remove contetn type for Response 204 (#129) * fix: Remove extra bracket (#130) * fix: Use array with fixed type CustomField (#131) --------- Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com> Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com> Co-authored-by: mrnyax <nyakoria@gmail.com> Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: Robert Grabowski <robert.grabowski@acrolinx.com> Co-authored-by: replrep <32941710+replrep@users.noreply.github.com> Co-authored-by: Paresh Deshmukh <paresh.deshmukh@acrolinx.com> Co-authored-by: hjohannsen <39583180+hjohannsen@users.noreply.github.com> Co-authored-by: Alexander Kauer <alexander.kauer@acrolinx.com> Co-authored-by: Abhijeet Narvekar <abhijeet7222@gmail.com> * Resolve merge conflicts (#141) * Actualize main for 2021.12 rollout (#95) * Docs/dev 26614 change license type (#58) * docs: add section for update license type * docs: fix Response 400 section and indentations * docs: use "User" attribute object instead of "Role" * docs: add missing 200 response for roles request * docs: add privilege note only for license type change * docs: use enum for UserLicense * docs: add 409 response * docs: add 409 response for license contract change * style: white space formatting * docs: Add request to Postman collection Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> * Migrate Travis CI job to GitHub actions (#59) * chore: Remove travis.yml + But keep as old.travis.yml * feat: Add initial GitHub actions.yml + Name: Lint API Blueprint + Uses: node 12.x + Steps: npm run lint * chore: Add npm ci step to install deps * chore: Delete old.travis.yml * feat: Run only on push apiary.apib * chore: Added ending newline * Revert "feat: Run only on push apiary.apib" This reverts commit a1e5c991878d4b96064c698d2c21d2479881f4d5. Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> * docs/remove specific changes (#60) * docs: remove section * docs: apply changes to postman collection * Build preview from develop branch * Added info about pagination (#62) * docs: added docs for pagination parameters and how response changes * docs: added more details about pagination * added explanation of query parameters to the `Request` section * added example URLs to `links` object in `Response` section * added a note that the example response contains URLs for pagination * docs: add pagination data structure for links attribute * docs: added pagination parameters to request section Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> * DEV-26948 Add missing auth headers to requests (#64) * Add X-Acrolinx-Auth header to User API requests + Add '+ Requests' where missing * Add X-Acrolinx-Auth header to Role API requests + Add missing + Request block * Add X-Acrolinx-Auth header to Checking API requests * fix: URI parameters section parent should be a Resource or Action section + Fixng parameters or its description not showing up in some request cases * fix: Add parameters section to some Role API resources * fix: Move parameters out from request section + Fix parameter not showing up for request Get Link to Content Analysis Dashboard Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> * Develop to Main (#61) (#65) * docs/dev 26614 change license type (#58) * docs: add section for update license type * docs: fix Response 400 section and indentations * docs: use "User" attribute object instead of "Role" * docs: add missing 200 response for roles request * docs: add privilege note only for license type change * docs: use enum for UserLicense * docs: add 409 response * docs: add 409 response for license contract change * style: white space formatting * docs: Add request to Postman collection * Migrate Travis CI job to GitHub actions (#59) * chore: Remove travis.yml + But keep as old.travis.yml * feat: Add initial GitHub actions.yml + Name: Lint API Blueprint + Uses: node 12.x + Steps: npm run lint * chore: Add npm ci step to install deps * chore: Delete old.travis.yml * feat: Run only on push apiary.apib * chore: Added ending newline * Revert "feat: Run only on push apiary.apib" This reverts commit a1e5c991878d4b96064c698d2c21d2479881f4d5. * docs/remove specific changes (#60) * docs: remove section * docs: apply changes to postman collection * Build preview from develop branch Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com> * Ux writers edits (#66) * Develop to Main (#61) * docs/dev 26614 change license type (#58) * docs: add section for update license type * docs: fix Response 400 section and indentations * docs: use "User" attribute object instead of "Role" * docs: add missing 200 response for roles request * docs: add privilege note only for license type change * docs: use enum for UserLicense * docs: add 409 response * docs: add 409 response for license contract change * style: white space formatting * docs: Add request to Postman collection * Migrate Travis CI job to GitHub actions (#59) * chore: Remove travis.yml + But keep as old.travis.yml * feat: Add initial GitHub actions.yml + Name: Lint API Blueprint + Uses: node 12.x + Steps: npm run lint * chore: Add npm ci step to install deps * chore: Delete old.travis.yml * feat: Run only on push apiary.apib * chore: Added ending newline * Revert "feat: Run only on push apiary.apib" This reverts commit a1e5c991878d4b96064c698d2c21d2479881f4d5. * docs/remove specific changes (#60) * docs: remove section * docs: apply changes to postman collection * Build preview from develop branch * Added notes about authentication to user/role api * Update apiary.apib * docs: resolve minor typos * docs: remove datastructures url comment * Update apiary.apib * docs: remove duplicate /api/v1/user/self Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com> Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> * DEV-27221: User API pagination update (#67) * docs: add 400 response for per_page param and note on omitted links * docs: remove other draft api section * docs: add line to include headers for next/prev values * docs: add note on data source change during pagination call (#68) * docs: add note on data source change during pagination call * docs: sentence changes * UX writer edits to pagination draft (#69) * DEV-26981 Create user with custom field values (#70) * docs: Add Request Create a user with specified custom field values + Example response: Value not in Possible values error with status code 400 * fix: Linting issue * docs: Add error response example for unkown custom field speciefied on user create * fix: Correct a typo * Update apiary.apib Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> Co-authored-by: George Haddad <george-haddad@users.noreply.github.com> * fix: Omit empty privielges from User.roles[] response model (#73) Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com> * DEV-27658: add functionality to sort by user custom fields (#77) * feat: Add custom key(customFields.{key}) as sortable parameter * fix: modify regex to allow sort with '.' * refactor: add note on how to use customFields.{key} * docs: add error response for invalid custom field value * docs: edit sort note * docs: rename comment * docs: edit error message * docs: add error response for null or empty custom field * docs: edit error message when custom field cannot be found * docs: add note about using custom fields to sort * docs: edit sort note * style: indentation fix Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> Co-authored-by: Georges El Haddad <georges.elhaddad@acrolinx.com> * devx: add build badge (#78) * docs: update regex (#83) * docs: update regex * docs: update sort API description Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com> * DEV-27630 Document User API endpoint(s) for request user(s) to update custom field value (#86) * docs: Add section Request actualize Custom field values (single user) + Under the User Commands group + Example request and response * docs: Add some notes to the reques…
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update API documentation for removed privilege escalation.
With the changes, only Super Admin role is checked/required when creating or editing a user to assign the Super Admin role