diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml index c6d2311..10da8a0 100644 --- a/.github/workflows/deploy-docs.yml +++ b/.github/workflows/deploy-docs.yml @@ -13,7 +13,7 @@ jobs: - name: Build Docs run: | mkdir -p docs/v1 - npx --yes @redocly/cli join introduction.yml hm-oauth-rest-v1.yml hm-vehicle-data-api-v1.yml hm-fleet-clearance-v1.yml hm-eligibility-v1.yml -o hm-apis.yaml + npx --yes @redocly/cli join introduction.yml hm-oauth-rest-v1.yml hm-vehicle-data-api-v1.yml hm-vehicle-static-data-api-v1.yml hm-fleet-clearance-v1.yml hm-eligibility-v1.yml -o hm-apis.yaml npx @redocly/cli build-docs --disableGoogleFont --output=docs/v1/index.html hm-apis.yaml - name: Deploy to Github Pages uses: JamesIves/github-pages-deploy-action@v4 diff --git a/.github/workflows/node.js.yml b/.github/workflows/node.js.yml index 6b2e64e..15ddfb0 100644 --- a/.github/workflows/node.js.yml +++ b/.github/workflows/node.js.yml @@ -18,5 +18,5 @@ jobs: - uses: actions/checkout@v3 - name: Build Docs run: | - npx --yes @redocly/cli join introduction.yml hm-oauth-rest-v1.yml hm-vehicle-data-api-v1.yml hm-fleet-clearance-v1.yml hm-eligibility-v1.yml -o hm-apis.yaml + npx --yes @redocly/cli join introduction.yml hm-oauth-rest-v1.yml hm-vehicle-data-api-v1.yml hm-vehicle-static-data-api-v1.yml hm-fleet-clearance-v1.yml hm-eligibility-v1.yml -o hm-apis.yaml npx @redocly/cli build-docs hm-apis.yaml diff --git a/hm-vehicle-static-data-api-v1.yml b/hm-vehicle-static-data-api-v1.yml index 4ed018e..106f050 100644 --- a/hm-vehicle-static-data-api-v1.yml +++ b/hm-vehicle-static-data-api-v1.yml @@ -7,13 +7,13 @@ info: - Sandbox server: `https://sandbox.api.high-mobility.com` - - - Production server: `https://api.high-mobility.com` + Servers: + * Production server: `https://api.high-mobility.com` title: Vehicle Static Data API(Draft) version: 1.0.0 openapi: 3.0.3 + + paths: /v1/vehicle-static-data/{vin}: get: @@ -30,13 +30,36 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/response' + $ref: '#/components/schemas/VehicleStaticDataResponse' + examples: + successful: + value: + manufacturer: + brand: "Jeep" + sub_model: "80th Anniversary Plug-In Hybrid 4WD" + type_group_name: "Compass" + model: "Compass (M7)(2020->)" + sales_description: "Compass 1.3 Plug-In Hybrid (EURO 6d) 80th Annivers" + equipment: + series_equipment: + - description: "airbag driver side/passenger side" + positions: [] + manufacturer_id: null + - descripion: "navigation package" + positions: + - description: "driver assistance system: traffic sign detection (TSR)" + manufacturer_id: "JPE" + special_equipment: + - description: "Winter package" + positions: + - description: "windshield wiper heated" + manufacturer_id: AAC description: successful operation '401': content: application/json: schema: - $ref: '#/components/schemas/response401' + $ref: '#/components/schemas/VehicleStaticDataResponse401' examples: Invalid authorization header: value: @@ -61,18 +84,56 @@ paths: - VehicleStaticDataAuth: - vehicle:static-data tags: - - Data API + - Static Data API servers: - url: https://sandbox.api.high-mobility.com - url: https://api.high-mobility.com components: schemas: - response: + VehicleStaticDataManufacturer: + properties: + brand: + type: string + sub_model: + type: string + type_group_name: + type: string + model: + type: string + sales_description: + type: string + VehicleStaticDataEquipment: + properties: + series_equipment: + type: array + items: + $ref: '#/components/schemas/VehicleStaticDataEquipmentList' + special_equipment: + type: array + items: + $ref: '#/components/schemas/VehicleStaticDataEquipmentList' + + VehicleStaticDataEquipmentList: properties: - data: - type: object - response401: + manufacturer_id: + type: string + description: + type: string + positions: + type: array + items: + type: string + + + VehicleStaticDataResponse: + properties: + manufacturer: + $ref: '#/components/schemas/VehicleStaticDataManufacturer' + equipment: + $ref: '#/components/schemas/VehicleStaticDataEquipment' + + VehicleStaticDataResponse401: properties: errors: items: