From a485d6694bd09b99338924a5daebe55070ecf22e Mon Sep 17 00:00:00 2001 From: Konstantinos Triantafyllou Date: Fri, 26 Nov 2021 12:41:28 +0100 Subject: [PATCH] Update 'Documentation' --- Documentation.md | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/Documentation.md b/Documentation.md index fb3d432..55254be 100644 --- a/Documentation.md +++ b/Documentation.md @@ -3,10 +3,10 @@ In OpenAIRE there are 4 types of Authorities: - * Special Authorities such as PORTAL_ADMINISTRATOR or CLAIMS_CULRATOR etc. - * Curator of entities with a specic type (e.g CURATOR_COMMUNITY, Curator of communities) - * Manager of an entity (e.g FUNDER_EC_MANAGER, Manager of Funder EC (European Commission) - * Member of an entity (e.g FUNDER_EC, Member of Funder EC) + * Special Authorities such as PORTAL\_ADMINISTRATOR or CLAIMS\_CULRATOR etc. + * Curator of entities with a specic type (e.g CURATOR\_COMMUNITY, Curator of communities) + * Manager of an entity (e.g FUNDER_EC\_MANAGER, Manager of Funder EC (European Commission) + * Member of an entity (e.g FUNDER\_EC, Member of Funder EC) #### Type @@ -24,35 +24,35 @@ This web service provides 4 controllers with methods to create, assign or revoke ### Admin Controller ("/admin") -Authority format: (TYPE)_(ID)_MANAGER, user must have Authority **(TYPE)_(ID)** in order to acquire this Authority. +Authority format: **(TYPE)\_(ID)\_MANAGER**, user must have Authority **(TYPE)\_(ID)** in order to acquire this Authority. | Method | Path | Path Variables | Params | Description | -------- | -------- | -------- |-------- | -------- | -| DELETE | /{type}/{id} | **type**: Type of Entity, **id**: ID of Entity | **email**: Email of user (optional) | Remove Authority (TYPE)_(ID)_MANAGER from user(s) with this email or logged in user, if email isn't provided. -| GET | /{type}/{id} | **type**: Type of Entity, **id**: ID of Entity |**email**: Set to false to hide email information, default: true, **name**: Set to false to hide name information, default: true | Retrieve information of users with Authority (TYPE)_(ID)_MANAGER. -| POST | /{type}/{id} | **type**: Type of Entity, **id**: ID of Entity | **email**: Email of user, **force**: if true and Authority (TYPE)_(ID) doesn't exist or user has not Authority (TYPE)_(ID), the Authority will be created and assigned to user, default: false | Assign Authority (TYPE)_(ID)_MANAGER to user(s) with this email or logged in user, if email isn't provided. +| DELETE | /{type}/{id} | **type**: Type of Entity, **id**: ID of Entity | **email**: Email of user (optional) | Remove Authority (TYPE)\_(ID)\_MANAGER from user(s) with this email or logged in user, if email isn't provided. +| GET | /{type}/{id} | **type**: Type of Entity, **id**: ID of Entity |**email**: Set to false to hide email information, default: true, **name**: Set to false to hide name information, default: true | Retrieve information of users with Authority (TYPE)\_(ID)\_MANAGER. +| POST | /{type}/{id} | **type**: Type of Entity, **id**: ID of Entity | **email**: Email of user, **force**: if true and Authority (TYPE)\_(ID) doesn't exist or user has not Authority (TYPE)\_(ID), the Authority will be created and assigned to user, default: false | Assign Authority (TYPE)\_(ID)\_MANAGER to user(s) with this email or logged in user, if email isn't provided. ### Curator Controller ("/curator") -Authority format: CURATOR_(TYPE) +Authority format: CURATOR\_(TYPE) | Method | Path | Path Variables | Params | Description | -------- | -------- | -------- |-------- | -------- | -| DELETE | /{type} | **type**: Type of Entity | **email**: Email of user (optional) | Remove Authority CURATOR_(TYPE) from user(s) with this email or logged in user, if email isn't provided. -| GET | /{type} | **type**: Type of Entity |**email**: Set to false to hide email information, default: true, **name**: Set to false to hide name information, default: true | Retrieve information of users with Authority CURATOR_(TYPE). -| POST | /{type} | **type**: Type of Entity | **email**: Email of user, **force**: if true and Authority CURATOR_(TYPE) doesn't exist, the Authority will be created, default: false | Assign Authority CURATOR_(TYPE) to user(s) with this email or logged in user, if email isn't provided. -| POST | /{type}/create | **type**: Type of Entity | **description**: Desciption of Authority CURATOR_(TYPE) (optional) | Create Authority CURATOR_(TYPE). +| DELETE | /{type} | **type**: Type of Entity | **email**: Email of user (optional) | Remove Authority CURATOR\_(TYPE) from user(s) with this email or logged in user, if email isn't provided. +| GET | /{type} | **type**: Type of Entity |**email**: Set to false to hide email information, default: true, **name**: Set to false to hide name information, default: true | Retrieve information of users with Authority CURATOR\_(TYPE). +| POST | /{type} | **type**: Type of Entity | **email**: Email of user, **force**: if true and Authority CURATOR\_(TYPE) doesn't exist, the Authority will be created, default: false | Assign Authority CURATOR\_(TYPE) to user(s) with this email or logged in user, if email isn't provided. +| POST | /{type}/create | **type**: Type of Entity | **description**: Desciption of Authority CURATOR\_(TYPE) (optional) | Create Authority CURATOR\_(TYPE). ### Member Controller ("/member") -Authority format: (TYPE)_(ID) +Authority format: (TYPE)\_(ID) | Method | Path | Path Variables | Params | Description | -------- | -------- | -------- |-------- | -------- | -| DELETE | /{type}/{id} | **type**: Type of Entity, **id**: ID of Entity | **email**: Email of user (optional) | Remove Authority (TYPE)_(ID) from user(s) with this email or logged in user, if email isn't provided. +| DELETE | /{type}/{id} | **type**: Type of Entity, **id**: ID of Entity | **email**: Email of user (optional) | Remove Authority (TYPE)\_(ID) from user(s) with this email or logged in user, if email isn't provided. | GET | /{type}/{id} | **type**: Type of Entity, **id**: ID of Entity |**email**: Set to false to hide email information, default: true, **name**: Set to false to hide name information, default: true | Retrieve information of users with Authority (TYPE)_(ID). -| POST | /{type}/{id} | **type**: Type of Entity, **id**: ID of Entity | **email**: Email of user, **force**: if true and Authority (TYPE)_(ID) doesn't exist, the Authority will be created, default: false | Assign Authority CURATOR_(TYPE) to user(s) with this email or logged in user, if email isn't provided. -| POST | /{type}/{id} /create | **type**: Type of Entity, **id**: ID of Entity | **description**: Desciption of Authority (TYPE)_(ID) (optional) | Create Authority (TYPE)_(ID), along with (TYPE)_(ID)_(MANAGER). +| POST | /{type}/{id} | **type**: Type of Entity, **id**: ID of Entity | **email**: Email of user, **force**: if true and Authority (TYPE)\_(ID) doesn't exist, the Authority will be created, default: false | Assign Authority CURATOR\_(TYPE) to user(s) with this email or logged in user, if email isn't provided. +| POST | /{type}/{id} /create | **type**: Type of Entity, **id**: ID of Entity | **description**: Desciption of Authority (TYPE)\_(ID) (optional) | Create Authority (TYPE)_(ID), along with (TYPE)\_(ID)\_(MANAGER). ### Super Admin Controller ("/super") @@ -60,4 +60,4 @@ Methods to create other roles, regardless the previous schema. | Method | Path | Path Variables | Params | Description | -------- | -------- | -------- |-------- | -------- | -| POST | /create | - | **name**: Name of Authority **description**: Desciption of Authority (optional) | Create Authority with this name e.g Test Authority will be TEST_AUTHORITY. \ No newline at end of file +| POST | /create | - | **name**: Name of Authority **description**: Desciption of Authority (optional) | Create Authority with this name e.g Test Authority will be TEST\_AUTHORITY. \ No newline at end of file