Add Django REST Framework API with token management interface #16

arGth56 · 2025-06-30T20:00:26Z

This commit implements a complete REST API for the STDWeb project with secure token management:

Features:

Django REST Framework integration with token authentication
API endpoints for FITS image upload with processing options
Task listing and detail retrieval endpoints
Preset configuration endpoints
Web-based API token management interface
Automatic token generation and secure regeneration
Comprehensive API documentation

API Endpoints:

POST /api/auth/token/ - Get authentication token
POST /api/tasks/upload/ - Upload FITS images
GET /api/tasks/ - List user tasks
GET /api/tasks/{id}/ - Get task details
GET /api/presets/ - List available presets

Web Interface:

/api-tokens/ - Token management page in user menu
Copy-to-clipboard functionality
Usage examples with actual user tokens
Safe token regeneration with confirmations
Integrated API documentation access

Security:

Token-based authentication
User isolation (users only see their own tasks)
CSRF protection on token operations
File validation (FITS files, 100MB limit)
Proper error handling and HTTP status codes

Files Added:

stdweb/serializers.py - DRF serializers
stdweb/views_api.py - API view implementations
stdweb/urls_api.py - API URL routing
stdweb/views_user.py - Token management views
stdweb/templates/api_tokens.html - Token management UI
stdweb/management/commands/create_api_token.py - Token CLI tool
API_USAGE.md - Complete API documentation

Files Modified:

requirements.txt - Added djangorestframework
stdweb/settings.py - DRF configuration
stdweb/urls.py - Added API and user routes
stdweb/templates/template.html - Added API Tokens menu item

This commit implements a complete REST API for the STDWeb project with secure token management: Features: - Django REST Framework integration with token authentication - API endpoints for FITS image upload with processing options - Task listing and detail retrieval endpoints - Preset configuration endpoints - Web-based API token management interface - Automatic token generation and secure regeneration - Comprehensive API documentation API Endpoints: - POST /api/auth/token/ - Get authentication token - POST /api/tasks/upload/ - Upload FITS images - GET /api/tasks/ - List user tasks - GET /api/tasks/{id}/ - Get task details - GET /api/presets/ - List available presets Web Interface: - /api-tokens/ - Token management page in user menu - Copy-to-clipboard functionality - Usage examples with actual user tokens - Safe token regeneration with confirmations - Integrated API documentation access Security: - Token-based authentication - User isolation (users only see their own tasks) - CSRF protection on token operations - File validation (FITS files, 100MB limit) - Proper error handling and HTTP status codes Files Added: - stdweb/serializers.py - DRF serializers - stdweb/views_api.py - API view implementations - stdweb/urls_api.py - API URL routing - stdweb/views_user.py - Token management views - stdweb/templates/api_tokens.html - Token management UI - stdweb/management/commands/create_api_token.py - Token CLI tool - API_USAGE.md - Complete API documentation Files Modified: - requirements.txt - Added djangorestframework - stdweb/settings.py - DRF configuration - stdweb/urls.py - Added API and user routes - stdweb/templates/template.html - Added API Tokens menu item

…tometry: handle None detection limit; Celery: sanitize config values (convert NaN/Inf, numpy scalars) before JSON save

…otometry and transient detection

…and consulting task status

…plate subtraction)

…tometry -> subtraction with env vars

….py with venv and env vars

…0..1

…pagates to inspection step

…led gain

…tion templates

…template subtraction and update documentation

…or empty

karpov-sv · 2025-09-09T13:20:26Z

Hi Pierre-Yves, I am extremely sorry for a long delay in reviewing your PR. I tend to accept it, but could you please first make small changes to the code? I will comment on specific places in the code below.

karpov-sv · 2025-09-09T13:24:01Z

stdweb/migrations/0011_alter_preset_config_alter_preset_files.py

I believe I already committed the migration that covers these things (it is for adding field descriptions, so nothing really important anyway)

karpov-sv · 2025-09-09T13:28:09Z

stdweb/processing.py

+                ra_cen, dec_cen, sr_cen = astrometry.get_frame_center(
+                    wcs=wcs, width=image.shape[1], height=image.shape[0]
+                )
+                config['field_ra'] = float(ra_cen)


Are you planning to use these fields on client side? I do not see them used in the code proper...
I am thinking about implementing it at the level of the model itself, not as part of config, so that it will be possible to search the tasks by positions... But if you are using it already - let's keep it like that for now

I added a bit more straightforward support for storing these values in config in d4fa84e. It does that on every run of photometry, to properly handle all possible cases (e.g. your current code actually does nothing if no blind match or refinement is performed i.e. if we rely on original astrometry from FITS header) and reduce code duplication.

karpov-sv · 2025-09-09T13:31:07Z

stdweb/processing.py

        cat_col_mag1=config.get('cat_col_color_mag1'),
        cat_col_mag2=config.get('cat_col_color_mag2'),
        use_color=config.get('use_color', True),
-        force_color_term=config.get('force_color_term'),


You probably need to rebase the PR against latest version of the code, so that newer changes are not removed by it

karpov-sv · 2025-09-09T13:33:28Z

stdweb/processing.py

                cat_col_mag1=config.get('cat_col_color_mag1'),
                cat_col_mag2=config.get('cat_col_color_mag2'),
-                use_color=True,
+                use_color=config.get('use_color', True),


Please revert this change - it is set to True intentionally here, as it is the code for "color term diagnostic" which computes and reports the value of color term for all possible filters, to see which one suits the image better. It does not impact the actual photometric calibration

karpov-sv · 2025-09-09T13:36:26Z

stdweb/processing.py

    mag0 = pipeline.get_detection_limit(obj, sn=config.get('sn'), verbose=False)
-    config['mag_limit'] = mag0
+    # Store result only if available
+    config['mag_limit'] = mag0 if mag0 is not None else np.nan


Do we really need to store it as np.nan and not as None as it was originally?

karpov-sv · 2025-09-09T13:37:50Z

stdweb/processing.py

                verbose=sub_verbose
            )

+            # Ensure flags are 32-bit ints to avoid OverflowError during bitmask operations


I fixed it in 77bba09 so that this change is not needed anymore.

karpov-sv · 2025-09-09T13:44:03Z

stdweb/serializers.py

ModelSerializer is supposed to automatically create the fields to match the model ones, so do we need to manually specify them? I'd prefer not to duplicate the code, as it will lead to some problems later when I add new fields (and of course will forget to synchronize it to other places like this one).

More general question - do I understand it correctly that these serializations are only needed to construct JSON representation for returning in task/preset lists? Or there are some other uses, for converting something back to actual model instances?

karpov-sv · 2025-09-09T13:45:09Z

stdweb/views_api.py

+from . import celery_tasks
+
+
+class TaskUploadAPIView(APIView):


Could you please convert it from class-based view to function-based one, to be in line with the rest of the code?

karpov-sv · 2025-09-09T13:47:03Z

stdweb/views_api.py

+        # --- NEW: update configuration if extra parameters are supplied ---
+        # Allow the same subset we accept on upload so that users can tweak
+        # parameters like gain/saturation before re-running an action.
+        extra_config_params = [


I do not really like imposing any restriction on the fields of config, it probably should allow setting any possible value here. Again, to ease future development.

karpov-sv · 2025-09-21T12:44:47Z

It seems my comments for the code somehow were invisible up till now?.. I am very sorry for that, sometimes GitHub features confuse me, sorry...

Debian and others added 23 commits June 30, 2025 15:36

fix photometry option

471e002

add time gain and saturation arguments

774eacf

cli: add --gain and --saturation shortcuts

23eb4bb

api: allow updating selected config keys in /tasks/<id>/action/

c1a80c4

processing: store field_ra / field_dec / field_sr after WCS refinement

05be5dd

api: add tasks/<id>/action endpoint to urls_api

7b8031d

fix int16 out of bound error

3f9382a

API: accept template_catalog alias, map to internal template key; Pho…

cca5299

…tometry: handle None detection limit; Celery: sanitize config values (convert NaN/Inf, numpy scalars) before JSON save

Docs: add Python requests example for uploading FITS with inspect, ph…

7e22436

…otometry and transient detection

Docs: add REST API quick-usage section with cURL examples for upload …

ff7fb8a

…and consulting task status

Docs: add full Python workflow example (inspection → photometry → tem…

f515d68

…plate subtraction)

Examples: add full_workflow.py script demonstrating inspection -> pho…

6fbe619

…tometry -> subtraction with env vars

Docs: add French quick-start section for using examples/full_workflow…

5258473

….py with venv and env vars

Docs: translate full_workflow quick-start section to English

30eecc4

Examples: optional gain support with autoscale for images normalised …

d825094

…0..1

Examples: include (scaled) gain parameter in initial upload so it pro…

a6ab2f7

…pagates to inspection step

Docs & example: document gain handling; script prints and uploads sca…

c4c9e56

…led gain

Docs: add pointer from Quick Usage to full_workflow step-by-step section

b5c91b9

Docs: clarify minimal Python snippet vs full_workflow example

f8ba623

API: add /api/tasks/<id>/upload_template/ endpoint for custom subtrac…

fe03678

…tion templates

Docs: document /upload_template endpoint and usage

24f5d6b

API: expose filter_vizier, filter_skybot, filter_prefilter flags for …

167c445

…template subtraction and update documentation

arGth56 force-pushed the feature/api-rest-framework branch 3 times, most recently from e6e984a to 167c445 Compare August 17, 2025 16:47

arGth56 added 3 commits August 17, 2025 18:49

Restore task_upload_template_api endpoint required by urls

21dc36f

Fix TaskUploadSerializer: restore template/template_catalog CharFields

7a912f8

inspect_image: skip external target resolution when target is 'None' …

a21b82e

…or empty

karpov-sv requested changes Sep 21, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Django REST Framework API with token management interface #16

Add Django REST Framework API with token management interface #16

Uh oh!

arGth56 commented Jun 30, 2025

Uh oh!

karpov-sv commented Sep 9, 2025

Uh oh!

karpov-sv Sep 9, 2025

Uh oh!

karpov-sv Sep 9, 2025

Uh oh!

karpov-sv Sep 21, 2025

Uh oh!

karpov-sv Sep 9, 2025

Uh oh!

karpov-sv Sep 9, 2025

Uh oh!

karpov-sv Sep 9, 2025

Uh oh!

karpov-sv Sep 9, 2025

Uh oh!

karpov-sv Sep 9, 2025

Uh oh!

karpov-sv Sep 9, 2025

Uh oh!

karpov-sv Sep 9, 2025

Uh oh!

karpov-sv commented Sep 21, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Add Django REST Framework API with token management interface #16

Are you sure you want to change the base?

Add Django REST Framework API with token management interface #16

Uh oh!

Conversation

arGth56 commented Jun 30, 2025

Uh oh!

karpov-sv commented Sep 9, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

karpov-sv commented Sep 21, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants