github.com/qri-io/qri@v0.10.1-0.20220104210721-c771715036cb/api/endpoints.go (about)

     1  package api
     2  
     3  import (
     4  	qhttp "github.com/qri-io/qri/lib/http"
     5  )
     6  
     7  const (
     8  	// base endpoints
     9  
    10  	// AEHome is the / endpoint
    11  	AEHome qhttp.APIEndpoint = "/"
    12  	// AEHealth is the service health check endpoint
    13  	AEHealth qhttp.APIEndpoint = "/health"
    14  	// AEIPFS is the IPFS endpoint
    15  	AEIPFS qhttp.APIEndpoint = "/qfs/ipfs/{path:.*}"
    16  	// AEWebUI serves the remote WebUI
    17  	AEWebUI qhttp.APIEndpoint = "/webui"
    18  
    19  	// dataset endpoints
    20  
    21  	// AEGetCSVFullRef is the route used to get a body as a csv, that can also handle a specific hash
    22  	AEGetCSVFullRef qhttp.APIEndpoint = "/ds/get/{username}/{name}/at/{fs}/{hash}/body.csv"
    23  	// AEGetCSVShortRef is the route used to get a body as a csv
    24  	AEGetCSVShortRef qhttp.APIEndpoint = "/ds/get/{username}/{name}/body.csv"
    25  	// AEUnpack unpacks a zip file and sends it back
    26  	AEUnpack qhttp.APIEndpoint = "/ds/unpack"
    27  	// AESaveByUpload is the route used to save a dataset using a multipart form file in the request
    28  	AESaveByUpload qhttp.APIEndpoint = "/ds/save/upload"
    29  )