This repository contains the OpenAPI specification for the UCL API. The uclapi.json
specification file should not be manually edited unless via Swagger Hub.
The aim is to set up repositories containing various client SDKs in different languages, automatically generated and maintained via our OpenAPI specification.
A JavaScript client SDK is automatically generated on pushed to master
. These are then automatically pushed to the uclapi-js-sdk
repository on GitHub.
NOTE: To publish the package to npm, you need to update the generator-cli.generators.javascript.additionalProperties.projectVersion
in the openapitools.json
file -- this means publishing won't be 100% automatic on-push unless this is updated, and allows for you to decide what the new version number should be (major/minor/patch).