mirror of
https://github.com/vatesfr/xen-orchestra.git
synced 2026-11-09 17:06:13 -06:00
41 lines
1.5 KiB
Markdown
41 lines
1.5 KiB
Markdown
<!-- DO NOT EDIT MANUALLY, THIS FILE HAS BEEN GENERATED -->
|
|
|
|
# @xen-orchestra/rest-api
|
|
|
|
[](https://npmjs.org/package/@xen-orchestra/rest-api)  [](https://bundlephobia.com/result?p=@xen-orchestra/rest-api) [](https://npmjs.org/package/@xen-orchestra/rest-api)
|
|
|
|
> REST API to manage your XOA
|
|
|
|
## Install
|
|
|
|
Installation of the [npm package](https://npmjs.org/package/@xen-orchestra/rest-api):
|
|
|
|
```sh
|
|
npm install --save @xen-orchestra/rest-api
|
|
```
|
|
|
|
## Usage
|
|
|
|
REST API to manage your XOA.
|
|
|
|
The user-facing documentation is available at [docs.xen-orchestra.com](https://docs.xen-orchestra.com/rest_api).
|
|
|
|
## Development guidelines
|
|
|
|
Any change to this package **must** follow the [REST API guidelines](https://github.com/vatesfr/xen-orchestra/blob/master/%40xen-orchestra/rest-api/docs/guidelines.md), in addition to the [backend project guidelines](https://github.com/vatesfr/xen-orchestra/blob/master/packages/xo-server/docs/guidelines.md).
|
|
|
|
## Contributions
|
|
|
|
Contributions are _very_ welcomed, either on the documentation or on
|
|
the code.
|
|
|
|
You may:
|
|
|
|
- report any [issue](https://github.com/vatesfr/xen-orchestra/issues)
|
|
you've encountered;
|
|
- fork and create a pull request.
|
|
|
|
## License
|
|
|
|
[AGPL-3.0-or-later](https://spdx.org/licenses/AGPL-3.0-or-later) © [Vates SAS](https://vates.fr)
|