TES-27473: document new User Access Key endpoints#31
Open
liorama wants to merge 1 commit into
Open
Conversation
Add OpenAPI definitions for the five UAK-authenticated endpoints introduced in Tricentis-testimio/testimio#11903: - GET /projects/{projectId}/users - GET /projects/{projectId}/users/activity - POST /projects/{projectId}/users/invite - DELETE /projects/{projectId}/users/remove - POST /companies/{companyId}/projects Adds the userAccessKeyAuth security scheme, response shapes (projectUsers, activity with current/previous ISO date windows, create-project 201 with id), the Forbidden 403 component, and uakMetaData (companyId, conditional monthly counters).
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Documents the five User Access Key (UAK) endpoints added by testimio/testimio#11903, matching the Engineering Design: user REST API spec.
GET /projects/{projectId}/usersreturns{ projectUsers, metaData }.GET /projects/{projectId}/users/activityreturns{ activity: { [email]: { name, current, previous } }, metaData }with optionalpreviousPeriodDaysquery (1-365, default 30) and ISOYYYY-MM-DDdates.POST /projects/{projectId}/users/invitereturns{ success, metaData }; rejects empty/invalid email arrays with400 ClientError.DELETE /projects/{projectId}/users/removereturns{ success, metaData }; silently skips emails that don't match a user in the project; still enforces self/owner/company-owner guards.POST /companies/{companyId}/projectsreturns201 { success: true, id, metaData }.Adds the
userAccessKeyAuthsecurity scheme (x-user-access-keyheader,UAK-<base64(userId)>-<base64(secret)>format), theForbidden403 response component, anduakMetaData(includescompanyId;currentRequestCount/monthlyRequestLimitonly when both are populated).Test plan
npx js-yaml api.yamlparses cleanly.