Merge branch 'feature/23-add-mandatory-docs' into 'development'

Resolve "Add mandatory input and output docs to workflow requirements"

Closes #23

See merge request !21

app/api/utils.py

@@ -67,7 +67,9 @@ async def check_repo(repo: GitRepository, client: AsyncClient) -> None:
         Http client with an open connection. Dependency Injection.
     """
     await repo.check_files_exist(
-        ["README.md", "CHANGELOG.md", "main.nf", "nextflow_schema.json"], client=client, raise_error=True
+        ["README.md", "CHANGELOG.md", "main.nf", "nextflow_schema.json", "docs/usage.md", "docs/output.md"],
+        client=client,
+        raise_error=True,
     )
 
 

app/schemas/workflow_version.py

@@ -63,9 +63,19 @@ class WorkflowVersionFull(WorkflowVersionReduced):
     )
     changelog_url: AnyHttpUrl = Field(
         ...,
-        description="URL to download CHAnGELOG.md from",
+        description="URL to download CHANGELOG.md from",
         example="https://raw.githubusercontent.com/example/example/CHANGELOG.md",
     )
+    usage_url: AnyHttpUrl = Field(
+        ...,
+        description="URL to download usage.md from",
+        example="https://raw.githubusercontent.com/example/example/docs/usage.md",
+    )
+    output_url: AnyHttpUrl = Field(
+        ...,
+        description="URL to download output.md from",
+        example="https://raw.githubusercontent.com/example/example/docs/output.md",
+    )
     parameter_schema_url: AnyHttpUrl = Field(
         ...,
         description="URL to download nextflow_schema.json from",
@@ -78,6 +88,8 @@ class WorkflowVersionFull(WorkflowVersionReduced):
             workflow_id=db_version.workflow_id,
             readme_url=repo.downloadFileURL("README.md"),
             changelog_url=repo.downloadFileURL("CHANGELOG.md"),
+            usage_url=repo.downloadFileURL("docs/usage.md"),
+            output_url=repo.downloadFileURL("docs/output.md"),
             parameter_schema_url=repo.downloadFileURL("nextflow_schema.json"),
             **WorkflowVersionReduced.from_db_version(db_version).dict(),
         )