docs: Clarify which collection ID is needed

open-contracting · May 3, 2024 · 7013bca · 7013bca
1 parent 1205498
commit 7013bca
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/backend/api/views.py b/backend/api/views.py
@@ -150,7 +150,7 @@ class StatusSerializer(serializers.Serializer):
 
 class CreateDatasetSerializer(serializers.Serializer):
     name = serializers.CharField(help_text="The name to assign to the dataset")
-    collection_id = serializers.IntegerField(help_text="The collection ID in Kingfisher Process")
+    collection_id = serializers.IntegerField(help_text="The compiled collection ID in Kingfisher Process")
     ancestor_id = serializers.IntegerField(
         required=False, help_text="The ID of the previous report in Pelican, for time-based checks"
     )

diff --git a/docs/_static/openapi.yaml b/docs/_static/openapi.yaml
@@ -428,7 +428,7 @@ components:
           description: The name to assign to the dataset
         collection_id:
           type: integer
-          description: The collection ID in Kingfisher Process
+          description: The compiled collection ID in Kingfisher Process
         ancestor_id:
           type: integer
           description: The ID of the previous report in Pelican, for time-based checks