Reference¶
API¶
To view the API’s documentation in development, run the server and open http://127.0.0.1:8000/api/schema/swagger-ui/ or http://127.0.0.1:8000/api/schema/redoc/.
The API is used by the Vue frontend (see the endpoints in frontend/src/config.js) and for managing datasets in Pelican backend (see PELICAN_FRONTEND_URL in the Data Registry).
Environment variables¶
See OCP’s approach to Django settings. New variables are:
- PELICAN_BACKEND_DATABASE_URL
The connection string for Pelican backend’s database
- LOG_LEVEL
The log level of the root logger
- CORS_ALLOWED_ORIGINS
The origins that are authorized to make cross-site HTTP requests
- SERVICE_ACCOUNT_JSON_FILE
The filename of the service account JSON file
- RABBIT_URL
The connection string for RabbitMQ
- RABBIT_EXCHANGE_NAME
The name of the RabbitMQ exchange. Follow the pattern
pelican_{service}_{environment}likepelican_data_registry_production- DEFAULT_BASE_TEMPLATE
The Google Docs ID for the base template
- DEFAULT_FIELD_TEMPLATE
The Google Docs ID for the field-level template
- DEFAULT_RESOURCE_TEMPLATE
The Google Docs ID for the resource-level template
- DEFAULT_DATASET_TEMPLATE
The Google Docs ID for the dataset-level template
- DEFAULT_ERROR_TEMPLATE
The Google Docs ID for the error template