# inveniosoftware/invenio-requests architecture

> Architecture diagram of the GitHub repository inveniosoftware/invenio-requests, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-03). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/inveniosoftware/invenio-requests
- Repository: https://github.com/inveniosoftware/invenio-requests

## Overview

Invenio-Requests provides configurable request workflows, including request state transitions, discussion events, file handling, and user moderation. The principal workflow is creating a request and executing actions that change its status; actions may also create log events. Requests and events are represented as records, with services, resolvers, and notification generators supporting the product. The README offers little feature detail, so some subsystems are included based on the source index; edges are limited to relationships shown there or in excerpts.

Main entry points: [`invenio_requests/services/requests/service.py`](https://github.com/inveniosoftware/invenio-requests/blob/master/invenio_requests/services/requests/service.py) (Request service), [`invenio_requests/services/events/service.py`](https://github.com/inveniosoftware/invenio-requests/blob/master/invenio_requests/services/events/service.py) (Event service), [`invenio_requests/services/user_moderation/service.py`](https://github.com/inveniosoftware/invenio-requests/blob/master/invenio_requests/services/user_moderation/service.py) (Moderation service), [`invenio_requests/tasks.py`](https://github.com/inveniosoftware/invenio-requests/blob/master/invenio_requests/tasks.py) (Scheduled tasks)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_api["API and services"]
  node_request_resource["Request resource<br/>[resource.py]"]
  node_request_service["Request service<br/>[service.py]"]
  node_event_resource["Event resource<br/>[resource.py]"]
  node_event_service["Event service<br/>[service.py]"]
  node_file_service["File service<br/>[service.py]"]
  node_moderation_service["Moderation service<br/>[service.py]"]
end

subgraph group_domain["Request domain"]
  node_request_record[("Request records<br/>[api.py]")]
  node_record_models[("Record models<br/>[models.py]")]
  node_computed_fields["Computed fields<br/>[computed.py]"]
  node_entity_fields["Entity references"]
  node_event_types["Event types<br/>[event_types.py]"]
  node_request_types["Request types<br/>[request_types.py]"]
end

subgraph group_features["Product features"]
  node_actions["Request actions<br/>[actions.py]"]
  node_moderation_custom["Moderation customization<br/>[user_moderation.py]"]
  node_notifications["Notifications<br/>[generators.py]"]
  node_tasks["Scheduled tasks<br/>[tasks.py]"]
end

subgraph group_support["Runtime support"]
  node_resolvers["Resolver registry<br/>[registry.py]"]
  node_permissions["Permissions<br/>[permissions.py]"]
  node_service_components["Service components<br/>[components.py]"]
  node_service_results["Service results<br/>[results.py]"]
  node_service_schemas["Service schemas<br/>[schemas.py]"]
  node_configuration["Configuration<br/>[config.py]"]
end

node_user(("API client"))

node_user -.->|"uses API"| node_request_resource
node_request_service -->|"creates records"| node_request_record
node_request_service -->|"creates events"| node_event_service
node_request_service -->|"executes actions"| node_actions
node_actions -->|"logs events"| node_event_service
node_event_service -->|"uses records"| node_request_record
node_entity_fields -->|"looks up"| node_resolvers
node_request_service -->|"uses registry"| node_resolvers
node_moderation_service -->|"creates requests"| node_request_service
node_moderation_service -->|"selects type"| node_moderation_custom
node_tasks -->|"expires requests"| node_request_service
node_tasks -->|"requests moderation"| node_moderation_service
node_notifications -->|"reads events"| node_event_service
node_request_service -->|"builds results"| node_service_results
node_event_service -->|"builds results"| node_service_results
node_configuration -->|"configures"| node_permissions
node_configuration -->|"configures"| node_service_components

click node_request_resource "https://github.com/inveniosoftware/invenio-requests/blob/master/invenio_requests/resources/requests/resource.py"
click node_request_service "https://github.com/inveniosoftware/invenio-requests/blob/master/invenio_requests/services/requests/service.py"
click node_event_resource "https://github.com/inveniosoftware/invenio-requests/blob/master/invenio_requests/resources/events/resource.py"
click node_event_service "https://github.com/inveniosoftware/invenio-requests/blob/master/invenio_requests/services/events/service.py"
click node_file_service "https://github.com/inveniosoftware/invenio-requests/blob/master/invenio_requests/services/files/service.py"
click node_moderation_service "https://github.com/inveniosoftware/invenio-requests/blob/master/invenio_requests/services/user_moderation/service.py"
click node_request_record "https://github.com/inveniosoftware/invenio-requests/blob/master/invenio_requests/records/api.py"
click node_record_models "https://github.com/inveniosoftware/invenio-requests/blob/master/invenio_requests/records/models.py"
click node_computed_fields "https://github.com/inveniosoftware/invenio-requests/blob/master/invenio_requests/records/systemfields/computed.py"
click node_entity_fields "https://github.com/inveniosoftware/invenio-requests/blob/master/invenio_requests/records/systemfields/entity_reference.py"
click node_event_types "https://github.com/inveniosoftware/invenio-requests/blob/master/invenio_requests/customizations/event_types.py"
click node_request_types "https://github.com/inveniosoftware/invenio-requests/blob/master/invenio_requests/customizations/request_types.py"
click node_actions "https://github.com/inveniosoftware/invenio-requests/blob/master/invenio_requests/customizations/actions.py"
click node_moderation_custom "https://github.com/inveniosoftware/invenio-requests/blob/master/invenio_requests/customizations/user_moderation/user_moderation.py"
click node_notifications "https://github.com/inveniosoftware/invenio-requests/blob/master/invenio_requests/notifications/generators.py"
click node_tasks "https://github.com/inveniosoftware/invenio-requests/blob/master/invenio_requests/tasks.py"
click node_resolvers "https://github.com/inveniosoftware/invenio-requests/blob/master/invenio_requests/resolvers/registry.py"
click node_permissions "https://github.com/inveniosoftware/invenio-requests/blob/master/invenio_requests/services/permissions.py"
click node_service_components "https://github.com/inveniosoftware/invenio-requests/blob/master/invenio_requests/services/requests/components.py"
click node_service_results "https://github.com/inveniosoftware/invenio-requests/blob/master/invenio_requests/services/results.py"
click node_service_schemas "https://github.com/inveniosoftware/invenio-requests/blob/master/invenio_requests/services/schemas.py"
click node_configuration "https://github.com/inveniosoftware/invenio-requests/blob/master/invenio_requests/config.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_request_resource,node_request_service,node_event_resource,node_event_service,node_file_service,node_moderation_service,node_user toneBlue
class node_request_record,node_record_models,node_computed_fields,node_entity_fields,node_event_types,node_request_types toneAmber
class node_actions,node_moderation_custom,node_notifications,node_tasks toneMint
class node_resolvers,node_permissions,node_service_components,node_service_results,node_service_schemas,node_configuration toneRose
```

## Components

### API and services

- [Request resource](https://github.com/inveniosoftware/invenio-requests/blob/master/invenio_requests/resources/requests/resource.py): `invenio_requests/resources/requests/resource.py`
- [Request service](https://github.com/inveniosoftware/invenio-requests/blob/master/invenio_requests/services/requests/service.py): `invenio_requests/services/requests/service.py`
- [Event resource](https://github.com/inveniosoftware/invenio-requests/blob/master/invenio_requests/resources/events/resource.py): `invenio_requests/resources/events/resource.py`
- [Event service](https://github.com/inveniosoftware/invenio-requests/blob/master/invenio_requests/services/events/service.py): `invenio_requests/services/events/service.py`
- [File service](https://github.com/inveniosoftware/invenio-requests/blob/master/invenio_requests/services/files/service.py): `invenio_requests/services/files/service.py`
- [Moderation service](https://github.com/inveniosoftware/invenio-requests/blob/master/invenio_requests/services/user_moderation/service.py): `invenio_requests/services/user_moderation/service.py`

### Request domain

- [Request records](https://github.com/inveniosoftware/invenio-requests/blob/master/invenio_requests/records/api.py): `invenio_requests/records/api.py`
- [Record models](https://github.com/inveniosoftware/invenio-requests/blob/master/invenio_requests/records/models.py): `invenio_requests/records/models.py`
- [Computed fields](https://github.com/inveniosoftware/invenio-requests/blob/master/invenio_requests/records/systemfields/computed.py): `invenio_requests/records/systemfields/computed.py`
- [Entity references](https://github.com/inveniosoftware/invenio-requests/blob/master/invenio_requests/records/systemfields/entity_reference.py): `invenio_requests/records/systemfields/entity_reference.py`
- [Event types](https://github.com/inveniosoftware/invenio-requests/blob/master/invenio_requests/customizations/event_types.py): `invenio_requests/customizations/event_types.py`
- [Request types](https://github.com/inveniosoftware/invenio-requests/blob/master/invenio_requests/customizations/request_types.py): `invenio_requests/customizations/request_types.py`

### Product features

- [Request actions](https://github.com/inveniosoftware/invenio-requests/blob/master/invenio_requests/customizations/actions.py): `invenio_requests/customizations/actions.py`
- [Moderation customization](https://github.com/inveniosoftware/invenio-requests/blob/master/invenio_requests/customizations/user_moderation/user_moderation.py): `invenio_requests/customizations/user_moderation/user_moderation.py`
- [Notifications](https://github.com/inveniosoftware/invenio-requests/blob/master/invenio_requests/notifications/generators.py): `invenio_requests/notifications/generators.py`
- [Scheduled tasks](https://github.com/inveniosoftware/invenio-requests/blob/master/invenio_requests/tasks.py): `invenio_requests/tasks.py`

### Runtime support

- [Resolver registry](https://github.com/inveniosoftware/invenio-requests/blob/master/invenio_requests/resolvers/registry.py): `invenio_requests/resolvers/registry.py`
- [Permissions](https://github.com/inveniosoftware/invenio-requests/blob/master/invenio_requests/services/permissions.py): `invenio_requests/services/permissions.py`
- [Service components](https://github.com/inveniosoftware/invenio-requests/blob/master/invenio_requests/services/requests/components.py): `invenio_requests/services/requests/components.py`
- [Service results](https://github.com/inveniosoftware/invenio-requests/blob/master/invenio_requests/services/results.py): `invenio_requests/services/results.py`
- [Service schemas](https://github.com/inveniosoftware/invenio-requests/blob/master/invenio_requests/services/schemas.py): `invenio_requests/services/schemas.py`
- [Configuration](https://github.com/inveniosoftware/invenio-requests/blob/master/invenio_requests/config.py): `invenio_requests/config.py`

### Other components

- **API client**

## Connections

- API client → Request resource: uses API
- Request service → Request records: creates records (evidence: `invenio_requests/services/requests/service.py`)
- Request service → Event service: creates events (evidence: `invenio_requests/services/requests/service.py`)
- Request service → Request actions: executes actions (evidence: `invenio_requests/services/requests/service.py`)
- Request actions → Event service: logs events (evidence: `invenio_requests/customizations/actions.py`)
- Event service → Request records: uses records (evidence: `invenio_requests/services/events/service.py`)
- Entity references → Resolver registry: looks up (evidence: `invenio_requests/records/systemfields/entity_reference.py`)
- Request service → Resolver registry: uses registry (evidence: `invenio_requests/services/requests/service.py`)
- Moderation service → Request service: creates requests (evidence: `invenio_requests/services/user_moderation/service.py`)
- Moderation service → Moderation customization: selects type (evidence: `invenio_requests/services/user_moderation/service.py`)
- Scheduled tasks → Request service: expires requests (evidence: `invenio_requests/tasks.py`)
- Scheduled tasks → Moderation service: requests moderation (evidence: `invenio_requests/tasks.py`)
- Notifications → Event service: reads events (evidence: `invenio_requests/notifications/generators.py`)
- Request service → Service results: builds results (evidence: `invenio_requests/services/requests/service.py`)
- Event service → Service results: builds results (evidence: `invenio_requests/services/events/service.py`)
- Configuration → Permissions: configures (evidence: `invenio_requests/config.py`)
- Configuration → Service components: configures (evidence: `invenio_requests/config.py`)
