vdoc.api.routes package

Submodules

vdoc.api.routes.projects module

Contains all projects related REST API routes.

vdoc.api.routes.projects.get_project_versions(name, version)

Returns the requested project version.

Parameters:
  • name (str) – The name of the project.

  • version (str) – The requested version.

Return type:

str

Returns:

The requested project version.

vdoc.api.routes.projects.list_project_versions(name)

Lists all versions of a project.

Parameters:

name (str) – The name of the project.

Return type:

list[str]

Returns:

A list of all versions of a project.

vdoc.api.routes.projects.list_projects()

Lists all available projects.

Return type:

list[Project]

Returns:

A list of all available projects.

vdoc.api.routes.projects.upload_project_version(name, version, file, _)

Accepts and processes an uploaded project documentation.

Parameters:
  • name (str) – The project name.

  • version (str) – The project version.

  • file (UploadFile) – The documentation zip file.

Return type:

JSONResponse

Returns:

A message that the documentation has been uploaded successfully.

Module contents

Contains all REST API routes.