Skip to content

Commit d602850

Browse files
committed
Merge branch 'release'
2 parents 9d13139 + b77e271 commit d602850

File tree

21 files changed

+157
-93
lines changed

21 files changed

+157
-93
lines changed

.github/workflows/ci-workflow.yml

Lines changed: 25 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Frontend & Docker CI Workflow
1+
name: build & unit test, build Docker image, run E2E tests
22

33
on:
44
push:
@@ -11,13 +11,17 @@ on:
1111
tags:
1212
- '**'
1313
delete:
14+
pull_request:
15+
types: [opened, reopened, synchronize]
16+
paths-ignore:
17+
- 'docs/**'
1418

15-
jobs:
16-
call-frontend-ci-workflow:
19+
jobs:
20+
build-and-unit-test:
1721
uses: netcracker/qubership-apihub-ci/.github/workflows/frontend-ci.yaml@main
18-
call-docker-ci-workflow:
19-
needs: call-frontend-ci-workflow
20-
if: github.event_name == 'push'
22+
build-docker-image:
23+
needs: build-and-unit-test
24+
if: (github.event_name == 'push') || (github.event_name == 'pull_request')
2125
uses: netcracker/qubership-apihub-ci/.github/workflows/docker-ci.yml@main
2226
with:
2327
name: qubership-apihub-ui
@@ -26,6 +30,20 @@ jobs:
2630
platforms: linux/amd64,linux/arm64
2731
labels: |
2832
maintainer=qubership
29-
npm-package-version=${{ needs.call-frontend-ci-workflow.outputs.package_version }}
33+
npm-package-version=${{ needs.build-and-unit-test.outputs.package_version }}
3034
secrets:
3135
NPMRC: ${{ secrets.NPMRC }}
36+
run-e2e-tests:
37+
uses: netcracker/qubership-apihub-ci/.github/workflows/run-e2e-tests.yml@main
38+
needs: build-docker-image
39+
if: github.event_name == 'pull_request'
40+
with:
41+
postman-collections-run: false
42+
apihub-ui-image-tag: ${{ needs.build-docker-image.outputs.image_tag }}
43+
# apihub-backend-image-tag: dev
44+
# apihub-build-task-consumer-image-tag: dev
45+
secrets:
46+
APIHUB_ACCESS_TOKEN: ${{ secrets.APIHUB_ACCESS_TOKEN }}
47+
APIHUB_ADMIN_EMAIL: ${{ secrets.APIHUB_ADMIN_EMAIL }}
48+
APIHUB_ADMIN_PASSWORD: ${{ secrets.APIHUB_ADMIN_PASSWORD }}
49+
JWT_PRIVATE_KEY: ${{ secrets.JWT_PRIVATE_KEY }}

docs/Portal User Guide.md

Lines changed: 36 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1257,28 +1257,32 @@ For example, you have 3 operations - GET /api/v1/packages, GET /api/v1/package/{
12571257

12581258
When you specify value of the parameter, there is an option "Recalculate groups in all published versions". If you select it, then after saving the value of the parameter, the system re-calculates groups for all existing versions of current package. If you do not select recalculate option, then configuration will be applied only for the newly published versions.
12591259

1260-
**Versions**
1260+
## Versions
12611261
The Versions tab contains a list of all versions published in the current package or dashboard. You can edit status and/or labels of the version, to do this, hover over the row with the required version and click **Edit**.
12621262

12631263
On the current page you can also delete version (with all its revisions). To do this, hover over the row with the required version and click **Delete**.
12641264

1265-
**Access Tokens**
1266-
In the Access Tokens tab contains you can generate API key for the current group/package/dashboard. API key does not have a period of life and it must be stored on a client side because it shows only once after generation.
1265+
## Access Tokens
12671266

1268-
To generate an access token, you need to fill the following fields:
1269-
- Name - unique API key name
1267+
API key allows you to authenticate to APIHUB when using APIHUB API. Unlike a Bearer token or [personal access token](#personal-access-token), an API key does not identify the principal (user). Instead, it is primarily used to identify the calling project—such as an application or website—making the APIHUB API call.
1268+
API key is associated with a specific workspace, group, package, or dashboard, limiting its scope. API key does not have a period of life and it must be stored on a client side because it shows only once after generation.
1269+
1270+
To generate an API key, fill the following fields:
1271+
- Name - unique API key name.
12701272
- Roles - optional field. This field defines the role(s) (i.e. set of permissions) associated with the API key. Multiple values are allowed. If you do not specify a role, the roles of the user who generated the token will be used by default.
1271-
- Created For - owner of the API key. By default, owner of key is current user.
1272-
Once you fill in the required fields, click the Generate button. The system generates the token and displays it. If you leave the page or reload it, the token is not shown again.
1273-
To delete the generated token, hover over the desired token and click **Revoke**.
1273+
- Created For - owner of the API key. By default, owner of key is current user.
1274+
1275+
Once you fill in the required fields, click the **Generate** button. The system generates the token and displays it. If you leave the page or reload it, the token is not shown again.
1276+
1277+
To delete API key, hover over the API key and click **Revoke**.
12741278

12751279

12761280
## User Access Control
12771281
User Access Control tab allows you to manage members of group/package/dashboard and their roles.
12781282

12791283
- User **role** is an entity with a specific set of permissions. You can always see list of available roles and their permissions if you click on question mark on User Access Control page. Roles have hierarchical structure, so even if you have permission to assign roles to the users, you cannot assign the role which is higher than your own role.
12801284
- **Member** is a user which is added to the package/dashboard/group with some role(s). One member can have multiple roles in this case, the list of permissions from each specified role will be combined for the current user.
1281-
Member's roles are inherited from parent groups and workspaces. If some role was assigned to the user, for example, in the group, then it is impossible to remove this role on the child package/package/dashboard. However you can add additional role on the child package/package/dashboard.
1285+
Member's roles are inherited from parent groups and workspaces. If some role was assigned to the user, for example, in the group, then it is impossible to remove this role on the child package/package/dashboard. However, you can add additional role on the child package/package/dashboard.
12821286

12831287
To add a new member to the package:
12841288
1. Click **Add User**.
@@ -1292,3 +1296,26 @@ To update the role of an existing member:
12921296
To remove a member from the package/dashboard/group:
12931297
1. Hover over the row of the required member and click **Delete**.
12941298
2. You cannot remove a member from the package the member has at least one inherited role or if member have at least one role that is higher than your own role in the current package/dashboard/group.
1299+
1300+
# My Profile
1301+
1302+
My Profile page contains your personal settings of APIHUB. To access this page, click on your username located in the top-right corner of the portal header and select My Profile.
1303+
1304+
The following tabs are available in the My Profile page:
1305+
1306+
- **Personal Access Tokens** – allows you to manage your personal access tokens.
1307+
1308+
## Personal Access Tokens
1309+
1310+
Personal access tokens are an alternative to using API key or Bearer token for authentication to APIHUB when using APIHUB API. Personal access tokens are designed to access APIHUB resources on your behalf.
1311+
1312+
To generate a personal access token:
1313+
1. Open Personal Access Tokens tab in My Profile page.
1314+
2. Enter a unique token name and select the expiration date.
1315+
3. Click **Generate** button. The system generates the token and displays it. Copy and store the token securely, as it will only be displayed once. If you leave the page or reload it, the token will no longer be shown.
1316+
1317+
When a token expires, it becomes inactive and can no longer be used to authenticate to APIHUB.
1318+
1319+
**Note**: You can have up to 100 personal access tokens. If you already have 100 tokens, you must delete some before generating a new one.
1320+
1321+
To delete the personal access token, hover over the token and click **Revoke**.

lerna.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
22
"$schema": "node_modules/lerna/schemas/lerna-schema.json",
3-
"version": "2.10.1"
3+
"version": "2.11.0"
44
}

package-lock.json

Lines changed: 26 additions & 26 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,12 +33,12 @@
3333
"@mui/lab": "5.0.0-alpha.120",
3434
"@mui/material": "5.11.10",
3535
"@mui/private-theming": "5.11.9",
36-
"@netcracker/qubership-apihub-api-diff": "1.0.4",
37-
"@netcracker/qubership-apihub-api-doc-viewer": "2.0.6",
38-
"@netcracker/qubership-apihub-api-processor": "3.0.6",
36+
"@netcracker/qubership-apihub-api-diff": "1.1.0",
37+
"@netcracker/qubership-apihub-api-doc-viewer": "2.0.7",
38+
"@netcracker/qubership-apihub-api-processor": "3.1.0",
3939
"@netcracker/qubership-apihub-api-unifier": "1.0.4",
4040
"@netcracker/qubership-apihub-api-visitor": "1.0.5",
41-
"@netcracker/qubership-apihub-apispec-view": "1.0.23",
41+
"@netcracker/qubership-apihub-apispec-view": "1.0.24",
4242
"@netcracker/qubership-apihub-class-view": "1.0.3",
4343
"@netcracker/qubership-apihub-rest-playground": "1.0.8",
4444
"@otjs/monaco": "0.2.2",

packages/agents/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@netcracker/qubership-apihub-ui-agents",
3-
"version": "2.10.1",
3+
"version": "2.11.0",
44
"license": "Apache-2.0",
55
"files": [
66
"/dist"

packages/editor/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@netcracker/qubership-apihub-ui-editor",
3-
"version": "2.10.1",
3+
"version": "2.11.0",
44
"license": "Apache-2.0",
55
"files": [
66
"/dist"

packages/editor/src/routes/root/EditorPage/ProjectEditorPage/ProjectEditorToolbar/PublishProjectVersionDialog.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ const PublishProjectVersionPopup: FC<PopupProps> = memo<PopupProps>(({ open, set
7777

7878
const defaultPackageKey = usePackageKey()
7979
const [versionsFilter, setVersionsFilter] = useState('')
80-
const [versions, areVersionsLoading] = usePackageVersions({ packageKey: defaultPackageKey, textFilter: versionsFilter })
80+
const { versions, areVersionsLoading } = usePackageVersions({ packageKey: defaultPackageKey, textFilter: versionsFilter })
8181

8282
const previousVersionOptions = usePreviousVersionOptions()
8383

packages/editor/src/routes/root/EditorPage/ProjectEditorPage/usePreviousVersionOptions.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ import { usePackageKey } from '../../usePackage'
2222

2323
export function usePreviousVersionOptions(): VersionKey[] {
2424
const defaultPackageKey = usePackageKey()
25-
const [versions] = usePackageVersions({ packageKey: defaultPackageKey, status: RELEASE_VERSION_STATUS })
25+
const { versions } = usePackageVersions({ packageKey: defaultPackageKey, status: RELEASE_VERSION_STATUS })
2626

2727
return useMemo(() => ([
2828
NO_PREVIOUS_RELEASE_VERSION_OPTION,

packages/portal/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@netcracker/qubership-apihub-ui-portal",
3-
"version": "2.10.1",
3+
"version": "2.11.0",
44
"license": "Apache-2.0",
55
"files": [
66
"/dist"

0 commit comments

Comments
 (0)