Skip to content
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

TECH-131: New frontend generator and update redocly docs #28

Closed
wants to merge 15 commits into from
Closed
10 changes: 10 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
name: Maven Build Artifact

on:
pull_request:
branches:
- '*'

jobs:
build:
uses: valitydev/base-workflow/.github/workflows/maven-swag-build.yml@v1
18 changes: 18 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: Maven Deploy Artifact

on:
push:
branches:
- 'master'
- 'main'

jobs:
deploy:
uses: valitydev/base-workflow/.github/workflows/maven-swag-deploy.yml@v1
secrets:
server-username: ${{ secrets.OSSRH_USERNAME }}
server-password: ${{ secrets.OSSRH_TOKEN }}
deploy-secret-key: ${{ secrets.OSSRH_GPG_SECRET_KEY }}
deploy-secret-key-password: ${{ secrets.OSSRH_GPG_SECRET_KEY_PASSWORD }}
github-token: ${{ secrets.GITHUB_TOKEN }}
mm-webhook-url: ${{ secrets.MATTERMOST_WEBHOOK_URL }}
22 changes: 22 additions & 0 deletions .github/workflows/frontend-pr.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: 'Frontend: PR'

on:
pull_request:
branches: ['*']

jobs:
configured:
uses: valitydev/action-frontend/.github/workflows/[email protected]
check:
name: Check
runs-on: ubuntu-latest
needs: configured
if: needs.configured.outputs.exists == 'true'
steps:
- uses: actions/checkout@v3
- uses: valitydev/action-frontend/[email protected]
- run: npm ci
- name: Build
run: npm run build
- name: Codegen
run: npm run codegen
26 changes: 26 additions & 0 deletions .github/workflows/frontend-publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: 'Frontend: Publish'

on:
push:
branches: ['master', 'main']

jobs:
configured:
uses: valitydev/action-frontend/.github/workflows/[email protected]
publish:
name: Publish
runs-on: ubuntu-latest
needs: configured
if: needs.configured.outputs.exists == 'true'
steps:
- uses: actions/checkout@v3
- uses: valitydev/action-frontend/[email protected]
- run: npm ci
- name: Build
run: npm run build
- name: Codegen
run: npm run codegen
- uses: valitydev/action-frontend/[email protected]
with:
npm-token: ${{ secrets.NPM_TOKEN }}
directory: ./lib
19 changes: 19 additions & 0 deletions .github/workflows/gh-pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: Github Pages

on:
push:
branches: [master]

jobs:
publish:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
- run: npm install
- run: npm run build
- name: Publish Redocly on Github Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./web_deploy
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -58,3 +58,8 @@ web_deploy/
# Gradle:
.idea/gradle.xml
.idea/libraries

# Frontend
/lib
/vality-openapi
openapitools.json
3 changes: 0 additions & 3 deletions .gitmodules

This file was deleted.

25 changes: 7 additions & 18 deletions .redocly.yaml
Original file line number Diff line number Diff line change
@@ -1,18 +1,7 @@
# See https://docs.redoc.ly/cli/configuration/ for more information.
apiDefinitions:
core: "openapi/openapi.yaml"
lint:
plugins:
- './plugins/local.js'
extends:
- recommended
rules:
tag-description: off
preprocessors:
local/merge-schemas: on
referenceDocs:
showConsole: true
layout:
scope: section
routingStrategy: browser
htmlTemplate: ./web/index.html
# See https://redocly.com/docs/cli/configuration/ for more information.
apis:
core:
root: openapi/openapi.yaml

extends:
- ./node_modules/@vality/redocly-utils/lib/config.yaml
1 change: 0 additions & 1 deletion CODEOWNERS

This file was deleted.

58 changes: 0 additions & 58 deletions Jenkinsfile

This file was deleted.

90 changes: 0 additions & 90 deletions Makefile

This file was deleted.

1 change: 0 additions & 1 deletion build-utils
Submodule build-utils deleted from ccf618
3 changes: 1 addition & 2 deletions openapi/components/schemas/Organization.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,7 @@ properties:
- $ref: './UserId.yaml'
party:
description: |
Идентификатор [участника](https://developer.rbk.money/api/#tag/Parties), которым заведует
данная организация
Идентификатор участника, которым заведует данная организация
type: string
minLength: 1
maxLength: 40
Expand Down
10 changes: 4 additions & 6 deletions openapi/components/schemas/RoleId.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
description: Идентификатор роли
description: |
Идентификатор роли.
Актуальный список идентификаторов [здесь](https://github.com/valitydev/bouncer-policies/blob/master/policies/service/authz/roles/data.yaml)
type: string
enum:
- Administrator
- Accountant
- Integrator
- Manager
example: Manager
3 changes: 1 addition & 2 deletions openapi/components/security-schemes/Bearer.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,4 @@ description: >
```

Запросы к данному API авторизуются сессионным токеном доступа,
который вы получаете в результате аутентификации в личном кабинете
по адресу https://dashboard.rbk.money/.
который вы получаете в результате аутентификации в личном кабинете.
2 changes: 1 addition & 1 deletion openapi/docs/api.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
RBKmoney Organizations API является интерфейсом для управления различными
Organizations API является интерфейсом для управления различными
аспектами вашей организации. Все изменения состояния организации, будь то
приглашение новых сотрудников, добавление ролей уже существующим сотрудникам
или настройка области их ответственности осуществляются с помощью вызовов
Expand Down
9 changes: 1 addition & 8 deletions openapi/openapi.yaml
Original file line number Diff line number Diff line change
@@ -1,14 +1,9 @@
openapi: 3.0.3
info:
version: 1.0.0
title: RBKmoney Organizations API
title: Organizations API
description:
$ref: './docs/api.md'
termsOfService: 'https://rbk.money/'
contact:
name: RBKmoney Support Team
email: [email protected]
url: 'https://developer.rbk.money'
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
Expand Down Expand Up @@ -54,8 +49,6 @@ paths:
$ref: ./paths/invitations.yaml
/orgs/{orgId}/invitations/{invitationId}:
$ref: ./paths/invitation.yaml
servers:
- url: 'https://api.rbk.money/org/v1'
components:
securitySchemes:
bearer:
Expand Down
2 changes: 1 addition & 1 deletion openapi/paths/membership.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ post:
schema:
type: string
format: uri
example: 'https://api.rbk.money/org/v1/user/membership/or_af9e76uc5b47h8b154.19b8xa61dc94'
example: '/org/v1/user/membership/or_af9e76uc5b47h8b154.19b8xa61dc94'
'422':
description: Невозможно совершить операцию
content:
Expand Down
Loading
Loading