Skip to content

Commit

Permalink
fix: some minor fixes, update readme, update bff yaml (onecx#58)
Browse files Browse the repository at this point in the history
* feat: update bff yaml, new endpoint with improved data structure for remote components

* fix: remove favicon

* feat: edit readme for how to set up onecx shell

* fix:  some minor fixes, updated readme

---------

Co-authored-by: kim.tran <[email protected]>
  • Loading branch information
KimFFVII and kim.tran authored May 6, 2024
1 parent 969bdd2 commit f660f27
Show file tree
Hide file tree
Showing 4 changed files with 1 addition and 97 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ docker-compose up -d postgresdb traefik keycloak-app pgadmin
- shell bff
- permission svc
- product svc
- tenant svc
- theme svc
- user-profile svc
- workspace svc
Expand Down
1 change: 0 additions & 1 deletion project.json
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,6 @@
"options": {
"hmr": false,
"port": 4300,
"publicHost": "http://localhost:4300",
"proxyConfig": "proxy.conf.js"
}
},
Expand Down
3 changes: 0 additions & 3 deletions src/app/shared/generated/.openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ model/colorScheme.ts
model/getPermissionsRequest.ts
model/getPermissionsResponse.ts
model/getUserProfileResponse.ts
model/getWorkspaceConfigRequest.ts
model/getWorkspaceConfigResponse.ts
model/layoutAndThemeSettings.ts
model/loadWorkspaceConfigRequest.ts
model/loadWorkspaceConfigResponse.ts
Expand All @@ -28,7 +26,6 @@ model/problemDetailInvalidParam.ts
model/problemDetailParam.ts
model/problemDetailResponse.ts
model/remoteComponent.ts
model/remoteComponentMapping.ts
model/route.ts
model/slot.ts
model/technologies.ts
Expand Down
93 changes: 0 additions & 93 deletions src/assets/openapi/openapi-bff.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -34,33 +34,6 @@ paths:
$ref: '#/components/schemas/ProblemDetailResponse'
'404':
description: 'Not Found'
/workspaceConfig:
post:
tags:
- "WorkspaceConfig"
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GetWorkspaceConfigRequest'
operationId: getWorkspaceConfig
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GetWorkspaceConfigResponse'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetailResponse'
'404':
description: 'Not Found'

/workspaceConfig/themes/{name}/favicon:
get:
tags:
Expand Down Expand Up @@ -205,40 +178,6 @@ components:
type: array
items:
type: string
GetWorkspaceConfigResponse:
type: object
required:
- 'routes'
- 'theme'
- 'workspace'
- 'remoteComponents'
- 'shellRemoteComponents'
properties:
routes:
type: array
items:
$ref: '#/components/schemas/Route'
theme:
$ref: '#/components/schemas/Theme'
workspace:
$ref: '#/components/schemas/Workspace'
remoteComponents:
type: array
items:
$ref: '#/components/schemas/RemoteComponent'
shellRemoteComponents:
type: array
items:
$ref: '#/components/schemas/RemoteComponentMapping'

GetWorkspaceConfigRequest:
type: object
required:
- url
properties:
url:
type: string

GetPermissionsRequest:
type: object
required:
Expand All @@ -249,7 +188,6 @@ components:
type: string
productName:
type: string

Workspace:
type: object
required:
Expand All @@ -260,7 +198,6 @@ components:
type: string
baseUrl:
type: string

Theme:
required:
- name
Expand All @@ -286,7 +223,6 @@ components:
type: string
properties:
type: string

Route:
type: object
required:
Expand Down Expand Up @@ -320,15 +256,12 @@ components:
type: string
displayName:
type: string

Technologies:
type: string
enum: ['Angular', 'WebComponent']

PathMatch:
type: string
enum: ['full', 'prefix']

RemoteComponent:
type: object
required:
Expand All @@ -352,26 +285,13 @@ components:
type: string
exposedModule:
type: string

RemoteComponentMapping:
type: object
required:
- 'slotName'
- 'remoteComponent'
properties:
slotName:
type: string
remoteComponent:
type: string

GetUserProfileResponse:
type: object
required:
- 'userProfile'
properties:
userProfile:
$ref: '#/components/schemas/UserProfile'

UserProfile:
type: object
required:
Expand All @@ -386,7 +306,6 @@ components:
$ref: '#/components/schemas/UserPerson'
accountSettings:
$ref: '#/components/schemas/AccountSettings'

UserPerson:
type: object
properties:
Expand All @@ -402,7 +321,6 @@ components:
$ref: '#/components/schemas/UserPersonAddress'
phone:
$ref: '#/components/schemas/UserPersonPhone'

UserPersonAddress:
type: object
properties:
Expand All @@ -416,51 +334,43 @@ components:
type: string
country:
type: string

UserPersonPhone:
type: object
properties:
type:
$ref: '#/components/schemas/PhoneType'
number:
type: string

PhoneType:
type: string
enum: ['MOBILE', 'LANDLINE']

AccountSettings:
type: object
properties:
layoutAndThemeSettings:
$ref: '#/components/schemas/LayoutAndThemeSettings'
localeAndTimeSettings:
$ref: '#/components/schemas/LocaleAndTimeSettings'

LayoutAndThemeSettings:
type: object
properties:
colorScheme:
$ref: '#/components/schemas/ColorScheme'
menuMode:
$ref: '#/components/schemas/MenuMode'

ColorScheme:
type: string
enum: ['AUTO', 'LIGHT', 'DARK']

MenuMode:
type: string
enum: ['HORIZONTAL', 'STATIC', 'OVERLAY', 'SLIM', 'SLIMPLUS']

LocaleAndTimeSettings:
type: object
properties:
locale:
type: string
timezone:
type: string

GetPermissionsResponse:
type: object
required:
Expand All @@ -470,7 +380,6 @@ components:
type: array
items:
type: string

ProblemDetailResponse:
type: object
properties:
Expand All @@ -486,15 +395,13 @@ components:
type: array
items:
$ref: '#/components/schemas/ProblemDetailInvalidParam'

ProblemDetailParam:
type: object
properties:
key:
type: string
value:
type: string

ProblemDetailInvalidParam:
type: object
properties:
Expand Down

0 comments on commit f660f27

Please sign in to comment.