@manycore/layout-rest-client
v1.0.0-rc.1
Published
OpenAPI client for @manycore/layout-rest-client
Readme
@manycore/[email protected]
This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:
Environment
- Node.js
- Webpack
- Browserify
Language level
- ES5 - you must have a Promises/A+ library installed
- ES6
Module system
- CommonJS
- ES6 module system
It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)
Building
To build and compile the typescript sources to javascript use:
npm install
npm run buildPublishing
First build the package then run npm publish
Consuming
navigate to the folder of your consuming project and run one of the following commands.
published:
npm install @manycore/[email protected] --saveunPublished (not recommended):
npm install PATH_TO_GENERATED_PACKAGE --saveDocumentation for API Endpoints
All URIs are relative to https://api.manycoreapis.com
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- LayoutApi | batchCreateLegend | POST /layout/api/v1/rest/designs/{obsDesignId}/levels/{levelId}/legend:batchcreate | 批量创建图例 LayoutApi | batchCreateLegendGroup | POST /layout/api/v1/rest/designs/{obsDesignId}/levels/{levelId}/legendgroup:batchcreate | 批量创建图例组合 LayoutApi | batchDeleteLegend | POST /layout/api/v1/rest/designs/{obsDesignId}/levels/{levelId}/legend:batchdelete | 批量删除图例 LayoutApi | batchGetLegend | POST /layout/api/v1/rest/designs/{obsDesignId}/levels/{levelId}/legend:batchget | 批量获取图例信息 LayoutApi | batchUpdateLegend | POST /layout/api/v1/rest/designs/{obsDesignId}/levels/{levelId}/legend:batchupdate | 批量更新图例 LayoutApi | createLegend | POST /layout/api/v1/rest/designs/{obsDesignId}/levels/{levelId}/legend | 创建单个图例 LayoutApi | deleteLegend | DELETE /layout/api/v1/rest/designs/{obsDesignId}/levels/{levelId}/legend/{legendId} | 删除单个图例 LayoutApi | getSingleLegend | GET /layout/api/v1/rest/designs/{obsDesignId}/levels/{levelId}/legend/{legendId} | 获取单个图例信息 LayoutApi | listLegend | GET /layout/api/v1/rest/designs/{obsDesignId}/levels/{levelId}/legend | 获取图例列表 LayoutApi | updateLegend | PUT /layout/api/v1/rest/designs/{obsDesignId}/levels/{levelId}/legend/{legendId} | 更新单个图例
Documentation For Models
- ColoredFloorPlanGetRequest
- LegendBatchCreateRequest
- LegendBatchDeleteRequest
- LegendBatchGetRequest
- LegendBatchUpdateRequest
- LegendGroupBatchCreateRequest
- LegendGroupUnitData
- LegendImageResponse
- LegendListResponse
- LegendUnitData
- OperationLegendImageResponse
- SingleLegendCreateRequest
- SingleLegendUpdateRequest
- Transform
Documentation For Authorization
Endpoints do not require authorization.
