Skip to content

Commit 4c11034

Browse files
committed
format API description text with line breaks
1 parent 18793cd commit 4c11034

1 file changed

Lines changed: 13 additions & 13 deletions

File tree

interop_query/views.py

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
tags=["Genes"],
1717
summary="List all genes (paginated)",
1818
description=(
19-
"Return distinct (gene, species) pairs with PanKB URLs. "
19+
"Return distinct (gene, species) pairs with PanKB URLs.\n\n"
2020
"Supports cursor-based pagination via after/limit query parameters."
2121
),
2222
parameters=[
@@ -80,7 +80,7 @@ def genes(request):
8080
tags=["Strains"],
8181
summary="List all strains (paginated)",
8282
description=(
83-
"Return all strains (genome IDs) with PanKB URLs. "
83+
"Return all strains (genome IDs) with PanKB URLs.\n\n"
8484
"Supports cursor-based pagination via after/limit query parameters."
8585
),
8686
parameters=[
@@ -142,7 +142,7 @@ def strains(request):
142142
tags=["Gene-Strain Pairs"],
143143
summary="List gene-strain pairs (paginated)",
144144
description=(
145-
"Return distinct (gene, strain, locus_tag) pairs with PanKB URLs. "
145+
"Return distinct (gene, strain, locus_tag) pairs with PanKB URLs.\n\n"
146146
"Supports cursor-based pagination via after/limit query parameters."
147147
),
148148
parameters=[
@@ -206,10 +206,10 @@ def gene_strain_pairs(request):
206206
tags=["Gene-Strain Pairs"],
207207
summary="Query by gene-strain pairs",
208208
description=(
209-
"Look up detailed gene info for specific gene/strain pair combinations. "
210-
"Accepts JSON body: {\"pairs\": [{\"gene\": \"...\", \"strain\": \"...\"}]}. "
211-
"Both 'gene' and 'strain' must be strings (not arrays). Each pair represents one gene-strain combination. "
212-
"Returns 400 if the pairs list is empty or entries are missing required fields. "
209+
"Look up detailed gene info for specific gene/strain pair combinations.\n\n"
210+
"Accepts JSON body: {\"pairs\": [{\"gene\": \"...\", \"strain\": \"...\"}]}.\n\n"
211+
"Both 'gene' and 'strain' must be strings (not arrays). Each pair represents one gene-strain combination.\n\n"
212+
"Returns 400 if the pairs list is empty or entries are missing required fields.\n\n"
213213
"IDs not found in the database are silently omitted from the response."
214214
),
215215
request={
@@ -326,9 +326,9 @@ def query_by_pair(request):
326326
tags=["Genes"],
327327
summary="Query by gene names",
328328
description=(
329-
"Look up detailed gene info by a list of gene names. "
330-
"Accepts JSON body: {\"ids\": [\"geneA\", \"geneB\"]}. "
331-
"Returns 400 if the ids list is empty or missing. "
329+
"Look up detailed gene info by a list of gene names.\n\n"
330+
"Accepts JSON body: {\"ids\": [\"geneA\", \"geneB\"]}.\n\n"
331+
"Returns 400 if the ids list is empty or missing.\n\n"
332332
"IDs not found in the database are silently omitted from the response."
333333
),
334334
request={
@@ -410,9 +410,9 @@ def query_by_gene(request):
410410
tags=["Strains"],
411411
summary="Query by strain IDs",
412412
description=(
413-
"Look up genome info by a list of genome IDs. "
414-
"Accepts JSON body: {\"ids\": [\"GCF_...\", \"GCF_...\"]}. "
415-
"Returns 400 if the ids list is empty or missing. "
413+
"Look up genome info by a list of genome IDs.\n\n"
414+
"Accepts JSON body: {\"ids\": [\"GCF_...\", \"GCF_...\"]}.\n\n"
415+
"Returns 400 if the ids list is empty or missing.\n\n"
416416
"IDs not found in the database are silently omitted from the response."
417417
),
418418
request={

0 commit comments

Comments
 (0)