Skip to content

Latest commit

 

History

History
52 lines (46 loc) · 1.88 KB

HUB_API.md

File metadata and controls

52 lines (46 loc) · 1.88 KB
Raw

API URL Configuration

QGIS Resources Hub API Documentation

The urlpatterns list routes URLs to views. For more information please see: https://docs.djangoproject.com/en/3.2/topics/http/urls/

Endpoints

Resources

  • URL: /resources/
  • Method: GET
  • View: ResourceAPIList.as_view()
  • Name: resource-list
  • Description: Retrieves a list of all resources.

Resource by UUID

  • URL: /resource/<uuid:uuid>/
  • Method: GET
  • View: ResourceAPIDownload.as_view()
  • Name: resource-download
  • Description: Downloads a specific resource identified by UUID.

Create Resource

  • URL: /resource/create
  • Method: POST
  • View: ResourceCreateView.as_view()
  • Name: resource-create
  • Description: Creates a new resource.
  • Request example with cURL: 
    curl --location 'http://localhost:62202/api/v1/resource/create' \
--header 'Authorization: Bearer <my_token>' \
--form 'file=@"path/to/the/file.zip"' \
--form 'thumbnail_full=@"path/to/the/thumbnail.png"' \
--form 'name="My model"' \
--form 'description="Little description"' \
--form 'tags="notag"' \
--form 'resource_type="model"'

Resource Detail

  • URL: /resource/<str:resource_type>/<uuid:uuid>/
  • Methods: GET, PUT, DELETE
  • View: ResourceDetailView.as_view()
  • Name: resource-detail
  • Description: Handles the detailed display, update, and deletion of a specific resource based on its type and UUID.
  • Example: To access the details of a resource with type 'style' and UUID '123e4567-e89b-12d3-a456-426614174000': 
    GET /resource/style/123e4567-e89b-12d3-a456-426614174000/
  • Permissions: Ensure that the user has the necessary permissions (staff or creator) to view, update, or delete the resource details.