Skip to content

Commit

Permalink
update readme (#31)
Browse files Browse the repository at this point in the history
* add badges
* add trigger for workflow on push to main branch
  • Loading branch information
dkoeni committed Jul 5, 2024
1 parent 382b3dd commit 21c07da
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 5 deletions.
3 changes: 3 additions & 0 deletions .github/workflows/lint-openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@ name: 'SFTI Lint Specifications: OpenAPI Compliance'

on:
pull_request:
push:
branches:
- main
workflow_dispatch:
inputs:
filenames:
Expand Down
3 changes: 3 additions & 0 deletions .github/workflows/lint-yaml.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@ name: 'SFTI Lint Specifications: Yaml Compliance'

on:
pull_request:
push:
branches:
- main
workflow_dispatch:
inputs:
filenames:
Expand Down
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,14 @@


---
[![GitHub release](https://img.shields.io/github/release/swissfintechinnovations/ca-pension)](https://github.com/swissfintechinnovations/ca-pension/releases/)
[![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/swissfintechinnovations/ca-pension/lint-yaml.yaml?label=Lint%20checks)](https://github.com/swissfintechinnovations/ca-pension/actions)
[![Swagger Validator](https://img.shields.io/swagger/valid/3.0?specUrl=https://raw.githubusercontent.com/swissfintechinnovations/ca-pension/main/consentAPI.yaml)](https://github.com/swissfintechinnovations/ca-pension/wiki/Swagger-Editor)
[![GitHub license](https://img.shields.io/github/license/swissfintechinnovations/ca-pension)](https://github.com/swissfintechinnovations/ca-pension/blob/main/LICENSE)
[![GitHub release](https://img.shields.io/github/release/swissfintechinnovations/ca-pension?color=blue)](https://github.com/swissfintechinnovations/ca-pension/releases/)
[![GitHub Action Status OpenAPI](https://img.shields.io/github/actions/workflow/status/swissfintechinnovations/ca-pension/lint-openapi.yaml?branch=main&label=openapi%20checks)](https://github.com/swissfintechinnovations/ca-pension/actions/workflows/lint-openapi.yaml)
[![GitHub Action Status Yaml](https://img.shields.io/github/actions/workflow/status/swissfintechinnovations/ca-pension/lint-yaml.yaml?branch=main&label=yaml%20checks)](https://github.com/swissfintechinnovations/ca-pension/actions/workflows/lint-yaml.yaml)
[![OpenAPI version](https://img.shields.io/badge/dynamic/yaml?url=https%3A%2F%2Fgithub.com%2Fswissfintechinnovations%2Fca-pension%2Fraw%2Fmain%2FpensionAPI.yaml&query=openapi&prefix=v&label=OpenAPI&color=blue)](https://swagger.io/resources/open-api/)
[![GitHub license](https://img.shields.io/github/license/swissfintechinnovations/ca-pension?color=de980d)](https://github.com/swissfintechinnovations/ca-pension/blob/main/LICENSE)

This is the official SFTI repo for the pension API. Documentations may be found in the [Wiki](https://github.com/swissfintechinnovations/ca-pension/wiki).

We refer to the [offical government website](https://www.kmu.admin.ch/kmu/de/home/praktisches-wissen/personal/personalmanagement/pflichten-der-arbeitgebenden/sozialversicherungen/pensionskasse-bvg.html) for more information.

<!-- An easy-to-read representation of the Payment/XS2A APIs is accessible via the following links: -->
<!-- An easy-to-read representation of the pension/XS2A APIs is accessible via the following links: -->

0 comments on commit 21c07da

Please sign in to comment.