hubject / oicp-cpo-2.3-api-doc

oicp-cpo-2.3-api-doc

Requirements

To build project you need to have node installed.

Install

To install dependencies run npm install

Build

To build OpenAPI specification file run npm run build

Documentation can be linted using npm run test

Compiled documentation can be previewed using npm run preview

GitHub Pages

Page is hosted using GitHub Pages. Page is generated with GitHub Actions and will be generated automatically when changes are pushed to master.

Generated static content is pushed to gh-pages branch using actions-gh-pages action.

Page can be accessed with the following URL: https://hubject.github.io/oicp-cpo-2.3-api-doc/

oicp-cpo-2.3-api-doc's Issues

Wrong physical unit for MaximumProductChargingPower

The MaximumProductChargingPower is a physical power (instantaneous energy transfer per time) which should be measured in kW whereas the mentioned kWh are a unit of energy, cf.

oicp-cpo-2.3-api-doc/src/schemas/PricingProductDataRecord.yaml

Line 22 in df97b49

description: A value in kWh

I suggested a fix in the main oicp repo before the docs were moved here: hubject/oicp#107

npm run build - files/fields names problem

Used latest Node LTS: https://nodejs.org/dist/v18.14.0/node-v18.14.0-linux-x64.tar.xz

Run command (from README.md):

npm run build

Output:

> [email protected] build
> swagger-cli bundle src/openapi.yaml --outfile _build/openapi.yaml --type yaml && npm run copy-files

Error opening file "/path/oicp-cpo-2.3-api-doc/src/schemas/EvcoId.yaml" 
ENOENT: no such file or directory, open 'path/oicp-cpo-2.3-api-doc/src/schemas/EvcoId.yaml'

PS. I changed original path to path :)

I think files names can be a problem (or fields names). There is a file named EvcoID.yaml, not EvcoId.yaml.