Add Role based External Documents

[timyates]

This is the backend and simple readonly front-end required for #1656

the front end was done in #2522 and merged in to here

Schema

erDiagram
    DOCUMENT {
        UUID document_id PK
        string name "unique"
        string URL "unique"
        string description "optional"
    }
   ROLE_DOCUMENT {
       UUID role_id PK
       UUID document_id PK
       int display_order "the order for documents assigned to a role"
   }

Loading

DTO format

DocumentCreateDTO

{
  "name": "string",
  "url": "string",
  "description": "string"
}

Note

name and url must be unique across all documents, and description is optional

DocumentResponseDTO

  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "url": "string",
    "description": "string"
  }

Note

description may be null

Endpoints

GET /services/document -- List all documents.

• Auth None
• Returns list of DocumentResponseDTO ordered by name

GET /services/document/{role_id} -- List documents assigned to a role

• Auth None
• Returns list of DocumentResponseDTO assigned to the given role_id, ordered by the display_order in the database

POST /services/document -- Create a document

• Permission CAN_ADMINISTER_DOCUMENTATION required
• Expects a DocumentCreateDTO as the body
• Name and URL must be unique
• Responds with the created document

PUT /services/document/{documentId} -- Update a document

• Permission CAN_ADMINISTER_DOCUMENTATION required
• Expects a DocumentCreateDTO as the body
• Name and URL must be unique
• Responds with the updated document

DELETE /services/document/{documentId} -- Delete a document

• Permission CAN_ADMINISTER_DOCUMENTATION required
• Document must be first removed from all Role associations

POST /services/document/{role_id} -- Set the list of documents for a role

• Permission CAN_ADMINISTER_DOCUMENTATION required
• Expects a list of UUID strings as the body (these are document ids)
• This may be an empty list to clear the documents
• The order of the documents in the list will be their display order.
• Duplicate document ids are ignored
• Returns list of DocumentResponseDTO assigned to the given role_id, ordered by the display_order in the database

[vhscom]

Fantastic!