Update readme (#175)

* added swagger validate workflow
* add more badges to readme.md

.github/workflows/lint-openapi.yaml

@@ -2,6 +2,9 @@ name: 'SFTI Lint Specifications: OpenAPI Compliance'
 
 on:
   pull_request:
+  push:
+    branches:
+      - main
   workflow_dispatch:
     inputs:
       filenames:

.github/workflows/lint-yaml.yaml

@@ -2,6 +2,9 @@ name: 'SFTI Lint Specifications: Yaml Compliance'
 
 on:
   pull_request:
+  push:
+    branches:
+      - main
   workflow_dispatch:
     inputs:
       filenames:

.github/workflows/swagger-validator.yaml

@@ -0,0 +1,12 @@
+name: SFTI Validate Swagger
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  swagger-validate:
+    uses: swissfintechinnovations/.github/.github/workflows/reusable-swagger-validate-workflow.yaml@main

README.md

@@ -1,12 +1,13 @@
 <!-- ![SFTI_Banner](https://user-images.githubusercontent.com/116151702/232762217-ac254483-0d25-4234-857b-376ff8dbb1e7.png) -->
 ![ca-mortgage](https://user-images.githubusercontent.com/116151702/236231740-68b1595a-3cf7-4c5c-9623-3e014d827436.png)
 
-
 ---
-[![GitHub release](https://img.shields.io/github/release/swissfintechinnovations/ca-mortgage)](https://github.com/swissfintechinnovations/ca-mortgage/releases/)
-![GitHub checks](https://img.shields.io/github/checks-status/swissfintechinnovations/ca-mortgage/main)
-![Swagger Validator](https://img.shields.io/swagger/valid/3.0?specUrl=https%3A%2F%2Fraw.luolix.top%2FOAI%2FOpenAPI-Specification%2Fmaster%2Fexamples%2Fv2.0%2Fjson%2Fpetstore-expanded.json)
-[![GitHub license](https://img.shields.io/github/license/swissfintechinnovations/ca-mortgage)](https://github.com/swissfintechinnovations/ca-mortgage/blob/main/LICENSE)
+[![GitHub release](https://img.shields.io/github/release/swissfintechinnovations/ca-mortgage?color=blue)](https://github.com/swissfintechinnovations/ca-mortgage/releases/)
+[![GitHub Action Status OpenAPI](https://img.shields.io/github/actions/workflow/status/swissfintechinnovations/ca-mortgage/lint-openapi.yaml?branch=main&label=openapi%20checks)](https://github.com/swissfintechinnovations/ca-mortgage/actions/workflows/lint-openapi.yaml)
+[![GitHub Action Status Yaml](https://img.shields.io/github/actions/workflow/status/swissfintechinnovations/ca-mortgage/lint-yaml.yaml?branch=main&label=yaml%20checks)](https://github.com/swissfintechinnovations/ca-mortgage/actions/workflows/lint-yaml.yaml)
+[![GitHub Action Status Swagger Validator](https://img.shields.io/github/actions/workflow/status/swissfintechinnovations/ca-mortgage/swagger-validator.yaml?branch=main&label=swagger%20validation)](https://github.com/swissfintechinnovations/ca-mortgage/actions/workflows/swagger-validator.yaml)
+[![OpenAPI version](https://img.shields.io/badge/dynamic/yaml?url=https%3A%2F%2Fgit.luolix.top%2Fswissfintechinnovations%2Fca-mortgage%2Fraw%2Fmain%2FmortgageAPI.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-mortgage?color=de980d)](https://github.com/swissfintechinnovations/ca-mortgage/blob/main/LICENSE)
 
 This is the official SFTI repo for the mortgage API. Documentations may be found in the [Wiki](https://github.com/swissfintechinnovations/ca-mortgage/wiki).
 

mortgageAPI.yaml

@@ -333,7 +333,7 @@ paths:
     post:
       summary: Place a new mortgage application (serves as dossier)
       description: |
-        Place a new application including all necessary information about the property and applicant's financial situation.  
+        Place a new application including all necessary information about the property and applicant's financial situation.
         **Note that in the case where the FI needs additional information on the property, the error response 400 must contain the minimum required JSON object (PropertyObject) as detail**.
       tags:
         - Mortgage Application
@@ -3456,7 +3456,6 @@ components:
         type: string
         example: f058ebd6-02f7-4d3f-942e-904344e8cde5
 
-  # ---- Responses - Standard----
   responses:
     standard201:
       description: created
@@ -3586,4 +3585,3 @@ components:
         application/problem+json:
           schema:
             $ref: '#/components/schemas/commonErrorResponse'
-  # ---- End Responses - Standard