Issue:
For datasets which have multiple HAPI IDs (e.g. AMPTECCE_H0_MEPA is split into 5 HAPI datasets in the CDAWeb Server), the returned example script for each language should include a notice to the user stating such.
I suggest a comment similar to the following be included somewhere noticeable within each script:
"Note that the following example is for only one part of the larger dataset {dataset name without the '@#'}, which has multiple HAPI IDs ({all sub-dataset ID numbers}). If you would like the entire {dataset name without the '@#'} dataset, run this script for each of these HAPI IDs by replacing the dataset value accordingly."
For example:
Note that the following example is for only one part of the larger dataset AMPTECCE_H0_MEPA which has multiple HAPI IDs (AMPTECCE_H0_MEPA@0, AMPTECCE_H0_MEPA@1, AMPTECCE_H0_MEPA@2, AMPTECCE_H0_MEPA@3, AMPTECCE_H0_MEPA@4). If you would like the entire AMPTECCE_H0_MEPA dataset, run this script for each of these HAPI IDs by replacing the dataset value accordingly.
Motivation:
This will allow external services which use the HAPI API to grab these scripts to disclose to the user that there may be more data to consider. This will prevent these services from having to manually insert a similar comment themselves.
Issue:
For datasets which have multiple HAPI IDs (e.g. AMPTECCE_H0_MEPA is split into 5 HAPI datasets in the CDAWeb Server), the returned example script for each language should include a notice to the user stating such.
I suggest a comment similar to the following be included somewhere noticeable within each script:
"Note that the following example is for only one part of the larger dataset {dataset name without the '@#'}, which has multiple HAPI IDs ({all sub-dataset ID numbers}). If you would like the entire {dataset name without the '@#'} dataset, run this script for each of these HAPI IDs by replacing the dataset value accordingly."
For example:
Note that the following example is for only one part of the larger dataset AMPTECCE_H0_MEPA which has multiple HAPI IDs (AMPTECCE_H0_MEPA@0, AMPTECCE_H0_MEPA@1, AMPTECCE_H0_MEPA@2, AMPTECCE_H0_MEPA@3, AMPTECCE_H0_MEPA@4). If you would like the entire AMPTECCE_H0_MEPA dataset, run this script for each of these HAPI IDs by replacing the dataset value accordingly.
Motivation:
This will allow external services which use the HAPI API to grab these scripts to disclose to the user that there may be more data to consider. This will prevent these services from having to manually insert a similar comment themselves.