From ea6a76fd85ad8c4b3b1735718cb096351f988eb8 Mon Sep 17 00:00:00 2001 From: Denys Vuika Date: Fri, 18 Oct 2019 02:41:07 +0100 Subject: [PATCH] documentation fixes (#431) * update readme with ES6 examples * improved documentation templates * regenerate content readme * update discovery docs * upgrade codegen lib, fix layout --- .editorconfig | 4 + README.md | 397 ++++++----- api-codegen/pom.xml | 4 +- .../resources/api-code-gen/api_doc.mustache | 18 +- .../api-code-gen/modelGeneric.mustache | 32 +- .../resources/api-code-gen/model_doc.mustache | 2 +- .../api-code-gen/readmeIndex.mustache | 25 +- pom.xml | 4 +- src/api/auth-rest-api/README.md | 40 +- .../auth-rest-api/docs/AuthenticationApi.md | 36 +- src/api/content-rest-api/README.md | 621 +++++++++--------- src/api/discovery-rest-api/README.md | 42 +- .../discovery-rest-api/docs/DiscoveryApi.md | 12 +- 13 files changed, 643 insertions(+), 594 deletions(-) diff --git a/.editorconfig b/.editorconfig index 79168cfaf3..06cd9674a2 100644 --- a/.editorconfig +++ b/.editorconfig @@ -23,3 +23,7 @@ indent_size = 2 [*.md] insert_final_newline = false trim_trailing_whitespace = false + +[*mustache] +insert_final_newline = false +trim_trailing_whitespace = false diff --git a/README.md b/README.md index 8d1dc9c72a..ac5813a5bd 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,5 @@ # Alfresco JavaScript API Client -

Gitter chat @@ -85,21 +84,24 @@ This project provides a JavaScript client API into the Alfresco REST API and Act # Prerequisites -To correctly use the alfresco js api the minimal supported version are: +The minimal supported versions are: -- 5.2.a-EA Alfresco Platform Repository (version [5.2.a-EA](https://wiki.alfresco.com/wiki/Community_file_list_201606-EA) or newer) -- 1.5 Activiti +- Alfresco Platform Repository: version [5.2.a-EA](https://wiki.alfresco.com/wiki/Community_file_list_201606-EA) or newer +- Activiti: 1.5 +- Node.js ([Long Term Support](https://nodejs.org/en/) version) -# Node -To correctly use the api/js-api in node check that on your machine is running Node version 5.0.0 or higher. +# Installing -# Install +Using NPM: +```sh +npm install @alfresco/js-api +``` -Installer for browser versions: +Using Yarn: ```sh -npm install --save @alfresco/js-api +yarn add @alfresco/js-api ``` # Authentication JS-API @@ -124,30 +126,37 @@ withCredentials| (Optional configuration for SSO, requires CORS on ECM) |false ### Login with Username and Password BPM and ECM #### Example + ```javascript -this.alfrescoApi = new AlfrescoApi({ provider:'ALL' }); - -this.alfrescoJsApi.login('admin', 'admin').then(function (data) { - console.log('API called successfully Login in BPM and ECM performed '); -}, function (error) { - console.error(error); -}); +const alfrescoApi = new AlfrescoApi({ provider: 'ALL' }); + +alfrescoJsApi.login('admin', 'admin').then( + data => { + console.log('API called successfully Login in BPM and ECM performed '); + }, + error => { + console.error(error); + } +); ``` - ### Login with Username and Password ECM #### Example + ```javascript -this.alfrescoJsApi = new AlfrescoApi(); +const alfrescoJsApi = new AlfrescoApi(); -this.alfrescoJsApi.login('admin', 'admin').then(function (data) { - console.log('API called successfully Login ticket:' + data); -}, function (error) { - console.error(error); -}); +alfrescoJsApi.login('admin', 'admin').then( + data => { + console.log('API called successfully Login ticket:' + data); + }, + error => { + console.error(error); + } +); -//The output will be: API called successfully Login ticket: TICKET_4479f4d3bb155195879bfbb8d5206f433488a1b1 +// The output will be: API called successfully Login ticket: TICKET_4479f4d3bb155195879bfbb8d5206f433488a1b1 ``` @@ -155,20 +164,23 @@ this.alfrescoJsApi.login('admin', 'admin').then(function (data) { If you already know thw ticket when you invoke the constructor you can pass it as parameter in the constructor otherwise you can call the login with ticket that will validate the ticket against the server - #### Login with ticket ECM This authentication validate also the ticket against the server ##### Example -```javascript -let ticket = 'TICKET_4479f4d3bb155195879bfbb8d5206f433488a1b1'; -this.alfrescoJsApi.loginTicket(ticket).then(function (data) { - console.log('valid ticket you are logged in'); - }, function (error) { - console.error(error); - }); +```javascript +const ticket = 'TICKET_4479f4d3bb155195879bfbb8d5206f433488a1b1'; + +alfrescoJsApi.loginTicket(ticket).then( + data => { + console.log('valid ticket you are logged in'); + }, + error => { + console.error(error); + } +); ``` #### Login with ticket ECM/BPM as parameter in the constructor @@ -176,31 +188,47 @@ this.alfrescoJsApi.loginTicket(ticket).then(function (data) { With this authentication the ticket is not validated against the server ##### Example + ```javascript -//Login ticket ECM -this.alfrescoApi = new AlfrescoApi({ ticketEcm:'TICKET_4479f4d3bb155195879bfbb8d5206f433488a1b1', hostEcm:'http://127.0.0.1:8080'}); +// Login with ECM ticket +const alfrescoApi = new AlfrescoApi({ + ticketEcm:'TICKET_4479f4d3bb155195879bfbb8d5206f433488a1b1', + hostEcm:'http://127.0.0.1:8080' +}); -//Login ticket BPM -this.alfrescoApi = new AlfrescoApi({ ticketBpm: 'Basic YWRtaW46YWRtaW4=', hostBpm:'http://127.0.0.1:9999'}); +// Login with BPM ticket +const alfrescoApi = new AlfrescoApi({ + ticketBpm: 'Basic YWRtaW46YWRtaW4=', + hostBpm:'http://127.0.0.1:9999' +}); -//Login ticket ECM and BPM -this.alfrescoApi = new AlfrescoApi({ ticketEcm:'TICKET_4479f4d3bb155195879bfbb8d5206f433488a1b1', ticketBpm: 'Basic YWRtaW46YWRtaW4=', hostEcm:'http://127.0.0.1:8080', hostBpm:'http://127.0.0.1:9999'}); +// Login with ECM and BPM tickets +const alfrescoApi = new AlfrescoApi({ + ticketEcm:'TICKET_4479f4d3bb155195879bfbb8d5206f433488a1b1', + ticketBpm: 'Basic YWRtaW46YWRtaW4=', + hostEcm:'http://127.0.0.1:8080', + hostBpm:'http://127.0.0.1:9999' +}); ``` ### Login with Username and Password BPM #### Example -```javascript -this.alfrescoApi = new AlfrescoApi({ provider:'BPM' }); - -this.alfrescoJsApi.login('admin', 'admin').then(function () { - console.log('API called successfully Login in Activiti BPM performed '); -}, function (error) { - console.error(error); -}); +```javascript +const alfrescoApi = new AlfrescoApi({ provider:'BPM' }); + +alfrescoJsApi.login('admin', 'admin').then( + () => { + console.log('API called successfully Login in Activiti BPM performed '); + }, + error => { + console.error(error); + } +); ``` + ### Login with OAUTH2 Alfresco authorization server #### Implicit Flow @@ -220,7 +248,7 @@ redirectUri| url to be redirect after login| null| redirectLogout| url to be redirect after logout optional, if is nor present the redirectUri will be used| null| refreshTokenTimeout| millisecond value, after how many millisecond youw ant refresh the token| 30000| redirectSilentIframeUri| url to be redirect after silent refresh login| /assets/silent-refresh.html | -silentLogin| direct execute the implicit login without the need to call this.alfrescoJsApi.implicitLogin() method| false| +silentLogin| direct execute the implicit login without the need to call AlfrescoJsApi.implicitLogin() method| false| publicUrls | list of public urls that don't need authorization. It is possible too pass absolute paths and string patterns that are valid for [minimatch](https://github.com/isaacs/minimatch#readme) | The api/js-api will automatically redirect you to the login page anf refresh the token if necessary @@ -235,73 +263,72 @@ token_issued| triggered when a new token is issued| | The api/js-api will automatically redirect you to the login page anf refresh the token if necessary - ##### Example ```javascript -this.alfrescoApi = new AlfrescoApi({ - oauth2: { - host: 'HOST_OAUTH2_SERVER', - clientId: 'YOUR_CLIENT_ID', - secret: 'SECRET', - scope: 'openid', - implicitFlow: true, - redirectUri: 'YOUR_HOME_APP_URL', - silentRefreshTimeout: '600000' //Optional parameter 10 minutes default value - }, - authType: 'OAUTH', - provider: 'ALL' +const alfrescoApi = new AlfrescoApi({ + oauth2: { + host: 'HOST_OAUTH2_SERVER', + clientId: 'YOUR_CLIENT_ID', + secret: 'SECRET', + scope: 'openid', + implicitFlow: true, + redirectUri: 'YOUR_HOME_APP_URL', + silentRefreshTimeout: '600000' //Optional parameter 10 minutes default value + }, + authType: 'OAUTH', + provider: 'ALL' }); -this.alfrescoJsApi.implicitLogin(); - +alfrescoJsApi.implicitLogin(); ``` ##### Example skip login form (implicitFlow) ```javascript -this.alfrescoApi = new AlfrescoApi({ - oauth2: { - host: 'HOST_OAUTH2_SERVER', - clientId: 'YOUR_CLIENT_ID', - secret: 'SECRET', - scope: 'openid', - implicitFlow: true, - redirectUri: 'YOUR_HOME_APP_URL', - silentRefreshTimeout: '600000' //Optional parameter 10 minutes default value, - silentLogin: true, - publicUrls: ['PUBLIC_URL', 'URL_PATTERN'] - }, - authType: 'OAUTH', - provider: 'ALL' +const alfrescoApi = new AlfrescoApi({ + oauth2: { + host: 'HOST_OAUTH2_SERVER', + clientId: 'YOUR_CLIENT_ID', + secret: 'SECRET', + scope: 'openid', + implicitFlow: true, + redirectUri: 'YOUR_HOME_APP_URL', + silentRefreshTimeout: '600000' //Optional parameter 10 minutes default value, + silentLogin: true, + publicUrls: ['PUBLIC_URL', 'URL_PATTERN'] + }, + authType: 'OAUTH', + provider: 'ALL' }); - ``` - #### Password Flow If your auth endpoint is different from the standard one "/oauth/token" you can override it through the property authPath ##### Example -```javascript -this.alfrescoApi = new AlfrescoApi({ - oauth2: { - host: 'HOST_OAUTH2_SERVER', - clientId: 'YOUR_CLIENT_ID', - secret: 'SECRET', - authPath:'my-custom-auth-endpoint/token' - }, - authType: 'OAUTH', - provider: 'ALL' - }); -this.alfrescoJsApi.login('admin', 'admin').then(function (data) { - console.log('API called successfully Login in with authorization server performed '); -}, function (error) { - console.error(error); +```javascript +const alfrescoApi = new AlfrescoApi({ + oauth2: { + host: 'HOST_OAUTH2_SERVER', + clientId: 'YOUR_CLIENT_ID', + secret: 'SECRET', + authPath:'my-custom-auth-endpoint/token' + }, + authType: 'OAUTH', + provider: 'ALL' }); +alfrescoJsApi.login('admin', 'admin').then( + data => { + console.log('API called successfully Login in with authorization server performed'); + }, + error => { + console.error(error); + } +); ``` After the login if you want refresh your token you can use this call @@ -309,11 +336,14 @@ After the login if you want refresh your token you can use this call ##### Example ```javascript -this.alfrescoJsApi.refreshToken().then(function (data) { - console.log('Your token has been refreshed'); - }, function (error) { - console.error(error); - }); +alfrescoJsApi.refreshToken().then( + data => { + console.log('Your token has been refreshed'); + }, + error => { + console.error(error); + } +); ``` ## Logout @@ -324,12 +354,14 @@ logout() ```javascript -this.alfrescoJsApi.logout().then(function (data) { - console.log('Successfully Logout'); -}, function (error) { - console.error('Possible ticket already expired'); -}); - +alfrescoJsApi.logout().then( + data => { + console.log('Successfully Logout'); + }, + error => { + console.error('Possible ticket already expired'); + } +); ``` ## isLoggedIn @@ -342,107 +374,124 @@ isLoggedIn() ```javascript -let isLoggedIn = this.alfrescoJsApi.isLoggedIn(); +const isLoggedIn = alfrescoJsApi.isLoggedIn(); if (isLoggedIn) { console.log('You are logged in'); } else { console.log('You are not logged in'); } - ``` + ## Get tickets -getTicketEcm() +### getTicketEcm() ->After the log in you can retrieve you ECM ticket +After the log in you can retrieve you ECM ticket ```javascript - let ecmTicket = this.alfrescoJsApi.getTicketEcm() ; - console.log('This is your ECM ticket ' + ecmTicket); +const ecmTicket = alfrescoJsApi.getTicketEcm() ; +console.log('This is your ECM ticket ' + ecmTicket); ``` -getTicketBpm() +### getTicketBpm() ->After the log in you can retrieve you BPM ticket +After the log in you can retrieve you BPM ticket ```javascript +const bpmTicket = alfrescoJsApi.getTicketBpm(); - let bpmTicket = this.alfrescoJsApi.getTicketBpm(); - console.log('This is your BPM ticket ' + bpmTicket); +console.log('This is your BPM ticket ' + bpmTicket); ``` ## Events login/logout -> The login/logout are also an EventEmitter which you can register to listen to any of the following event types: -* unauthorized (If this event is triggered a call to the Api was unauthorized) -* success (If this event is triggered the login was success you can use this event instead the login promise) -* logout (If this event is triggered the client is successfully logout) +The login/logout are also an EventEmitter which you can register to listen to any of the following event types: + +- unauthorized (If this event is triggered a call to the Api was unauthorized) +- success (If this event is triggered the login was success you can use this event > instead the login promise) +- logout (If this event is triggered the client is successfully logout) ### Example ```javascript -this.alfrescoJsApi.login('admin', 'admin').on('unauthorized', function(){ - console.log('You are unauthorized you can use this event to redirect to login'); -}); +alfrescoJsApi.login('admin', 'admin') + .on('unauthorized', () => { + console.log('You are unauthorized you can use this event to redirect to login'); + }); -this.alfrescoJsApi.login('admin', 'admin').on('success', function(){ - console.log('Success Login'); -}); +alfrescoJsApi.login('admin', 'admin') + .on('success', () => { + console.log('Success Login'); + }); -this.alfrescoJsApi.logout().on('logout', function(){ - console.log('Successfully Logout'); -}); +alfrescoJsApi.logout() + .on('logout', () => { + console.log('Successfully Logout'); + }); ``` # Custom Endpoint Content service and process service has two different clients: -- this.alfrescoJsApi.ProcessClient -- this.alfrescoJsApi.ContentClient +- AlfrescoJsApi.ProcessClient +- AlfrescoJsApi.ContentClient Both client expose a method ***callApi** - ```javascript - callApi(path: string, httpMethod: string, pathParams?: any, queryParams?: any, headerParams?: any, formParams?: any, bodyParam?: any, contentTypes?: string[], accepts?: string[], returnType?: any, contextRoot?: string, responseType?: string): Promise; +callApi( + path: string, + httpMethod: string, + pathParams?: any, + queryParams?: any, + headerParams?: any, + formParams?: any, + bodyParam?: any, + contentTypes?: string[], + accepts?: string[], + returnType?: any, + contextRoot?: string, + responseType?: string +): Promise; ``` -If you want call your custom rest point in one of those two service use the corrispondin client. +If you want call your custom rest point in one of those two service use the corresponding client. ## Example ```javascript +alfrescoJsApi.bpmClient.callApi( + '/api/enterprise/app-version', 'GET', + {}, {}, {}, {}, {}, ['application/json'], ['application/json'], {'String': 'String'} +) + ``` - this.alfrescoJsApi.bpmClient.callApi( - '/api/enterprise/app-version', 'GET', - {}, {}, {}, {}, {}, ['application/json'], ['application/json'], {'String': 'String'} - ) +# Error Events - ``` +The api/js-api has an error handler event where you can subscribe + +## Example + +```javascript +alfrescoJsApi.on('error', error => { + console.log(error); +}); +``` - # Error Events - - The api/js-api has an error handler event where you can subscribe - - ## Example - ```javascript - this.alfrescoJsApi.on('error', (error) => { - console.log(error) - }) - ``` - # ECM Example -A complete list of all the ECM methods is available here : [Content API](/src/api/content-rest-api) here you can find some common [Example](/ecm-example.md) +A complete list of all the ECM methods is available here : [Content API](/src/api/content-rest-api) here you can find some common [Example](/ecm-example.md). # BPM Example -A complete list of all the BPM methods is available here : [APS 2.X API](/src/api/activiti-rest-api) here you can find some common [Example](/bpm-example.md) + +A complete list of all the BPM methods is available here : [APS 2.X API](/src/api/activiti-rest-api) here you can find some common [Example](/bpm-example.md). # Legacy Endpoint porting (ver 2.x.x) + Since version 3.0.0 in order to support tree shaking the JS-API has been radically redesigned. In order to help the porting to the new JS-APi version of the old project the previous syntax even if is deprecated is still supported in the compatibility layer. @@ -452,7 +501,7 @@ In order to help the porting to the new JS-APi version of the old project the pr ```javascript import { AlfrescoApiCompatibility as AlfrescoApi } from '../src/alfrescoApiCompatibility'; -this.alfrescoJsApi = new AlfrescoApi({ +const alfrescoJsApi = new AlfrescoApi({ oauth2: { host: 'HOST_OAUTH2_SERVER', clientId: 'YOUR_CLIENT_ID', @@ -463,27 +512,37 @@ this.alfrescoJsApi = new AlfrescoApi({ provider: 'ALL' }); -this.alfrescoJsApi.login('admin', 'admin').then(function (data) { - console.log('API called successfully Login in with authorization server performed '); -}, function (error) { - console.error(error); -}); - -this.alfrescoJsApi.nodes.getNodeInfo(fileOrFolderId).then(function (data) { - console.log('This is the name' + data.name ); -}, function (error) { - console.log('This node does not exist'); -}); - +alfrescoJsApi.login('admin', 'admin').then( + data => { + console.log('API called successfully Login in with authorization server performed '); + }, + error => { + console.error(error); + } +); + +alfrescoJsApi.nodes + .getNodeInfo(fileOrFolderId) + .then( + data => { + console.log('This is the name' + data.name ); + }, + error => { + console.log('This node does not exist'); + } + ); ``` -# Development - -* To run the build - ```$ npm run build_all``` +# Development -* To run the test +To run the build - ```$ npm run test``` +```sh +npm run build_all +``` +To run the test +```sh +npm run test +``` diff --git a/api-codegen/pom.xml b/api-codegen/pom.xml index aada4d55dd..aaae87d400 100644 --- a/api-codegen/pom.xml +++ b/api-codegen/pom.xml @@ -88,14 +88,14 @@ - io.swagger + io.swagger.codegen.v3 swagger-codegen ${swagger-codegen-version} provided - 2.3.1 + 3.0.13 1.0.0 4.8.1 diff --git a/api-codegen/src/main/resources/api-code-gen/api_doc.mustache b/api-codegen/src/main/resources/api-code-gen/api_doc.mustache index 721c95a72b..d488923508 100644 --- a/api-codegen/src/main/resources/api-code-gen/api_doc.mustache +++ b/api-codegen/src/main/resources/api-code-gen/api_doc.mustache @@ -11,7 +11,7 @@ Method | HTTP request | Description {{#operations}} {{#operation}} -# **{{operationId}}** +## {{operationId}} > {{#returnType}}{{&returnType}} {{/returnType}}{{operationId}}({{#allParams}}{{#required}}{{{paramName}}}{{#vendorExtensions.x-codegen-hasMoreRequired}}, {{/vendorExtensions.x-codegen-hasMoreRequired}}{{/required}}{{/allParams}}{{#hasOptionalParams}}{{#vendorExtensions.x-codegen-hasRequiredParams}}, {{/vendorExtensions.x-codegen-hasRequiredParams}}opts{{/hasOptionalParams}}) {{&summary}}{{#notes}} @@ -19,20 +19,19 @@ Method | HTTP request | Description {{¬es}}{{/notes}} ### Example + ```javascript -import {{{classname}}} from '{{{classname}}}'; -import { AlfrescoApi } from '@alfresco/js-api'; +import { AlfrescoApi, {{classname}}} from '@alfresco/js-api'; -this.alfrescoApi = new AlfrescoApi(); -this.alfrescoApi.setConfig({ +const alfrescoApi = new AlfrescoApi({ hostEcm: 'http://127.0.0.1:8080' }); -let {{instanceClassname}} = new {{{classname}}}(this.alfrescoApi);{{#hasParams}} +const {{instanceClassname}} = new {{{classname}}}(alfrescoApi);{{#hasParams}} {{#vendorExtensions.x-codegen-hasRequiredParams}}{{#allParams}}{{#required}} -let {{{paramName}}} = {{{example}}}; /* {{{&dataType}}} | {{&description}} */ +const {{{paramName}}} = {{{example}}}; /* {{{&dataType}}} | {{&description}} */ {{/required}}{{/allParams}}{{/vendorExtensions.x-codegen-hasRequiredParams}}{{#hasOptionalParams}} -let opts = { {{#allParams}}{{^required}} +const opts = { {{#allParams}}{{^required}} '{{{paramName}}}': {{{example}}}{{#vendorExtensions.x-codegen-hasMoreOptional}},{{/vendorExtensions.x-codegen-hasMoreOptional}} /* {{{&dataType}}} | {{&description}} */{{/required}}{{/allParams}} };{{/hasOptionalParams}}{{/hasParams}} @@ -41,7 +40,6 @@ let opts = { {{#allParams}}{{^required}} }, function(error) { console.error(error); }); - ``` ### Parameters @@ -56,4 +54,4 @@ Name | Type | Description | Notes {{#returnType}}{{#returnTypeIsPrimitive}}**{{&returnType}}**{{/returnTypeIsPrimitive}}{{^returnTypeIsPrimitive}}[**{{&returnType}}**]({{returnBaseType}}.md){{/returnTypeIsPrimitive}}{{/returnType}}{{^returnType}}null (empty response body){{/returnType}} {{/operation}} -{{/operations}} +{{/operations}} \ No newline at end of file diff --git a/api-codegen/src/main/resources/api-code-gen/modelGeneric.mustache b/api-codegen/src/main/resources/api-code-gen/modelGeneric.mustache index 99eba0dc1f..0e17465198 100644 --- a/api-codegen/src/main/resources/api-code-gen/modelGeneric.mustache +++ b/api-codegen/src/main/resources/api-code-gen/modelGeneric.mustache @@ -10,25 +10,25 @@ export class {{classname}} {{#parent}}extends {{{parent}}} {{/parent}}{ {{>model constructor(input?: any) { {{#parent}}super();{{/parent}} - if(input) { + if (input) { Object.assign(this, input); - {{#vars}} + {{#vars}} {{^isPrimitiveType}} - {{^isListContainer}} - {{^isMapContainer}} - this.{{name}} = input.{{name}} ? new {{#isEnum}}{{{datatypeWithEnum}}}{{/isEnum}}{{^isEnum}}{{{datatype}}}{{/isEnum}}(input.{{name}}) : undefined; - {{/isMapContainer}} - {{/isListContainer}} - {{#isListContainer}} - if(input.{{name}}) { - this.{{name}} = input.{{name}}.map((item: any) => { - return new {{#isEnum}}{{{datatypeWithEnum}}}{{/isEnum}}{{^isEnum}}{{{datatype}}}{{/isEnum}}(item); - }); - } - {{/isListContainer}} + {{^isListContainer}} + {{^isMapContainer}} + this.{{name}} = input.{{name}} ? new {{#isEnum}}{{{datatypeWithEnum}}}{{/isEnum}}{{^isEnum}}{{{datatype}}}{{/isEnum}}(input.{{name}}) : undefined; + {{/isMapContainer}} + {{/isListContainer}} + {{#isListContainer}} + if(input.{{name}}) { + this.{{name}} = input.{{name}}.map((item: any) => { + return new {{#isEnum}}{{{datatypeWithEnum}}}{{/isEnum}}{{^isEnum}}{{{datatype}}}{{/isEnum}}(item); + }); + } + {{/isListContainer}} {{/isPrimitiveType}} - {{/vars}} + {{/vars}} } } -}{{>modelGenericEnums}} +}{{>modelGenericEnums}} \ No newline at end of file diff --git a/api-codegen/src/main/resources/api-code-gen/model_doc.mustache b/api-codegen/src/main/resources/api-code-gen/model_doc.mustache index 08a0595bc2..bfd1146e17 100644 --- a/api-codegen/src/main/resources/api-code-gen/model_doc.mustache +++ b/api-codegen/src/main/resources/api-code-gen/model_doc.mustache @@ -5,7 +5,7 @@ {{#allowableValues}}{{#enumVars}} * `{{name}}` (value: `{{{value}}}`) {{/enumVars}}{{/allowableValues}} -{{/isEnum}}{{^isEnum}}# {{moduleName}}.{{classname}} +{{/isEnum}}{{^isEnum}}# {{classname}} ## Properties Name | Type | Description | Notes diff --git a/api-codegen/src/main/resources/api-code-gen/readmeIndex.mustache b/api-codegen/src/main/resources/api-code-gen/readmeIndex.mustache index 10b076aa58..df2c8bcdf8 100644 --- a/api-codegen/src/main/resources/api-code-gen/readmeIndex.mustache +++ b/api-codegen/src/main/resources/api-code-gen/readmeIndex.mustache @@ -1,22 +1,19 @@ -{{#appDescription}} -{{{appDescription}}} -{{/appDescription}} +{{#appDescription}}# {{{appDescription}}}{{/appDescription}} +{{^hideGenerationTimestamp}}> Documentation updated on: {{generatedDate}}{{/hideGenerationTimestamp}} -{{^hideGenerationTimestamp}} -- Last Build date: {{generatedDate}} -{{/hideGenerationTimestamp}} +## Methods +All URIs are relative to: -## Documentation for API Endpoints - -All URIs are relative to *{{basePath}}* +```text +{{basePath}} +``` Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- -{{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}*{{moduleName}}.{{classname}}* | [**{{operationId}}**](docs/{{classname}}.md#{{operationId}}) | **{{httpMethod}}** {{path}} | {{#summary}}{{&summary}}{{/summary}} +{{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}{{classname}} | [**{{operationId}}**](docs/{{classname}}.md#{{operationId}}) | **{{httpMethod}}** {{path}} | {{#summary}}{{&summary}}{{/summary}} {{/operation}}{{/operations}}{{/apis}}{{/apiInfo}} +## Models -## Documentation for Models - -{{#models}}{{#model}} - [{{moduleName}}.{{classname}}](docs/{{classname}}.md) -{{/model}}{{/models}} +{{#models}}{{#model}}- [{{classname}}](docs/{{classname}}.md) +{{/model}}{{/models}} \ No newline at end of file diff --git a/pom.xml b/pom.xml index a8072914b3..d622bae352 100644 --- a/pom.xml +++ b/pom.xml @@ -9,12 +9,12 @@ ${project.basedir}/src 1.1-SNAPSHOT ${project.basedir}/definitions - 2.3.1 + 3.0.13 - io.swagger + io.swagger.codegen.v3 swagger-codegen-maven-plugin ${swagger-codegen-version} diff --git a/src/api/auth-rest-api/README.md b/src/api/auth-rest-api/README.md index f64a063baa..ccc42f5116 100644 --- a/src/api/auth-rest-api/README.md +++ b/src/api/auth-rest-api/README.md @@ -1,29 +1,29 @@ -**Authentication API** +# **Authentication API** Provides access to the authentication features of Alfresco Content Services. +> Documentation updated on: 2019-10-17T13:35:27.038+01:00 -- Last Build date: 2018-11-05T11:24:58.864Z +## Methods +All URIs are relative to: -## Documentation for API Endpoints - -All URIs are relative to *https://localhost/alfresco/api/-default-/public/authentication/versions/1* +```text +https://localhost/alfresco/api/-default-/public/authentication/versions/1 +``` Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- -*.AuthenticationApi* | [**createTicket**](docs/AuthenticationApi.md#createTicket) | **POST** /tickets | Create ticket (login) -*.AuthenticationApi* | [**deleteTicket**](docs/AuthenticationApi.md#deleteTicket) | **DELETE** /tickets/-me- | Delete ticket (logout) -*.AuthenticationApi* | [**validateTicket**](docs/AuthenticationApi.md#validateTicket) | **GET** /tickets/-me- | Validate ticket - - -## Documentation for Models - - - [ErrorError](docs/ErrorError.md) - - [ModelError](docs/ModelError.md) - - [Ticket](docs/Ticket.md) - - [TicketBody](docs/TicketBody.md) - - [TicketEntry](docs/TicketEntry.md) - - [ValidTicket](docs/ValidTicket.md) - - [ValidTicketEntry](docs/ValidTicketEntry.md) - +AuthenticationApi | [**createTicket**](docs/AuthenticationApi.md#createTicket) | **POST** /tickets | Create ticket (login) +AuthenticationApi | [**deleteTicket**](docs/AuthenticationApi.md#deleteTicket) | **DELETE** /tickets/-me- | Delete ticket (logout) +AuthenticationApi | [**validateTicket**](docs/AuthenticationApi.md#validateTicket) | **GET** /tickets/-me- | Validate ticket + +## Models + +- [ErrorError](docs/ErrorError.md) +- [ModelError](docs/ModelError.md) +- [Ticket](docs/Ticket.md) +- [TicketBody](docs/TicketBody.md) +- [TicketEntry](docs/TicketEntry.md) +- [ValidTicket](docs/ValidTicket.md) +- [ValidTicketEntry](docs/ValidTicketEntry.md) diff --git a/src/api/auth-rest-api/docs/AuthenticationApi.md b/src/api/auth-rest-api/docs/AuthenticationApi.md index 9f08b18e2f..9f84465a9c 100644 --- a/src/api/auth-rest-api/docs/AuthenticationApi.md +++ b/src/api/auth-rest-api/docs/AuthenticationApi.md @@ -10,7 +10,7 @@ Method | HTTP request | Description -# **createTicket** +## createTicket > TicketEntry createTicket(ticketBodyCreate) Create ticket (login) @@ -34,16 +34,15 @@ For example using Javascript: ### Example + ```javascript -import AuthenticationApi from 'AuthenticationApi'; -import { AlfrescoApi } from '@alfresco/js-api'; +import { AlfrescoApi, AuthenticationApi} from '@alfresco/js-api'; -this.alfrescoApi = new AlfrescoApi(); -this.alfrescoApi.setConfig({ +const alfrescoApi = new AlfrescoApi({ hostEcm: 'http://127.0.0.1:8080' }); -let authenticationApi = new AuthenticationApi(this.alfrescoApi); +const authenticationApi = new AuthenticationApi(alfrescoApi); authenticationApi.createTicket(ticketBodyCreate).then((data) => { @@ -51,7 +50,6 @@ authenticationApi.createTicket(ticketBodyCreate).then((data) => { }, function(error) { console.error(error); }); - ``` ### Parameters @@ -65,7 +63,7 @@ Name | Type | Description | Notes [**TicketEntry**](TicketEntry.md) -# **deleteTicket** +## deleteTicket > deleteTicket() Delete ticket (logout) @@ -76,23 +74,21 @@ Deletes logged in ticket (logout). ### Example + ```javascript -import AuthenticationApi from 'AuthenticationApi'; -import { AlfrescoApi } from '@alfresco/js-api'; +import { AlfrescoApi, AuthenticationApi} from '@alfresco/js-api'; -this.alfrescoApi = new AlfrescoApi(); -this.alfrescoApi.setConfig({ +const alfrescoApi = new AlfrescoApi({ hostEcm: 'http://127.0.0.1:8080' }); -let authenticationApi = new AuthenticationApi(this.alfrescoApi); +const authenticationApi = new AuthenticationApi(alfrescoApi); authenticationApi.deleteTicket().then(() => { console.log('API called successfully.'); }, function(error) { console.error(error); }); - ``` ### Parameters @@ -103,7 +99,7 @@ This endpoint does not need any parameter. null (empty response body) -# **validateTicket** +## validateTicket > ValidTicketEntry validateTicket() Validate ticket @@ -119,23 +115,21 @@ For example, you can pass the Authorization request header using Javascript: ### Example + ```javascript -import AuthenticationApi from 'AuthenticationApi'; -import { AlfrescoApi } from '@alfresco/js-api'; +import { AlfrescoApi, AuthenticationApi} from '@alfresco/js-api'; -this.alfrescoApi = new AlfrescoApi(); -this.alfrescoApi.setConfig({ +const alfrescoApi = new AlfrescoApi({ hostEcm: 'http://127.0.0.1:8080' }); -let authenticationApi = new AuthenticationApi(this.alfrescoApi); +const authenticationApi = new AuthenticationApi(alfrescoApi); authenticationApi.validateTicket().then((data) => { console.log('API called successfully. Returned data: ' + data); }, function(error) { console.error(error); }); - ``` ### Parameters diff --git a/src/api/content-rest-api/README.md b/src/api/content-rest-api/README.md index 5b030d0a90..5403c367fa 100644 --- a/src/api/content-rest-api/README.md +++ b/src/api/content-rest-api/README.md @@ -1,322 +1,321 @@ -**Core API** +# **Core API** Provides access to the core features of Alfresco Content Services. +> Documentation updated on: 2019-10-17T13:46:19.017+01:00 -- Last Build date: 2018-11-05T11:25:10.504Z +## Methods +All URIs are relative to: -## Documentation for API Endpoints - -All URIs are relative to *https://localhost/alfresco/api/-default-/public/alfresco/versions/1* +```text +https://localhost/alfresco/api/-default-/public/alfresco/versions/1 +``` Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- -*.ActionsApi* | [**actionDetails**](docs/ActionsApi.md#actionDetails) | **GET** /action-definitions/{actionDefinitionId} | Retrieve the details of an action definition -*.ActionsApi* | [**actionExec**](docs/ActionsApi.md#actionExec) | **POST** /action-executions | Execute an action -*.ActionsApi* | [**listActions**](docs/ActionsApi.md#listActions) | **GET** /action-definitions | Retrieve list of available actions -*.ActionsApi* | [**nodeActions**](docs/ActionsApi.md#nodeActions) | **GET** /nodes/{nodeId}/action-definitions | Retrieve actions for a node -*.ActivitiesApi* | [**listActivitiesForPerson**](docs/ActivitiesApi.md#listActivitiesForPerson) | **GET** /people/{personId}/activities | List activities -*.AuditApi* | [**deleteAuditEntriesForAuditApp**](docs/AuditApi.md#deleteAuditEntriesForAuditApp) | **DELETE** /audit-applications/{auditApplicationId}/audit-entries | Permanently delete audit entries for an audit application -*.AuditApi* | [**deleteAuditEntry**](docs/AuditApi.md#deleteAuditEntry) | **DELETE** /audit-applications/{auditApplicationId}/audit-entries/{auditEntryId} | Permanently delete an audit entry -*.AuditApi* | [**getAuditApp**](docs/AuditApi.md#getAuditApp) | **GET** /audit-applications/{auditApplicationId} | Get audit application info -*.AuditApi* | [**getAuditEntry**](docs/AuditApi.md#getAuditEntry) | **GET** /audit-applications/{auditApplicationId}/audit-entries/{auditEntryId} | Get audit entry -*.AuditApi* | [**listAuditApps**](docs/AuditApi.md#listAuditApps) | **GET** /audit-applications | List audit applications -*.AuditApi* | [**listAuditEntriesForAuditApp**](docs/AuditApi.md#listAuditEntriesForAuditApp) | **GET** /audit-applications/{auditApplicationId}/audit-entries | List audit entries for an audit application -*.AuditApi* | [**listAuditEntriesForNode**](docs/AuditApi.md#listAuditEntriesForNode) | **GET** /nodes/{nodeId}/audit-entries | List audit entries for a node -*.AuditApi* | [**updateAuditApp**](docs/AuditApi.md#updateAuditApp) | **PUT** /audit-applications/{auditApplicationId} | Update audit application info -*.CommentsApi* | [**createComment**](docs/CommentsApi.md#createComment) | **POST** /nodes/{nodeId}/comments | Create a comment -*.CommentsApi* | [**deleteComment**](docs/CommentsApi.md#deleteComment) | **DELETE** /nodes/{nodeId}/comments/{commentId} | Delete a comment -*.CommentsApi* | [**listComments**](docs/CommentsApi.md#listComments) | **GET** /nodes/{nodeId}/comments | List comments -*.CommentsApi* | [**updateComment**](docs/CommentsApi.md#updateComment) | **PUT** /nodes/{nodeId}/comments/{commentId} | Update a comment -*.DownloadsApi* | [**cancelDownload**](docs/DownloadsApi.md#cancelDownload) | **DELETE** /downloads/{downloadId} | Cancel a download -*.DownloadsApi* | [**createDownload**](docs/DownloadsApi.md#createDownload) | **POST** /downloads | Create a new download -*.DownloadsApi* | [**getDownload**](docs/DownloadsApi.md#getDownload) | **GET** /downloads/{downloadId} | Get a download -*.FavoritesApi* | [**createFavorite**](docs/FavoritesApi.md#createFavorite) | **POST** /people/{personId}/favorites | Create a favorite -*.FavoritesApi* | [**createSiteFavorite**](docs/FavoritesApi.md#createSiteFavorite) | **POST** /people/{personId}/favorite-sites | Create a site favorite -*.FavoritesApi* | [**deleteFavorite**](docs/FavoritesApi.md#deleteFavorite) | **DELETE** /people/{personId}/favorites/{favoriteId} | Delete a favorite -*.FavoritesApi* | [**deleteSiteFavorite**](docs/FavoritesApi.md#deleteSiteFavorite) | **DELETE** /people/{personId}/favorite-sites/{siteId} | Delete a site favorite -*.FavoritesApi* | [**getFavorite**](docs/FavoritesApi.md#getFavorite) | **GET** /people/{personId}/favorites/{favoriteId} | Get a favorite -*.FavoritesApi* | [**getFavoriteSite**](docs/FavoritesApi.md#getFavoriteSite) | **GET** /people/{personId}/favorite-sites/{siteId} | Get a favorite site -*.FavoritesApi* | [**listFavoriteSitesForPerson**](docs/FavoritesApi.md#listFavoriteSitesForPerson) | **GET** /people/{personId}/favorite-sites | List favorite sites -*.FavoritesApi* | [**listFavorites**](docs/FavoritesApi.md#listFavorites) | **GET** /people/{personId}/favorites | List favorites -*.GroupsApi* | [**createGroup**](docs/GroupsApi.md#createGroup) | **POST** /groups | Create a group -*.GroupsApi* | [**createGroupMembership**](docs/GroupsApi.md#createGroupMembership) | **POST** /groups/{groupId}/members | Create a group membership -*.GroupsApi* | [**deleteGroup**](docs/GroupsApi.md#deleteGroup) | **DELETE** /groups/{groupId} | Delete a group -*.GroupsApi* | [**deleteGroupMembership**](docs/GroupsApi.md#deleteGroupMembership) | **DELETE** /groups/{groupId}/members/{groupMemberId} | Delete a group membership -*.GroupsApi* | [**getGroup**](docs/GroupsApi.md#getGroup) | **GET** /groups/{groupId} | Get group details -*.GroupsApi* | [**listGroupMemberships**](docs/GroupsApi.md#listGroupMemberships) | **GET** /groups/{groupId}/members | List memberships of a group -*.GroupsApi* | [**listGroupMembershipsForPerson**](docs/GroupsApi.md#listGroupMembershipsForPerson) | **GET** /people/{personId}/groups | List group memberships -*.GroupsApi* | [**listGroups**](docs/GroupsApi.md#listGroups) | **GET** /groups | List groups -*.GroupsApi* | [**updateGroup**](docs/GroupsApi.md#updateGroup) | **PUT** /groups/{groupId} | Update group details -*.NetworksApi* | [**getNetwork**](docs/NetworksApi.md#getNetwork) | **GET** /networks/{networkId} | Get a network -*.NetworksApi* | [**getNetworkForPerson**](docs/NetworksApi.md#getNetworkForPerson) | **GET** /people/{personId}/networks/{networkId} | Get network information -*.NetworksApi* | [**listNetworksForPerson**](docs/NetworksApi.md#listNetworksForPerson) | **GET** /people/{personId}/networks | List network membership -*.NodesApi* | [**copyNode**](docs/NodesApi.md#copyNode) | **POST** /nodes/{nodeId}/copy | Copy a node -*.NodesApi* | [**createAssociation**](docs/NodesApi.md#createAssociation) | **POST** /nodes/{nodeId}/targets | Create node association -*.NodesApi* | [**createNode**](docs/NodesApi.md#createNode) | **POST** /nodes/{nodeId}/children | Create a node -*.NodesApi* | [**createSecondaryChildAssociation**](docs/NodesApi.md#createSecondaryChildAssociation) | **POST** /nodes/{nodeId}/secondary-children | Create secondary child -*.NodesApi* | [**deleteAssociation**](docs/NodesApi.md#deleteAssociation) | **DELETE** /nodes/{nodeId}/targets/{targetId} | Delete node association(s) -*.NodesApi* | [**deleteNode**](docs/NodesApi.md#deleteNode) | **DELETE** /nodes/{nodeId} | Delete a node -*.NodesApi* | [**deleteSecondaryChildAssociation**](docs/NodesApi.md#deleteSecondaryChildAssociation) | **DELETE** /nodes/{nodeId}/secondary-children/{childId} | Delete secondary child or children -*.NodesApi* | [**getNode**](docs/NodesApi.md#getNode) | **GET** /nodes/{nodeId} | Get a node -*.NodesApi* | [**getNodeContent**](docs/NodesApi.md#getNodeContent) | **GET** /nodes/{nodeId}/content | Get node content -*.NodesApi* | [**listNodeChildren**](docs/NodesApi.md#listNodeChildren) | **GET** /nodes/{nodeId}/children | List node children -*.NodesApi* | [**listParents**](docs/NodesApi.md#listParents) | **GET** /nodes/{nodeId}/parents | List parents -*.NodesApi* | [**listSecondaryChildren**](docs/NodesApi.md#listSecondaryChildren) | **GET** /nodes/{nodeId}/secondary-children | List secondary children -*.NodesApi* | [**listSourceAssociations**](docs/NodesApi.md#listSourceAssociations) | **GET** /nodes/{nodeId}/sources | List source associations -*.NodesApi* | [**listTargetAssociations**](docs/NodesApi.md#listTargetAssociations) | **GET** /nodes/{nodeId}/targets | List target associations -*.NodesApi* | [**lockNode**](docs/NodesApi.md#lockNode) | **POST** /nodes/{nodeId}/lock | Lock a node -*.NodesApi* | [**moveNode**](docs/NodesApi.md#moveNode) | **POST** /nodes/{nodeId}/move | Move a node -*.NodesApi* | [**unlockNode**](docs/NodesApi.md#unlockNode) | **POST** /nodes/{nodeId}/unlock | Unlock a node -*.NodesApi* | [**updateNode**](docs/NodesApi.md#updateNode) | **PUT** /nodes/{nodeId} | Update a node -*.NodesApi* | [**updateNodeContent**](docs/NodesApi.md#updateNodeContent) | **PUT** /nodes/{nodeId}/content | Update node content -*.PeopleApi* | [**createPerson**](docs/PeopleApi.md#createPerson) | **POST** /people | Create person -*.PeopleApi* | [**deleteAvatarImage**](docs/PeopleApi.md#deleteAvatarImage) | **DELETE** /people/{personId}/avatar | Delete avatar image -*.PeopleApi* | [**getAvatarImage**](docs/PeopleApi.md#getAvatarImage) | **GET** /people/{personId}/avatar | Get avatar image -*.PeopleApi* | [**getPerson**](docs/PeopleApi.md#getPerson) | **GET** /people/{personId} | Get a person -*.PeopleApi* | [**listPeople**](docs/PeopleApi.md#listPeople) | **GET** /people | List people -*.PeopleApi* | [**requestPasswordReset**](docs/PeopleApi.md#requestPasswordReset) | **POST** /people/{personId}/request-password-reset | Request password reset -*.PeopleApi* | [**resetPassword**](docs/PeopleApi.md#resetPassword) | **POST** /people/{personId}/reset-password | Reset password -*.PeopleApi* | [**updateAvatarImage**](docs/PeopleApi.md#updateAvatarImage) | **PUT** /people/{personId}/avatar | Update avatar image -*.PeopleApi* | [**updatePerson**](docs/PeopleApi.md#updatePerson) | **PUT** /people/{personId} | Update person -*.PreferencesApi* | [**getPreference**](docs/PreferencesApi.md#getPreference) | **GET** /people/{personId}/preferences/{preferenceName} | Get a preference -*.PreferencesApi* | [**listPreferences**](docs/PreferencesApi.md#listPreferences) | **GET** /people/{personId}/preferences | List preferences -*.ProbesApi* | [**getProbe**](docs/ProbesApi.md#getProbe) | **GET** /probes/{probeId} | Check readiness and liveness of the repository -*.QueriesApi* | [**findNodes**](docs/QueriesApi.md#findNodes) | **GET** /queries/nodes | Find nodes -*.QueriesApi* | [**findPeople**](docs/QueriesApi.md#findPeople) | **GET** /queries/people | Find people -*.QueriesApi* | [**findSites**](docs/QueriesApi.md#findSites) | **GET** /queries/sites | Find sites -*.RatingsApi* | [**createRating**](docs/RatingsApi.md#createRating) | **POST** /nodes/{nodeId}/ratings | Create a rating -*.RatingsApi* | [**deleteRating**](docs/RatingsApi.md#deleteRating) | **DELETE** /nodes/{nodeId}/ratings/{ratingId} | Delete a rating -*.RatingsApi* | [**getRating**](docs/RatingsApi.md#getRating) | **GET** /nodes/{nodeId}/ratings/{ratingId} | Get a rating -*.RatingsApi* | [**listRatings**](docs/RatingsApi.md#listRatings) | **GET** /nodes/{nodeId}/ratings | List ratings -*.RenditionsApi* | [**createRendition**](docs/RenditionsApi.md#createRendition) | **POST** /nodes/{nodeId}/renditions | Create rendition -*.RenditionsApi* | [**getRendition**](docs/RenditionsApi.md#getRendition) | **GET** /nodes/{nodeId}/renditions/{renditionId} | Get rendition information -*.RenditionsApi* | [**getRenditionContent**](docs/RenditionsApi.md#getRenditionContent) | **GET** /nodes/{nodeId}/renditions/{renditionId}/content | Get rendition content -*.RenditionsApi* | [**listRenditions**](docs/RenditionsApi.md#listRenditions) | **GET** /nodes/{nodeId}/renditions | List renditions -*.SharedlinksApi* | [**createSharedLink**](docs/SharedlinksApi.md#createSharedLink) | **POST** /shared-links | Create a shared link to a file -*.SharedlinksApi* | [**deleteSharedLink**](docs/SharedlinksApi.md#deleteSharedLink) | **DELETE** /shared-links/{sharedId} | Deletes a shared link -*.SharedlinksApi* | [**emailSharedLink**](docs/SharedlinksApi.md#emailSharedLink) | **POST** /shared-links/{sharedId}/email | Email shared link -*.SharedlinksApi* | [**getSharedLink**](docs/SharedlinksApi.md#getSharedLink) | **GET** /shared-links/{sharedId} | Get a shared link -*.SharedlinksApi* | [**getSharedLinkContent**](docs/SharedlinksApi.md#getSharedLinkContent) | **GET** /shared-links/{sharedId}/content | Get shared link content -*.SharedlinksApi* | [**getSharedLinkRendition**](docs/SharedlinksApi.md#getSharedLinkRendition) | **GET** /shared-links/{sharedId}/renditions/{renditionId} | Get shared link rendition information -*.SharedlinksApi* | [**getSharedLinkRenditionContent**](docs/SharedlinksApi.md#getSharedLinkRenditionContent) | **GET** /shared-links/{sharedId}/renditions/{renditionId}/content | Get shared link rendition content -*.SharedlinksApi* | [**listSharedLinkRenditions**](docs/SharedlinksApi.md#listSharedLinkRenditions) | **GET** /shared-links/{sharedId}/renditions | List renditions for a shared link -*.SharedlinksApi* | [**listSharedLinks**](docs/SharedlinksApi.md#listSharedLinks) | **GET** /shared-links | List shared links -*.SitesApi* | [**approveSiteMembershipRequest**](docs/SitesApi.md#approveSiteMembershipRequest) | **POST** /sites/{siteId}/site-membership-requests/{inviteeId}/approve | Approve a site membership request -*.SitesApi* | [**createSite**](docs/SitesApi.md#createSite) | **POST** /sites | Create a site -*.SitesApi* | [**createSiteMembership**](docs/SitesApi.md#createSiteMembership) | **POST** /sites/{siteId}/members | Create a site membership -*.SitesApi* | [**createSiteMembershipRequestForPerson**](docs/SitesApi.md#createSiteMembershipRequestForPerson) | **POST** /people/{personId}/site-membership-requests | Create a site membership request -*.SitesApi* | [**deleteSite**](docs/SitesApi.md#deleteSite) | **DELETE** /sites/{siteId} | Delete a site -*.SitesApi* | [**deleteSiteMembership**](docs/SitesApi.md#deleteSiteMembership) | **DELETE** /sites/{siteId}/members/{personId} | Delete a site membership -*.SitesApi* | [**deleteSiteMembershipForPerson**](docs/SitesApi.md#deleteSiteMembershipForPerson) | **DELETE** /people/{personId}/sites/{siteId} | Delete a site membership -*.SitesApi* | [**deleteSiteMembershipRequestForPerson**](docs/SitesApi.md#deleteSiteMembershipRequestForPerson) | **DELETE** /people/{personId}/site-membership-requests/{siteId} | Delete a site membership request -*.SitesApi* | [**getSite**](docs/SitesApi.md#getSite) | **GET** /sites/{siteId} | Get a site -*.SitesApi* | [**getSiteContainer**](docs/SitesApi.md#getSiteContainer) | **GET** /sites/{siteId}/containers/{containerId} | Get a site container -*.SitesApi* | [**getSiteMembership**](docs/SitesApi.md#getSiteMembership) | **GET** /sites/{siteId}/members/{personId} | Get a site membership -*.SitesApi* | [**getSiteMembershipForPerson**](docs/SitesApi.md#getSiteMembershipForPerson) | **GET** /people/{personId}/sites/{siteId} | Get a site membership -*.SitesApi* | [**getSiteMembershipRequestForPerson**](docs/SitesApi.md#getSiteMembershipRequestForPerson) | **GET** /people/{personId}/site-membership-requests/{siteId} | Get a site membership request -*.SitesApi* | [**getSiteMembershipRequests**](docs/SitesApi.md#getSiteMembershipRequests) | **GET** /site-membership-requests | Get site membership requests -*.SitesApi* | [**listSiteContainers**](docs/SitesApi.md#listSiteContainers) | **GET** /sites/{siteId}/containers | List site containers -*.SitesApi* | [**listSiteMembershipRequestsForPerson**](docs/SitesApi.md#listSiteMembershipRequestsForPerson) | **GET** /people/{personId}/site-membership-requests | List site membership requests -*.SitesApi* | [**listSiteMemberships**](docs/SitesApi.md#listSiteMemberships) | **GET** /sites/{siteId}/members | List site memberships -*.SitesApi* | [**listSiteMembershipsForPerson**](docs/SitesApi.md#listSiteMembershipsForPerson) | **GET** /people/{personId}/sites | List site memberships -*.SitesApi* | [**listSites**](docs/SitesApi.md#listSites) | **GET** /sites | List sites -*.SitesApi* | [**rejectSiteMembershipRequest**](docs/SitesApi.md#rejectSiteMembershipRequest) | **POST** /sites/{siteId}/site-membership-requests/{inviteeId}/reject | Reject a site membership request -*.SitesApi* | [**updateSite**](docs/SitesApi.md#updateSite) | **PUT** /sites/{siteId} | Update a site -*.SitesApi* | [**updateSiteMembership**](docs/SitesApi.md#updateSiteMembership) | **PUT** /sites/{siteId}/members/{personId} | Update a site membership -*.SitesApi* | [**updateSiteMembershipRequestForPerson**](docs/SitesApi.md#updateSiteMembershipRequestForPerson) | **PUT** /people/{personId}/site-membership-requests/{siteId} | Update a site membership request -*.TagsApi* | [**createTagForNode**](docs/TagsApi.md#createTagForNode) | **POST** /nodes/{nodeId}/tags | Create a tag for a node -*.TagsApi* | [**deleteTagFromNode**](docs/TagsApi.md#deleteTagFromNode) | **DELETE** /nodes/{nodeId}/tags/{tagId} | Delete a tag from a node -*.TagsApi* | [**getTag**](docs/TagsApi.md#getTag) | **GET** /tags/{tagId} | Get a tag -*.TagsApi* | [**listTags**](docs/TagsApi.md#listTags) | **GET** /tags | List tags -*.TagsApi* | [**listTagsForNode**](docs/TagsApi.md#listTagsForNode) | **GET** /nodes/{nodeId}/tags | List tags for a node -*.TagsApi* | [**updateTag**](docs/TagsApi.md#updateTag) | **PUT** /tags/{tagId} | Update a tag -*.TrashcanApi* | [**deleteDeletedNode**](docs/TrashcanApi.md#deleteDeletedNode) | **DELETE** /deleted-nodes/{nodeId} | Permanently delete a deleted node -*.TrashcanApi* | [**getArchivedNodeRendition**](docs/TrashcanApi.md#getArchivedNodeRendition) | **GET** /deleted-nodes/{nodeId}/renditions/{renditionId} | Get rendition information for a deleted node -*.TrashcanApi* | [**getArchivedNodeRenditionContent**](docs/TrashcanApi.md#getArchivedNodeRenditionContent) | **GET** /deleted-nodes/{nodeId}/renditions/{renditionId}/content | Get rendition content of a deleted node -*.TrashcanApi* | [**getDeletedNode**](docs/TrashcanApi.md#getDeletedNode) | **GET** /deleted-nodes/{nodeId} | Get a deleted node -*.TrashcanApi* | [**getDeletedNodeContent**](docs/TrashcanApi.md#getDeletedNodeContent) | **GET** /deleted-nodes/{nodeId}/content | Get deleted node content -*.TrashcanApi* | [**listDeletedNodeRenditions**](docs/TrashcanApi.md#listDeletedNodeRenditions) | **GET** /deleted-nodes/{nodeId}/renditions | List renditions for a deleted node -*.TrashcanApi* | [**listDeletedNodes**](docs/TrashcanApi.md#listDeletedNodes) | **GET** /deleted-nodes | List deleted nodes -*.TrashcanApi* | [**restoreDeletedNode**](docs/TrashcanApi.md#restoreDeletedNode) | **POST** /deleted-nodes/{nodeId}/restore | Restore a deleted node -*.VersionsApi* | [**deleteVersion**](docs/VersionsApi.md#deleteVersion) | **DELETE** /nodes/{nodeId}/versions/{versionId} | Delete a version -*.VersionsApi* | [**getVersion**](docs/VersionsApi.md#getVersion) | **GET** /nodes/{nodeId}/versions/{versionId} | Get version information -*.VersionsApi* | [**getVersionContent**](docs/VersionsApi.md#getVersionContent) | **GET** /nodes/{nodeId}/versions/{versionId}/content | Get version content -*.VersionsApi* | [**listVersionHistory**](docs/VersionsApi.md#listVersionHistory) | **GET** /nodes/{nodeId}/versions | List version history -*.VersionsApi* | [**revertVersion**](docs/VersionsApi.md#revertVersion) | **POST** /nodes/{nodeId}/versions/{versionId}/revert | Revert a version -*.WebscriptApi* | [**executeWebScript**](docs/WebscriptApi.md#executeWebScript) | | execute WebScript -*.UploadApi* | [**uploadFile**](docs/UploadApi.md#uploadFile) | | execute WebScript - -## Documentation for Models +ActionsApi | [**actionDetails**](docs/ActionsApi.md#actionDetails) | **GET** /action-definitions/{actionDefinitionId} | Retrieve the details of an action definition +ActionsApi | [**actionExec**](docs/ActionsApi.md#actionExec) | **POST** /action-executions | Execute an action +ActionsApi | [**listActions**](docs/ActionsApi.md#listActions) | **GET** /action-definitions | Retrieve list of available actions +ActionsApi | [**nodeActions**](docs/ActionsApi.md#nodeActions) | **GET** /nodes/{nodeId}/action-definitions | Retrieve actions for a node +ActivitiesApi | [**listActivitiesForPerson**](docs/ActivitiesApi.md#listActivitiesForPerson) | **GET** /people/{personId}/activities | List activities +AuditApi | [**deleteAuditEntriesForAuditApp**](docs/AuditApi.md#deleteAuditEntriesForAuditApp) | **DELETE** /audit-applications/{auditApplicationId}/audit-entries | Permanently delete audit entries for an audit application +AuditApi | [**deleteAuditEntry**](docs/AuditApi.md#deleteAuditEntry) | **DELETE** /audit-applications/{auditApplicationId}/audit-entries/{auditEntryId} | Permanently delete an audit entry +AuditApi | [**getAuditApp**](docs/AuditApi.md#getAuditApp) | **GET** /audit-applications/{auditApplicationId} | Get audit application info +AuditApi | [**getAuditEntry**](docs/AuditApi.md#getAuditEntry) | **GET** /audit-applications/{auditApplicationId}/audit-entries/{auditEntryId} | Get audit entry +AuditApi | [**listAuditApps**](docs/AuditApi.md#listAuditApps) | **GET** /audit-applications | List audit applications +AuditApi | [**listAuditEntriesForAuditApp**](docs/AuditApi.md#listAuditEntriesForAuditApp) | **GET** /audit-applications/{auditApplicationId}/audit-entries | List audit entries for an audit application +AuditApi | [**listAuditEntriesForNode**](docs/AuditApi.md#listAuditEntriesForNode) | **GET** /nodes/{nodeId}/audit-entries | List audit entries for a node +AuditApi | [**updateAuditApp**](docs/AuditApi.md#updateAuditApp) | **PUT** /audit-applications/{auditApplicationId} | Update audit application info +CommentsApi | [**createComment**](docs/CommentsApi.md#createComment) | **POST** /nodes/{nodeId}/comments | Create a comment +CommentsApi | [**deleteComment**](docs/CommentsApi.md#deleteComment) | **DELETE** /nodes/{nodeId}/comments/{commentId} | Delete a comment +CommentsApi | [**listComments**](docs/CommentsApi.md#listComments) | **GET** /nodes/{nodeId}/comments | List comments +CommentsApi | [**updateComment**](docs/CommentsApi.md#updateComment) | **PUT** /nodes/{nodeId}/comments/{commentId} | Update a comment +DownloadsApi | [**cancelDownload**](docs/DownloadsApi.md#cancelDownload) | **DELETE** /downloads/{downloadId} | Cancel a download +DownloadsApi | [**createDownload**](docs/DownloadsApi.md#createDownload) | **POST** /downloads | Create a new download +DownloadsApi | [**getDownload**](docs/DownloadsApi.md#getDownload) | **GET** /downloads/{downloadId} | Get a download +FavoritesApi | [**createFavorite**](docs/FavoritesApi.md#createFavorite) | **POST** /people/{personId}/favorites | Create a favorite +FavoritesApi | [**createSiteFavorite**](docs/FavoritesApi.md#createSiteFavorite) | **POST** /people/{personId}/favorite-sites | Create a site favorite +FavoritesApi | [**deleteFavorite**](docs/FavoritesApi.md#deleteFavorite) | **DELETE** /people/{personId}/favorites/{favoriteId} | Delete a favorite +FavoritesApi | [**deleteSiteFavorite**](docs/FavoritesApi.md#deleteSiteFavorite) | **DELETE** /people/{personId}/favorite-sites/{siteId} | Delete a site favorite +FavoritesApi | [**getFavorite**](docs/FavoritesApi.md#getFavorite) | **GET** /people/{personId}/favorites/{favoriteId} | Get a favorite +FavoritesApi | [**getFavoriteSite**](docs/FavoritesApi.md#getFavoriteSite) | **GET** /people/{personId}/favorite-sites/{siteId} | Get a favorite site +FavoritesApi | [**listFavoriteSitesForPerson**](docs/FavoritesApi.md#listFavoriteSitesForPerson) | **GET** /people/{personId}/favorite-sites | List favorite sites +FavoritesApi | [**listFavorites**](docs/FavoritesApi.md#listFavorites) | **GET** /people/{personId}/favorites | List favorites +GroupsApi | [**createGroup**](docs/GroupsApi.md#createGroup) | **POST** /groups | Create a group +GroupsApi | [**createGroupMembership**](docs/GroupsApi.md#createGroupMembership) | **POST** /groups/{groupId}/members | Create a group membership +GroupsApi | [**deleteGroup**](docs/GroupsApi.md#deleteGroup) | **DELETE** /groups/{groupId} | Delete a group +GroupsApi | [**deleteGroupMembership**](docs/GroupsApi.md#deleteGroupMembership) | **DELETE** /groups/{groupId}/members/{groupMemberId} | Delete a group membership +GroupsApi | [**getGroup**](docs/GroupsApi.md#getGroup) | **GET** /groups/{groupId} | Get group details +GroupsApi | [**listGroupMemberships**](docs/GroupsApi.md#listGroupMemberships) | **GET** /groups/{groupId}/members | List memberships of a group +GroupsApi | [**listGroupMembershipsForPerson**](docs/GroupsApi.md#listGroupMembershipsForPerson) | **GET** /people/{personId}/groups | List group memberships +GroupsApi | [**listGroups**](docs/GroupsApi.md#listGroups) | **GET** /groups | List groups +GroupsApi | [**updateGroup**](docs/GroupsApi.md#updateGroup) | **PUT** /groups/{groupId} | Update group details +NetworksApi | [**getNetwork**](docs/NetworksApi.md#getNetwork) | **GET** /networks/{networkId} | Get a network +NetworksApi | [**getNetworkForPerson**](docs/NetworksApi.md#getNetworkForPerson) | **GET** /people/{personId}/networks/{networkId} | Get network information +NetworksApi | [**listNetworksForPerson**](docs/NetworksApi.md#listNetworksForPerson) | **GET** /people/{personId}/networks | List network membership +NodesApi | [**copyNode**](docs/NodesApi.md#copyNode) | **POST** /nodes/{nodeId}/copy | Copy a node +NodesApi | [**createAssociation**](docs/NodesApi.md#createAssociation) | **POST** /nodes/{nodeId}/targets | Create node association +NodesApi | [**createNode**](docs/NodesApi.md#createNode) | **POST** /nodes/{nodeId}/children | Create a node +NodesApi | [**createSecondaryChildAssociation**](docs/NodesApi.md#createSecondaryChildAssociation) | **POST** /nodes/{nodeId}/secondary-children | Create secondary child +NodesApi | [**deleteAssociation**](docs/NodesApi.md#deleteAssociation) | **DELETE** /nodes/{nodeId}/targets/{targetId} | Delete node association(s) +NodesApi | [**deleteNode**](docs/NodesApi.md#deleteNode) | **DELETE** /nodes/{nodeId} | Delete a node +NodesApi | [**deleteSecondaryChildAssociation**](docs/NodesApi.md#deleteSecondaryChildAssociation) | **DELETE** /nodes/{nodeId}/secondary-children/{childId} | Delete secondary child or children +NodesApi | [**getNode**](docs/NodesApi.md#getNode) | **GET** /nodes/{nodeId} | Get a node +NodesApi | [**getNodeContent**](docs/NodesApi.md#getNodeContent) | **GET** /nodes/{nodeId}/content | Get node content +NodesApi | [**listNodeChildren**](docs/NodesApi.md#listNodeChildren) | **GET** /nodes/{nodeId}/children | List node children +NodesApi | [**listParents**](docs/NodesApi.md#listParents) | **GET** /nodes/{nodeId}/parents | List parents +NodesApi | [**listSecondaryChildren**](docs/NodesApi.md#listSecondaryChildren) | **GET** /nodes/{nodeId}/secondary-children | List secondary children +NodesApi | [**listSourceAssociations**](docs/NodesApi.md#listSourceAssociations) | **GET** /nodes/{nodeId}/sources | List source associations +NodesApi | [**listTargetAssociations**](docs/NodesApi.md#listTargetAssociations) | **GET** /nodes/{nodeId}/targets | List target associations +NodesApi | [**lockNode**](docs/NodesApi.md#lockNode) | **POST** /nodes/{nodeId}/lock | Lock a node +NodesApi | [**moveNode**](docs/NodesApi.md#moveNode) | **POST** /nodes/{nodeId}/move | Move a node +NodesApi | [**unlockNode**](docs/NodesApi.md#unlockNode) | **POST** /nodes/{nodeId}/unlock | Unlock a node +NodesApi | [**updateNode**](docs/NodesApi.md#updateNode) | **PUT** /nodes/{nodeId} | Update a node +NodesApi | [**updateNodeContent**](docs/NodesApi.md#updateNodeContent) | **PUT** /nodes/{nodeId}/content | Update node content +PeopleApi | [**createPerson**](docs/PeopleApi.md#createPerson) | **POST** /people | Create person +PeopleApi | [**deleteAvatarImage**](docs/PeopleApi.md#deleteAvatarImage) | **DELETE** /people/{personId}/avatar | Delete avatar image +PeopleApi | [**getAvatarImage**](docs/PeopleApi.md#getAvatarImage) | **GET** /people/{personId}/avatar | Get avatar image +PeopleApi | [**getPerson**](docs/PeopleApi.md#getPerson) | **GET** /people/{personId} | Get a person +PeopleApi | [**listPeople**](docs/PeopleApi.md#listPeople) | **GET** /people | List people +PeopleApi | [**requestPasswordReset**](docs/PeopleApi.md#requestPasswordReset) | **POST** /people/{personId}/request-password-reset | Request password reset +PeopleApi | [**resetPassword**](docs/PeopleApi.md#resetPassword) | **POST** /people/{personId}/reset-password | Reset password +PeopleApi | [**updateAvatarImage**](docs/PeopleApi.md#updateAvatarImage) | **PUT** /people/{personId}/avatar | Update avatar image +PeopleApi | [**updatePerson**](docs/PeopleApi.md#updatePerson) | **PUT** /people/{personId} | Update person +PreferencesApi | [**getPreference**](docs/PreferencesApi.md#getPreference) | **GET** /people/{personId}/preferences/{preferenceName} | Get a preference +PreferencesApi | [**listPreferences**](docs/PreferencesApi.md#listPreferences) | **GET** /people/{personId}/preferences | List preferences +ProbesApi | [**getProbe**](docs/ProbesApi.md#getProbe) | **GET** /probes/{probeId} | Check readiness and liveness of the repository +QueriesApi | [**findNodes**](docs/QueriesApi.md#findNodes) | **GET** /queries/nodes | Find nodes +QueriesApi | [**findPeople**](docs/QueriesApi.md#findPeople) | **GET** /queries/people | Find people +QueriesApi | [**findSites**](docs/QueriesApi.md#findSites) | **GET** /queries/sites | Find sites +RatingsApi | [**createRating**](docs/RatingsApi.md#createRating) | **POST** /nodes/{nodeId}/ratings | Create a rating +RatingsApi | [**deleteRating**](docs/RatingsApi.md#deleteRating) | **DELETE** /nodes/{nodeId}/ratings/{ratingId} | Delete a rating +RatingsApi | [**getRating**](docs/RatingsApi.md#getRating) | **GET** /nodes/{nodeId}/ratings/{ratingId} | Get a rating +RatingsApi | [**listRatings**](docs/RatingsApi.md#listRatings) | **GET** /nodes/{nodeId}/ratings | List ratings +RenditionsApi | [**createRendition**](docs/RenditionsApi.md#createRendition) | **POST** /nodes/{nodeId}/renditions | Create rendition +RenditionsApi | [**getRendition**](docs/RenditionsApi.md#getRendition) | **GET** /nodes/{nodeId}/renditions/{renditionId} | Get rendition information +RenditionsApi | [**getRenditionContent**](docs/RenditionsApi.md#getRenditionContent) | **GET** /nodes/{nodeId}/renditions/{renditionId}/content | Get rendition content +RenditionsApi | [**listRenditions**](docs/RenditionsApi.md#listRenditions) | **GET** /nodes/{nodeId}/renditions | List renditions +SharedlinksApi | [**createSharedLink**](docs/SharedlinksApi.md#createSharedLink) | **POST** /shared-links | Create a shared link to a file +SharedlinksApi | [**deleteSharedLink**](docs/SharedlinksApi.md#deleteSharedLink) | **DELETE** /shared-links/{sharedId} | Deletes a shared link +SharedlinksApi | [**emailSharedLink**](docs/SharedlinksApi.md#emailSharedLink) | **POST** /shared-links/{sharedId}/email | Email shared link +SharedlinksApi | [**getSharedLink**](docs/SharedlinksApi.md#getSharedLink) | **GET** /shared-links/{sharedId} | Get a shared link +SharedlinksApi | [**getSharedLinkContent**](docs/SharedlinksApi.md#getSharedLinkContent) | **GET** /shared-links/{sharedId}/content | Get shared link content +SharedlinksApi | [**getSharedLinkRendition**](docs/SharedlinksApi.md#getSharedLinkRendition) | **GET** /shared-links/{sharedId}/renditions/{renditionId} | Get shared link rendition information +SharedlinksApi | [**getSharedLinkRenditionContent**](docs/SharedlinksApi.md#getSharedLinkRenditionContent) | **GET** /shared-links/{sharedId}/renditions/{renditionId}/content | Get shared link rendition content +SharedlinksApi | [**listSharedLinkRenditions**](docs/SharedlinksApi.md#listSharedLinkRenditions) | **GET** /shared-links/{sharedId}/renditions | List renditions for a shared link +SharedlinksApi | [**listSharedLinks**](docs/SharedlinksApi.md#listSharedLinks) | **GET** /shared-links | List shared links +SitesApi | [**approveSiteMembershipRequest**](docs/SitesApi.md#approveSiteMembershipRequest) | **POST** /sites/{siteId}/site-membership-requests/{inviteeId}/approve | Approve a site membership request +SitesApi | [**createSite**](docs/SitesApi.md#createSite) | **POST** /sites | Create a site +SitesApi | [**createSiteMembership**](docs/SitesApi.md#createSiteMembership) | **POST** /sites/{siteId}/members | Create a site membership +SitesApi | [**createSiteMembershipRequestForPerson**](docs/SitesApi.md#createSiteMembershipRequestForPerson) | **POST** /people/{personId}/site-membership-requests | Create a site membership request +SitesApi | [**deleteSite**](docs/SitesApi.md#deleteSite) | **DELETE** /sites/{siteId} | Delete a site +SitesApi | [**deleteSiteMembership**](docs/SitesApi.md#deleteSiteMembership) | **DELETE** /sites/{siteId}/members/{personId} | Delete a site membership +SitesApi | [**deleteSiteMembershipForPerson**](docs/SitesApi.md#deleteSiteMembershipForPerson) | **DELETE** /people/{personId}/sites/{siteId} | Delete a site membership +SitesApi | [**deleteSiteMembershipRequestForPerson**](docs/SitesApi.md#deleteSiteMembershipRequestForPerson) | **DELETE** /people/{personId}/site-membership-requests/{siteId} | Delete a site membership request +SitesApi | [**getSite**](docs/SitesApi.md#getSite) | **GET** /sites/{siteId} | Get a site +SitesApi | [**getSiteContainer**](docs/SitesApi.md#getSiteContainer) | **GET** /sites/{siteId}/containers/{containerId} | Get a site container +SitesApi | [**getSiteMembership**](docs/SitesApi.md#getSiteMembership) | **GET** /sites/{siteId}/members/{personId} | Get a site membership +SitesApi | [**getSiteMembershipForPerson**](docs/SitesApi.md#getSiteMembershipForPerson) | **GET** /people/{personId}/sites/{siteId} | Get a site membership +SitesApi | [**getSiteMembershipRequestForPerson**](docs/SitesApi.md#getSiteMembershipRequestForPerson) | **GET** /people/{personId}/site-membership-requests/{siteId} | Get a site membership request +SitesApi | [**getSiteMembershipRequests**](docs/SitesApi.md#getSiteMembershipRequests) | **GET** /site-membership-requests | Get site membership requests +SitesApi | [**listSiteContainers**](docs/SitesApi.md#listSiteContainers) | **GET** /sites/{siteId}/containers | List site containers +SitesApi | [**listSiteMembershipRequestsForPerson**](docs/SitesApi.md#listSiteMembershipRequestsForPerson) | **GET** /people/{personId}/site-membership-requests | List site membership requests +SitesApi | [**listSiteMemberships**](docs/SitesApi.md#listSiteMemberships) | **GET** /sites/{siteId}/members | List site memberships +SitesApi | [**listSiteMembershipsForPerson**](docs/SitesApi.md#listSiteMembershipsForPerson) | **GET** /people/{personId}/sites | List site memberships +SitesApi | [**listSites**](docs/SitesApi.md#listSites) | **GET** /sites | List sites +SitesApi | [**rejectSiteMembershipRequest**](docs/SitesApi.md#rejectSiteMembershipRequest) | **POST** /sites/{siteId}/site-membership-requests/{inviteeId}/reject | Reject a site membership request +SitesApi | [**updateSite**](docs/SitesApi.md#updateSite) | **PUT** /sites/{siteId} | Update a site +SitesApi | [**updateSiteMembership**](docs/SitesApi.md#updateSiteMembership) | **PUT** /sites/{siteId}/members/{personId} | Update a site membership +SitesApi | [**updateSiteMembershipRequestForPerson**](docs/SitesApi.md#updateSiteMembershipRequestForPerson) | **PUT** /people/{personId}/site-membership-requests/{siteId} | Update a site membership request +TagsApi | [**createTagForNode**](docs/TagsApi.md#createTagForNode) | **POST** /nodes/{nodeId}/tags | Create a tag for a node +TagsApi | [**deleteTagFromNode**](docs/TagsApi.md#deleteTagFromNode) | **DELETE** /nodes/{nodeId}/tags/{tagId} | Delete a tag from a node +TagsApi | [**getTag**](docs/TagsApi.md#getTag) | **GET** /tags/{tagId} | Get a tag +TagsApi | [**listTags**](docs/TagsApi.md#listTags) | **GET** /tags | List tags +TagsApi | [**listTagsForNode**](docs/TagsApi.md#listTagsForNode) | **GET** /nodes/{nodeId}/tags | List tags for a node +TagsApi | [**updateTag**](docs/TagsApi.md#updateTag) | **PUT** /tags/{tagId} | Update a tag +TrashcanApi | [**deleteDeletedNode**](docs/TrashcanApi.md#deleteDeletedNode) | **DELETE** /deleted-nodes/{nodeId} | Permanently delete a deleted node +TrashcanApi | [**getArchivedNodeRendition**](docs/TrashcanApi.md#getArchivedNodeRendition) | **GET** /deleted-nodes/{nodeId}/renditions/{renditionId} | Get rendition information for a deleted node +TrashcanApi | [**getArchivedNodeRenditionContent**](docs/TrashcanApi.md#getArchivedNodeRenditionContent) | **GET** /deleted-nodes/{nodeId}/renditions/{renditionId}/content | Get rendition content of a deleted node +TrashcanApi | [**getDeletedNode**](docs/TrashcanApi.md#getDeletedNode) | **GET** /deleted-nodes/{nodeId} | Get a deleted node +TrashcanApi | [**getDeletedNodeContent**](docs/TrashcanApi.md#getDeletedNodeContent) | **GET** /deleted-nodes/{nodeId}/content | Get deleted node content +TrashcanApi | [**listDeletedNodeRenditions**](docs/TrashcanApi.md#listDeletedNodeRenditions) | **GET** /deleted-nodes/{nodeId}/renditions | List renditions for a deleted node +TrashcanApi | [**listDeletedNodes**](docs/TrashcanApi.md#listDeletedNodes) | **GET** /deleted-nodes | List deleted nodes +TrashcanApi | [**restoreDeletedNode**](docs/TrashcanApi.md#restoreDeletedNode) | **POST** /deleted-nodes/{nodeId}/restore | Restore a deleted node +VersionsApi | [**deleteVersion**](docs/VersionsApi.md#deleteVersion) | **DELETE** /nodes/{nodeId}/versions/{versionId} | Delete a version +VersionsApi | [**getVersion**](docs/VersionsApi.md#getVersion) | **GET** /nodes/{nodeId}/versions/{versionId} | Get version information +VersionsApi | [**getVersionContent**](docs/VersionsApi.md#getVersionContent) | **GET** /nodes/{nodeId}/versions/{versionId}/content | Get version content +VersionsApi | [**listVersionHistory**](docs/VersionsApi.md#listVersionHistory) | **GET** /nodes/{nodeId}/versions | List version history +VersionsApi | [**revertVersion**](docs/VersionsApi.md#revertVersion) | **POST** /nodes/{nodeId}/versions/{versionId}/revert | Revert a version - - [ActionBodyExec](docs/ActionBodyExec.md) - - [ActionDefinition](docs/ActionDefinition.md) - - [ActionDefinitionEntry](docs/ActionDefinitionEntry.md) - - [ActionDefinitionList](docs/ActionDefinitionList.md) - - [ActionDefinitionListList](docs/ActionDefinitionListList.md) - - [ActionExecResult](docs/ActionExecResult.md) - - [ActionExecResultEntry](docs/ActionExecResultEntry.md) - - [ActionParameterDefinition](docs/ActionParameterDefinition.md) - - [Activity](docs/Activity.md) - - [ActivityEntry](docs/ActivityEntry.md) - - [ActivityPaging](docs/ActivityPaging.md) - - [ActivityPagingList](docs/ActivityPagingList.md) - - [Association](docs/Association.md) - - [AssociationBody](docs/AssociationBody.md) - - [AssociationEntry](docs/AssociationEntry.md) - - [AssociationInfo](docs/AssociationInfo.md) - - [AuditApp](docs/AuditApp.md) - - [AuditAppEntry](docs/AuditAppEntry.md) - - [AuditAppPaging](docs/AuditAppPaging.md) - - [AuditAppPagingList](docs/AuditAppPagingList.md) - - [AuditBodyUpdate](docs/AuditBodyUpdate.md) - - [AuditEntry](docs/AuditEntry.md) - - [AuditEntryEntry](docs/AuditEntryEntry.md) - - [AuditEntryPaging](docs/AuditEntryPaging.md) - - [AuditEntryPagingList](docs/AuditEntryPagingList.md) - - [Capabilities](docs/Capabilities.md) - - [ChildAssociation](docs/ChildAssociation.md) - - [ChildAssociationBody](docs/ChildAssociationBody.md) - - [ChildAssociationEntry](docs/ChildAssociationEntry.md) - - [ChildAssociationInfo](docs/ChildAssociationInfo.md) - - [ClientBody](docs/ClientBody.md) - - [Comment](docs/Comment.md) - - [CommentBody](docs/CommentBody.md) - - [CommentEntry](docs/CommentEntry.md) - - [CommentPaging](docs/CommentPaging.md) - - [CommentPagingList](docs/CommentPagingList.md) - - [Company](docs/Company.md) - - [ContentInfo](docs/ContentInfo.md) - - [DeletedNodeBodyRestore](docs/DeletedNodeBodyRestore.md) - - [DeletedNodeEntry](docs/DeletedNodeEntry.md) - - [DeletedNodesPaging](docs/DeletedNodesPaging.md) - - [DeletedNodesPagingList](docs/DeletedNodesPagingList.md) - - [Download](docs/Download.md) - - [DownloadBodyCreate](docs/DownloadBodyCreate.md) - - [DownloadEntry](docs/DownloadEntry.md) - - [ErrorError](docs/ErrorError.md) - - [Favorite](docs/Favorite.md) - - [FavoriteBodyCreate](docs/FavoriteBodyCreate.md) - - [FavoriteEntry](docs/FavoriteEntry.md) - - [FavoritePaging](docs/FavoritePaging.md) - - [FavoritePagingList](docs/FavoritePagingList.md) - - [FavoriteSite](docs/FavoriteSite.md) - - [FavoriteSiteBodyCreate](docs/FavoriteSiteBodyCreate.md) - - [FavoriteSiteEntry](docs/FavoriteSiteEntry.md) - - [Group](docs/Group.md) - - [GroupBodyCreate](docs/GroupBodyCreate.md) - - [GroupBodyUpdate](docs/GroupBodyUpdate.md) - - [GroupEntry](docs/GroupEntry.md) - - [GroupMember](docs/GroupMember.md) - - [GroupMemberEntry](docs/GroupMemberEntry.md) - - [GroupMemberPaging](docs/GroupMemberPaging.md) - - [GroupMemberPagingList](docs/GroupMemberPagingList.md) - - [GroupMembershipBodyCreate](docs/GroupMembershipBodyCreate.md) - - [GroupPaging](docs/GroupPaging.md) - - [GroupPagingList](docs/GroupPagingList.md) - - [ModelError](docs/ModelError.md) - - [NetworkQuota](docs/NetworkQuota.md) - - [Node](docs/Node.md) - - [NodeAssociationEntry](docs/NodeAssociationEntry.md) - - [NodeAssociationPaging](docs/NodeAssociationPaging.md) - - [NodeAssociationPagingList](docs/NodeAssociationPagingList.md) - - [NodeBodyCopy](docs/NodeBodyCopy.md) - - [NodeBodyCreate](docs/NodeBodyCreate.md) - - [NodeBodyCreateAssociation](docs/NodeBodyCreateAssociation.md) - - [NodeBodyLock](docs/NodeBodyLock.md) - - [NodeBodyMove](docs/NodeBodyMove.md) - - [NodeBodyUpdate](docs/NodeBodyUpdate.md) - - [NodeChildAssociationEntry](docs/NodeChildAssociationEntry.md) - - [NodeChildAssociationPaging](docs/NodeChildAssociationPaging.md) - - [NodeChildAssociationPagingList](docs/NodeChildAssociationPagingList.md) - - [NodeEntry](docs/NodeEntry.md) - - [NodePaging](docs/NodePaging.md) - - [NodePagingList](docs/NodePagingList.md) - - [Pagination](docs/Pagination.md) - - [PasswordResetBody](docs/PasswordResetBody.md) - - [PathElement](docs/PathElement.md) - - [PathInfo](docs/PathInfo.md) - - [PermissionElement](docs/PermissionElement.md) - - [PermissionsBodyUpdate](docs/PermissionsBodyUpdate.md) - - [PermissionsInfo](docs/PermissionsInfo.md) - - [Person](docs/Person.md) - - [PersonBodyCreate](docs/PersonBodyCreate.md) - - [PersonBodyUpdate](docs/PersonBodyUpdate.md) - - [PersonEntry](docs/PersonEntry.md) - - [PersonNetwork](docs/PersonNetwork.md) - - [PersonNetworkEntry](docs/PersonNetworkEntry.md) - - [PersonNetworkPaging](docs/PersonNetworkPaging.md) - - [PersonNetworkPagingList](docs/PersonNetworkPagingList.md) - - [PersonPaging](docs/PersonPaging.md) - - [PersonPagingList](docs/PersonPagingList.md) - - [Preference](docs/Preference.md) - - [PreferenceEntry](docs/PreferenceEntry.md) - - [PreferencePaging](docs/PreferencePaging.md) - - [PreferencePagingList](docs/PreferencePagingList.md) - - [ProbeEntry](docs/ProbeEntry.md) - - [ProbeEntryEntry](docs/ProbeEntryEntry.md) - - [Rating](docs/Rating.md) - - [RatingAggregate](docs/RatingAggregate.md) - - [RatingBody](docs/RatingBody.md) - - [RatingEntry](docs/RatingEntry.md) - - [RatingPaging](docs/RatingPaging.md) - - [RatingPagingList](docs/RatingPagingList.md) - - [Rendition](docs/Rendition.md) - - [RenditionBodyCreate](docs/RenditionBodyCreate.md) - - [RenditionEntry](docs/RenditionEntry.md) - - [RenditionPaging](docs/RenditionPaging.md) - - [RenditionPagingList](docs/RenditionPagingList.md) - - [RevertBody](docs/RevertBody.md) - - [SharedLink](docs/SharedLink.md) - - [SharedLinkBodyCreate](docs/SharedLinkBodyCreate.md) - - [SharedLinkBodyEmail](docs/SharedLinkBodyEmail.md) - - [SharedLinkEntry](docs/SharedLinkEntry.md) - - [SharedLinkPaging](docs/SharedLinkPaging.md) - - [SharedLinkPagingList](docs/SharedLinkPagingList.md) - - [Site](docs/Site.md) - - [SiteBodyCreate](docs/SiteBodyCreate.md) - - [SiteBodyUpdate](docs/SiteBodyUpdate.md) - - [SiteContainer](docs/SiteContainer.md) - - [SiteContainerEntry](docs/SiteContainerEntry.md) - - [SiteContainerPaging](docs/SiteContainerPaging.md) - - [SiteContainerPagingList](docs/SiteContainerPagingList.md) - - [SiteEntry](docs/SiteEntry.md) - - [SiteMember](docs/SiteMember.md) - - [SiteMemberEntry](docs/SiteMemberEntry.md) - - [SiteMemberPaging](docs/SiteMemberPaging.md) - - [SiteMemberPagingList](docs/SiteMemberPagingList.md) - - [SiteMembershipApprovalBody](docs/SiteMembershipApprovalBody.md) - - [SiteMembershipBodyCreate](docs/SiteMembershipBodyCreate.md) - - [SiteMembershipBodyUpdate](docs/SiteMembershipBodyUpdate.md) - - [SiteMembershipRejectionBody](docs/SiteMembershipRejectionBody.md) - - [SiteMembershipRequest](docs/SiteMembershipRequest.md) - - [SiteMembershipRequestBodyCreate](docs/SiteMembershipRequestBodyCreate.md) - - [SiteMembershipRequestBodyUpdate](docs/SiteMembershipRequestBodyUpdate.md) - - [SiteMembershipRequestEntry](docs/SiteMembershipRequestEntry.md) - - [SiteMembershipRequestPaging](docs/SiteMembershipRequestPaging.md) - - [SiteMembershipRequestPagingList](docs/SiteMembershipRequestPagingList.md) - - [SiteMembershipRequestWithPerson](docs/SiteMembershipRequestWithPerson.md) - - [SiteMembershipRequestWithPersonEntry](docs/SiteMembershipRequestWithPersonEntry.md) - - [SiteMembershipRequestWithPersonPaging](docs/SiteMembershipRequestWithPersonPaging.md) - - [SiteMembershipRequestWithPersonPagingList](docs/SiteMembershipRequestWithPersonPagingList.md) - - [SitePaging](docs/SitePaging.md) - - [SitePagingList](docs/SitePagingList.md) - - [SiteRole](docs/SiteRole.md) - - [SiteRoleEntry](docs/SiteRoleEntry.md) - - [SiteRolePaging](docs/SiteRolePaging.md) - - [SiteRolePagingList](docs/SiteRolePagingList.md) - - [Tag](docs/Tag.md) - - [TagBody](docs/TagBody.md) - - [TagEntry](docs/TagEntry.md) - - [TagPaging](docs/TagPaging.md) - - [TagPagingList](docs/TagPagingList.md) - - [UserInfo](docs/UserInfo.md) - - [Version](docs/Version.md) - - [VersionEntry](docs/VersionEntry.md) - - [VersionPaging](docs/VersionPaging.md) - - [VersionPagingList](docs/VersionPagingList.md) - - [DeletedNode](docs/DeletedNode.md) - - [NodeAssociation](docs/NodeAssociation.md) - - [NodeChildAssociation](docs/NodeChildAssociation.md) +## Models +- [ActionBodyExec](docs/ActionBodyExec.md) +- [ActionDefinition](docs/ActionDefinition.md) +- [ActionDefinitionEntry](docs/ActionDefinitionEntry.md) +- [ActionDefinitionList](docs/ActionDefinitionList.md) +- [ActionDefinitionListList](docs/ActionDefinitionListList.md) +- [ActionExecResult](docs/ActionExecResult.md) +- [ActionExecResultEntry](docs/ActionExecResultEntry.md) +- [ActionParameterDefinition](docs/ActionParameterDefinition.md) +- [Activity](docs/Activity.md) +- [ActivityEntry](docs/ActivityEntry.md) +- [ActivityPaging](docs/ActivityPaging.md) +- [ActivityPagingList](docs/ActivityPagingList.md) +- [Association](docs/Association.md) +- [AssociationBody](docs/AssociationBody.md) +- [AssociationEntry](docs/AssociationEntry.md) +- [AssociationInfo](docs/AssociationInfo.md) +- [AuditApp](docs/AuditApp.md) +- [AuditAppEntry](docs/AuditAppEntry.md) +- [AuditAppPaging](docs/AuditAppPaging.md) +- [AuditAppPagingList](docs/AuditAppPagingList.md) +- [AuditBodyUpdate](docs/AuditBodyUpdate.md) +- [AuditEntry](docs/AuditEntry.md) +- [AuditEntryEntry](docs/AuditEntryEntry.md) +- [AuditEntryPaging](docs/AuditEntryPaging.md) +- [AuditEntryPagingList](docs/AuditEntryPagingList.md) +- [Capabilities](docs/Capabilities.md) +- [ChildAssociation](docs/ChildAssociation.md) +- [ChildAssociationBody](docs/ChildAssociationBody.md) +- [ChildAssociationEntry](docs/ChildAssociationEntry.md) +- [ChildAssociationInfo](docs/ChildAssociationInfo.md) +- [ClientBody](docs/ClientBody.md) +- [Comment](docs/Comment.md) +- [CommentBody](docs/CommentBody.md) +- [CommentEntry](docs/CommentEntry.md) +- [CommentPaging](docs/CommentPaging.md) +- [CommentPagingList](docs/CommentPagingList.md) +- [Company](docs/Company.md) +- [ContentInfo](docs/ContentInfo.md) +- [DeletedNodeBodyRestore](docs/DeletedNodeBodyRestore.md) +- [DeletedNodeEntry](docs/DeletedNodeEntry.md) +- [DeletedNodesPaging](docs/DeletedNodesPaging.md) +- [DeletedNodesPagingList](docs/DeletedNodesPagingList.md) +- [Download](docs/Download.md) +- [DownloadBodyCreate](docs/DownloadBodyCreate.md) +- [DownloadEntry](docs/DownloadEntry.md) +- [ErrorError](docs/ErrorError.md) +- [Favorite](docs/Favorite.md) +- [FavoriteBodyCreate](docs/FavoriteBodyCreate.md) +- [FavoriteEntry](docs/FavoriteEntry.md) +- [FavoritePaging](docs/FavoritePaging.md) +- [FavoritePagingList](docs/FavoritePagingList.md) +- [FavoriteSite](docs/FavoriteSite.md) +- [FavoriteSiteBodyCreate](docs/FavoriteSiteBodyCreate.md) +- [FavoriteSiteEntry](docs/FavoriteSiteEntry.md) +- [Group](docs/Group.md) +- [GroupBodyCreate](docs/GroupBodyCreate.md) +- [GroupBodyUpdate](docs/GroupBodyUpdate.md) +- [GroupEntry](docs/GroupEntry.md) +- [GroupMember](docs/GroupMember.md) +- [GroupMemberEntry](docs/GroupMemberEntry.md) +- [GroupMemberPaging](docs/GroupMemberPaging.md) +- [GroupMemberPagingList](docs/GroupMemberPagingList.md) +- [GroupMembershipBodyCreate](docs/GroupMembershipBodyCreate.md) +- [GroupPaging](docs/GroupPaging.md) +- [GroupPagingList](docs/GroupPagingList.md) +- [ModelError](docs/ModelError.md) +- [NetworkQuota](docs/NetworkQuota.md) +- [Node](docs/Node.md) +- [NodeAssociationEntry](docs/NodeAssociationEntry.md) +- [NodeAssociationPaging](docs/NodeAssociationPaging.md) +- [NodeAssociationPagingList](docs/NodeAssociationPagingList.md) +- [NodeBodyCopy](docs/NodeBodyCopy.md) +- [NodeBodyCreate](docs/NodeBodyCreate.md) +- [NodeBodyCreateAssociation](docs/NodeBodyCreateAssociation.md) +- [NodeBodyLock](docs/NodeBodyLock.md) +- [NodeBodyMove](docs/NodeBodyMove.md) +- [NodeBodyUpdate](docs/NodeBodyUpdate.md) +- [NodeChildAssociationEntry](docs/NodeChildAssociationEntry.md) +- [NodeChildAssociationPaging](docs/NodeChildAssociationPaging.md) +- [NodeChildAssociationPagingList](docs/NodeChildAssociationPagingList.md) +- [NodeEntry](docs/NodeEntry.md) +- [NodePaging](docs/NodePaging.md) +- [NodePagingList](docs/NodePagingList.md) +- [Pagination](docs/Pagination.md) +- [PasswordResetBody](docs/PasswordResetBody.md) +- [PathElement](docs/PathElement.md) +- [PathInfo](docs/PathInfo.md) +- [PermissionElement](docs/PermissionElement.md) +- [PermissionsBodyUpdate](docs/PermissionsBodyUpdate.md) +- [PermissionsInfo](docs/PermissionsInfo.md) +- [Person](docs/Person.md) +- [PersonBodyCreate](docs/PersonBodyCreate.md) +- [PersonBodyUpdate](docs/PersonBodyUpdate.md) +- [PersonEntry](docs/PersonEntry.md) +- [PersonNetwork](docs/PersonNetwork.md) +- [PersonNetworkEntry](docs/PersonNetworkEntry.md) +- [PersonNetworkPaging](docs/PersonNetworkPaging.md) +- [PersonNetworkPagingList](docs/PersonNetworkPagingList.md) +- [PersonPaging](docs/PersonPaging.md) +- [PersonPagingList](docs/PersonPagingList.md) +- [Preference](docs/Preference.md) +- [PreferenceEntry](docs/PreferenceEntry.md) +- [PreferencePaging](docs/PreferencePaging.md) +- [PreferencePagingList](docs/PreferencePagingList.md) +- [ProbeEntry](docs/ProbeEntry.md) +- [ProbeEntryEntry](docs/ProbeEntryEntry.md) +- [Rating](docs/Rating.md) +- [RatingAggregate](docs/RatingAggregate.md) +- [RatingBody](docs/RatingBody.md) +- [RatingEntry](docs/RatingEntry.md) +- [RatingPaging](docs/RatingPaging.md) +- [RatingPagingList](docs/RatingPagingList.md) +- [Rendition](docs/Rendition.md) +- [RenditionBodyCreate](docs/RenditionBodyCreate.md) +- [RenditionEntry](docs/RenditionEntry.md) +- [RenditionPaging](docs/RenditionPaging.md) +- [RenditionPagingList](docs/RenditionPagingList.md) +- [RevertBody](docs/RevertBody.md) +- [SharedLink](docs/SharedLink.md) +- [SharedLinkBodyCreate](docs/SharedLinkBodyCreate.md) +- [SharedLinkBodyEmail](docs/SharedLinkBodyEmail.md) +- [SharedLinkEntry](docs/SharedLinkEntry.md) +- [SharedLinkPaging](docs/SharedLinkPaging.md) +- [SharedLinkPagingList](docs/SharedLinkPagingList.md) +- [Site](docs/Site.md) +- [SiteBodyCreate](docs/SiteBodyCreate.md) +- [SiteBodyUpdate](docs/SiteBodyUpdate.md) +- [SiteContainer](docs/SiteContainer.md) +- [SiteContainerEntry](docs/SiteContainerEntry.md) +- [SiteContainerPaging](docs/SiteContainerPaging.md) +- [SiteContainerPagingList](docs/SiteContainerPagingList.md) +- [SiteEntry](docs/SiteEntry.md) +- [SiteMember](docs/SiteMember.md) +- [SiteMemberEntry](docs/SiteMemberEntry.md) +- [SiteMemberPaging](docs/SiteMemberPaging.md) +- [SiteMemberPagingList](docs/SiteMemberPagingList.md) +- [SiteMembershipApprovalBody](docs/SiteMembershipApprovalBody.md) +- [SiteMembershipBodyCreate](docs/SiteMembershipBodyCreate.md) +- [SiteMembershipBodyUpdate](docs/SiteMembershipBodyUpdate.md) +- [SiteMembershipRejectionBody](docs/SiteMembershipRejectionBody.md) +- [SiteMembershipRequest](docs/SiteMembershipRequest.md) +- [SiteMembershipRequestBodyCreate](docs/SiteMembershipRequestBodyCreate.md) +- [SiteMembershipRequestBodyUpdate](docs/SiteMembershipRequestBodyUpdate.md) +- [SiteMembershipRequestEntry](docs/SiteMembershipRequestEntry.md) +- [SiteMembershipRequestPaging](docs/SiteMembershipRequestPaging.md) +- [SiteMembershipRequestPagingList](docs/SiteMembershipRequestPagingList.md) +- [SiteMembershipRequestWithPerson](docs/SiteMembershipRequestWithPerson.md) +- [SiteMembershipRequestWithPersonEntry](docs/SiteMembershipRequestWithPersonEntry.md) +- [SiteMembershipRequestWithPersonPaging](docs/SiteMembershipRequestWithPersonPaging.md) +- [SiteMembershipRequestWithPersonPagingList](docs/SiteMembershipRequestWithPersonPagingList.md) +- [SitePaging](docs/SitePaging.md) +- [SitePagingList](docs/SitePagingList.md) +- [SiteRole](docs/SiteRole.md) +- [SiteRoleEntry](docs/SiteRoleEntry.md) +- [SiteRolePaging](docs/SiteRolePaging.md) +- [SiteRolePagingList](docs/SiteRolePagingList.md) +- [Tag](docs/Tag.md) +- [TagBody](docs/TagBody.md) +- [TagEntry](docs/TagEntry.md) +- [TagPaging](docs/TagPaging.md) +- [TagPagingList](docs/TagPagingList.md) +- [UserInfo](docs/UserInfo.md) +- [Version](docs/Version.md) +- [VersionEntry](docs/VersionEntry.md) +- [VersionPaging](docs/VersionPaging.md) +- [VersionPagingList](docs/VersionPagingList.md) +- [DeletedNode](docs/DeletedNode.md) +- [NodeAssociation](docs/NodeAssociation.md) +- [NodeChildAssociation](docs/NodeChildAssociation.md) diff --git a/src/api/discovery-rest-api/README.md b/src/api/discovery-rest-api/README.md index 122d99f9fd..fbbef3ef8d 100644 --- a/src/api/discovery-rest-api/README.md +++ b/src/api/discovery-rest-api/README.md @@ -1,30 +1,30 @@ -**Discovery API** +# **Discovery API** Provides access to information about Alfresco Content Services. +> Documentation updated on: 2019-10-17T13:55:16.056+01:00 -- Last Build date: 2018-11-05T11:25:17.050Z +## Methods +All URIs are relative to: -## Documentation for API Endpoints - -All URIs are relative to *https://localhost/alfresco/api* +```text +https://localhost/alfresco/api +``` Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- -*.DiscoveryApi* | [**getRepositoryInformation**](docs/DiscoveryApi.md#getRepositoryInformation) | **GET** /discovery | Get repository information - - -## Documentation for Models - - - [DiscoveryEntry](docs/DiscoveryEntry.md) - - [EntitlementsInfo](docs/EntitlementsInfo.md) - - [ErrorError](docs/ErrorError.md) - - [LicenseInfo](docs/LicenseInfo.md) - - [ModelError](docs/ModelError.md) - - [ModuleInfo](docs/ModuleInfo.md) - - [RepositoryEntry](docs/RepositoryEntry.md) - - [RepositoryInfo](docs/RepositoryInfo.md) - - [StatusInfo](docs/StatusInfo.md) - - [VersionInfo](docs/VersionInfo.md) - +DiscoveryApi | [**getRepositoryInformation**](docs/DiscoveryApi.md#getRepositoryInformation) | **GET** /discovery | Get repository information + +## Models + +- [DiscoveryEntry](docs/DiscoveryEntry.md) +- [EntitlementsInfo](docs/EntitlementsInfo.md) +- [ErrorError](docs/ErrorError.md) +- [LicenseInfo](docs/LicenseInfo.md) +- [ModelError](docs/ModelError.md) +- [ModuleInfo](docs/ModuleInfo.md) +- [RepositoryEntry](docs/RepositoryEntry.md) +- [RepositoryInfo](docs/RepositoryInfo.md) +- [StatusInfo](docs/StatusInfo.md) +- [VersionInfo](docs/VersionInfo.md) diff --git a/src/api/discovery-rest-api/docs/DiscoveryApi.md b/src/api/discovery-rest-api/docs/DiscoveryApi.md index ce2fb06cd9..d78313fd8f 100644 --- a/src/api/discovery-rest-api/docs/DiscoveryApi.md +++ b/src/api/discovery-rest-api/docs/DiscoveryApi.md @@ -8,7 +8,7 @@ Method | HTTP request | Description -# **getRepositoryInformation** +## getRepositoryInformation > DiscoveryEntry getRepositoryInformation() Get repository information @@ -19,23 +19,21 @@ Retrieves the capabilities and detailed version information from the repository. ### Example + ```javascript -import DiscoveryApi from 'DiscoveryApi'; -import { AlfrescoApi } from '@alfresco/js-api'; +import { AlfrescoApi, DiscoveryApi} from '@alfresco/js-api'; -this.alfrescoApi = new AlfrescoApi(); -this.alfrescoApi.setConfig({ +const alfrescoApi = new AlfrescoApi({ hostEcm: 'http://127.0.0.1:8080' }); -let discoveryApi = new DiscoveryApi(this.alfrescoApi); +const discoveryApi = new DiscoveryApi(alfrescoApi); discoveryApi.getRepositoryInformation().then((data) => { console.log('API called successfully. Returned data: ' + data); }, function(error) { console.error(error); }); - ``` ### Parameters