sal/rfs-client/openapi/docs/FlistManagementApi.md

\FlistManagementApi

All URIs are relative to http://localhost

Method	HTTP request	Description
create_flist_handler	POST /api/v1/fl
get_flist_state_handler	GET /api/v1/fl/{job_id}
list_flists_handler	GET /api/v1/fl
preview_flist_handler	GET /api/v1/fl/preview/{flist_path}
serve_flists	GET /{path}	Serve flist files from the server's filesystem

create_flist_handler

models::Job create_flist_handler(flist_body)

Parameters

Name	Type	Description	Required	Notes
flist_body	FlistBody		[required]

Return type

models::Job

Authorization

bearerAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_flist_state_handler

models::FlistStateResponse get_flist_state_handler(job_id)

Parameters

Name	Type	Description	Required	Notes
job_id	String	flist job id	[required]

Return type

models::FlistStateResponse

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_flists_handler

std::collections::HashMap<String, Vecmodels::FileInfo> list_flists_handler()

Parameters

This endpoint does not need any parameter.

Return type

std::collections::HashMap<String, Vecmodels::FileInfo>

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

preview_flist_handler

models::PreviewResponse preview_flist_handler(flist_path)

Parameters

Name	Type	Description	Required	Notes
flist_path	String	flist file path	[required]

Return type

models::PreviewResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

serve_flists

std::path::PathBuf serve_flists(path) Serve flist files from the server's filesystem

Parameters

Name	Type	Description	Required	Notes
path	String	Path to the flist file or directory to serve	[required]

Return type

std::path::PathBuf

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/octet-stream, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]