api description

specs/ingestion/spec.yml

@@ -36,27 +36,31 @@ tags:
     x-displayName: Tasks
     description: A Task describe how we fetch the data (reindex, on-demand, subscription) from a source and how we index it on the Algolia side.
 paths:
+  # authentications API.
   /1/authentications:
     $ref: 'paths/authentications/authentications.yml'
   /1/authentications/search:
     $ref: 'paths/authentications/searchAuthentications.yml'
   /1/authentications/{authenticationID}:
     $ref: 'paths/authentications/authenticationID.yml'
 
+  # destinations API.
   /1/destinations:
     $ref: 'paths/destinations/destinations.yml'
   /1/destinations/search:
     $ref: 'paths/destinations/searchDestinations.yml'
   /1/destinations/{destinationID}:
     $ref: 'paths/destinations/destinationID.yml'
 
+  # sources API.
   /1/sources:
     $ref: 'paths/sources/sources.yml'
   /1/sources/search:
     $ref: 'paths/sources/searchSources.yml'
   /1/sources/{sourceID}:
     $ref: 'paths/sources/sourceID.yml'
 
+  # tasks API.
   /1/tasks:
     $ref: 'paths/tasks/tasks.yml'
   /1/tasks/search:
@@ -70,6 +74,7 @@ paths:
   /1/tasks/{taskID}/disable:
     $ref: 'paths/tasks/disableTask.yml'
 
+  # observability API.
   /1/runs:
     $ref: 'paths/runs/runs.yml'
   /1/runs/{runID}: