mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[PRODENG-211] integrate JS-API with monorepo (part 1) (#9081)
* integrate JS-API with monorepo * [ci:force] fix token issue [ci:force] migrate docs folder [ci:force] clean personal tokens * [ci:force] gha workflow support * [ci:force] npm publish target * fix js-api test linting * [ci:force] fix test linting, mocks, https scheme * [ci:force] fix https scheme * [ci:force] typescript mappings * [ci:force] update scripts * lint fixes * linting fixes * fix linting * [ci:force] linting fixes * linting fixes * [ci:force] remove js-api upstream and corresponding scripts * [ci:force] jsdoc fixes * fix jsdoc linting * [ci:force] jsdoc fixes * [ci:force] jsdoc fixes * jsdoc fixes * jsdoc fixes * jsdoc fixes * [ci:force] fix jsdoc * [ci:force] reduce code duplication * replace 'chai' expect with node.js assert * replace 'chai' expect with node.js assert * [ci:force] remove chai and chai-spies for js-api testing * [ci:force] cleanup and fix imports * [ci:force] fix linting * [ci:force] fix unit test * [ci:force] fix sonar linting findings * [ci:force] switch activiti api models to interfaces (-2.5% reduction of bundle) * [ci:force] switch activiti api models to interfaces * [ci:force] switch AGS api models to interfaces * [ci:force] switch AGS api models to interfaces * [ci:force] switch search api models to interfaces * [ci:force] switch content api models to interfaces where applicable
This commit is contained in:
141
lib/js-api/src/api/auth-rest-api/docs/AuthenticationApi.md
Normal file
141
lib/js-api/src/api/auth-rest-api/docs/AuthenticationApi.md
Normal file
@@ -0,0 +1,141 @@
|
||||
# AuthenticationApi
|
||||
|
||||
All URIs are relative to *https://localhost/alfresco/api/-default-/public/authentication/versions/1*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**createTicket**](AuthenticationApi.md#createTicket) | **POST** /tickets | Create ticket (login)
|
||||
[**deleteTicket**](AuthenticationApi.md#deleteTicket) | **DELETE** /tickets/-me- | Delete ticket (logout)
|
||||
[**validateTicket**](AuthenticationApi.md#validateTicket) | **GET** /tickets/-me- | Validate ticket
|
||||
|
||||
|
||||
<a name="createTicket"></a>
|
||||
## createTicket
|
||||
> TicketEntry createTicket(ticketBodyCreate)
|
||||
|
||||
Create ticket (login)
|
||||
|
||||
**Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
||||
|
||||
Logs in and returns the new authentication ticket.
|
||||
|
||||
The userId and password properties are mandatory in the request body. For example:
|
||||
JSON
|
||||
{
|
||||
\"userId\": \"jbloggs\",
|
||||
\"password\": \"password\"
|
||||
}
|
||||
|
||||
To use the ticket in future requests you should pass it in the request header.
|
||||
For example using Javascript:
|
||||
Javascript
|
||||
request.setRequestHeader (\"Authorization\", \"Basic \" + btoa(ticket));
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```javascript
|
||||
import { AlfrescoApi, AuthenticationApi} from '@alfresco/js-api';
|
||||
|
||||
const alfrescoApi = new AlfrescoApi({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
const authenticationApi = new AuthenticationApi(alfrescoApi);
|
||||
|
||||
|
||||
authenticationApi.createTicket(ticketBodyCreate).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ticketBodyCreate** | [**TicketBody**](TicketBody.md)| The user credential. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**TicketEntry**](TicketEntry.md)
|
||||
|
||||
<a name="deleteTicket"></a>
|
||||
## deleteTicket
|
||||
> deleteTicket()
|
||||
|
||||
Delete ticket (logout)
|
||||
|
||||
**Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
||||
|
||||
Deletes logged in ticket (logout).
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```javascript
|
||||
import { AlfrescoApi, AuthenticationApi} from '@alfresco/js-api';
|
||||
|
||||
const alfrescoApi = new AlfrescoApi({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
const authenticationApi = new AuthenticationApi(alfrescoApi);
|
||||
|
||||
authenticationApi.deleteTicket().then(() => {
|
||||
console.log('API called successfully.');
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
null (empty response body)
|
||||
|
||||
<a name="validateTicket"></a>
|
||||
## validateTicket
|
||||
> ValidTicketEntry validateTicket()
|
||||
|
||||
Validate ticket
|
||||
|
||||
**Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
||||
|
||||
Validates the specified ticket (derived from Authorization header) is still valid.
|
||||
|
||||
For example, you can pass the Authorization request header using Javascript:
|
||||
Javascript
|
||||
request.setRequestHeader (\"Authorization\", \"Basic \" + btoa(ticket));
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```javascript
|
||||
import { AlfrescoApi, AuthenticationApi} from '@alfresco/js-api';
|
||||
|
||||
const alfrescoApi = new AlfrescoApi({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
const authenticationApi = new AuthenticationApi(alfrescoApi);
|
||||
|
||||
authenticationApi.validateTicket().then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**ValidTicketEntry**](ValidTicketEntry.md)
|
||||
|
8
lib/js-api/src/api/auth-rest-api/docs/Error.md
Normal file
8
lib/js-api/src/api/auth-rest-api/docs/Error.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# ModelError
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**error** | [**ErrorError**](ErrorError.md) | | [optional] [default to null]
|
||||
|
||||
|
13
lib/js-api/src/api/auth-rest-api/docs/Error_error.md
Normal file
13
lib/js-api/src/api/auth-rest-api/docs/Error_error.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# ErrorError
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**errorKey** | **string** | | [optional] [default to null]
|
||||
**statusCode** | **number** | | [default to null]
|
||||
**briefSummary** | **string** | | [default to null]
|
||||
**stackTrace** | **string** | | [default to null]
|
||||
**descriptionURL** | **string** | | [default to null]
|
||||
**logId** | **string** | | [optional] [default to null]
|
||||
|
||||
|
9
lib/js-api/src/api/auth-rest-api/docs/Ticket.md
Normal file
9
lib/js-api/src/api/auth-rest-api/docs/Ticket.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# Ticket
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **string** | | [optional] [default to null]
|
||||
**userId** | **string** | | [optional] [default to null]
|
||||
|
||||
|
9
lib/js-api/src/api/auth-rest-api/docs/TicketBody.md
Normal file
9
lib/js-api/src/api/auth-rest-api/docs/TicketBody.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# TicketBody
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**userId** | **string** | | [optional] [default to null]
|
||||
**password** | **string** | | [optional] [default to null]
|
||||
|
||||
|
8
lib/js-api/src/api/auth-rest-api/docs/TicketEntry.md
Normal file
8
lib/js-api/src/api/auth-rest-api/docs/TicketEntry.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# TicketEntry
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**entry** | [**Ticket**](Ticket.md) | | [default to null]
|
||||
|
||||
|
8
lib/js-api/src/api/auth-rest-api/docs/ValidTicket.md
Normal file
8
lib/js-api/src/api/auth-rest-api/docs/ValidTicket.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# ValidTicket
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **string** | | [optional] [default to null]
|
||||
|
||||
|
@@ -0,0 +1,8 @@
|
||||
# ValidTicketEntry
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**entry** | [**ValidTicket**](ValidTicket.md) | | [default to null]
|
||||
|
||||
|
Reference in New Issue
Block a user