Changes to ma_api from docs/doc-exports#24

Reviewed-by: Goncharov, Artem <artem.goncharov@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>

api-ref/source/application_cases/index.rst

@@ -1,10 +1,14 @@
+:original_name: modelarts_03_0400.html
+
 .. _modelarts_03_0400:
 
-=================
 Application Cases
 =================
 
+-  :ref:`Creating a Training Job Using the TensorFlow Framework <modelarts_03_0401>`
+
 .. toctree::
    :maxdepth: 1
+   :hidden: 
 
    creating_a_training_job_using_the_tensorflow_framework

api-ref/source/authorization_management/index.rst

@@ -1,11 +1,18 @@
+:original_name: authorization.html
+
 .. _authorization:
 
-========================
 Authorization Management
 ========================
 
+-  :ref:`Configuring Authorization <createauthorization>`
+-  :ref:`Viewing an Authorization List <getauthorizations>`
+-  :ref:`Deleting Authorization <deleteauthorizations>`
+-  :ref:`Creating a ModelArts Agency <createmodelartsagency>`
+
 .. toctree::
    :maxdepth: 1
+   :hidden: 
 
    configuring_authorization
    viewing_an_authorization_list

api-ref/source/before_you_start/index.rst

@@ -1,11 +1,18 @@
+:original_name: modelarts_03_0139.html
+
 .. _modelarts_03_0139:
 
-================
 Before You Start
 ================
 
+-  :ref:`Overview <modelarts_03_0001>`
+-  :ref:`API Calling <modelarts_03_0140>`
+-  :ref:`Endpoints <modelarts_03_0141>`
+-  :ref:`Basic Concepts <modelarts_03_0143>`
+
 .. toctree::
    :maxdepth: 1
+   :hidden: 
 
    overview
    api_calling

api-ref/source/calling_apis/index.rst

@@ -1,11 +1,17 @@
+:original_name: modelarts_03_0144.html
+
 .. _modelarts_03_0144:
 
-============
 Calling APIs
 ============
 
+-  :ref:`Making an API Request <modelarts_03_0005>`
+-  :ref:`Authentication <modelarts_03_0004>`
+-  :ref:`Response <modelarts_03_0003>`
+
 .. toctree::
    :maxdepth: 1
+   :hidden: 
 
    making_an_api_request
    authentication

api-ref/source/common_parameters/index.rst

@@ -1,11 +1,20 @@
+:original_name: modelarts_03_0093.html
+
 .. _modelarts_03_0093:
 
-=================
 Common Parameters
 =================
 
+-  :ref:`Status Code <modelarts_03_0094>`
+-  :ref:`Error Codes <modelarts_03_0095>`
+-  :ref:`Obtaining a Project ID <modelarts_03_0147>`
+-  :ref:`Obtaining an Account Name and ID <modelarts_03_0148>`
+-  :ref:`Obtaining a Username and ID <modelarts_03_0006>`
+-  :ref:`Obtaining a Project Name <modelarts_03_0247>`
+
 .. toctree::
    :maxdepth: 1
+   :hidden: 
 
    status_code
    error_codes

api-ref/source/data_management/data_export_task/index.rst

@@ -1,11 +1,17 @@
+:original_name: data_export.html
+
 .. _data_export:
 
-================
 Data Export Task
 ================
 
+-  :ref:`Querying the Dataset Export Task List <getexporttasksstatusofdataset>`
+-  :ref:`Creating a Dataset Export Task <exporttask>`
+-  :ref:`Querying the Status of a Dataset Export Task <getexporttaskstatusofdataset>`
+
 .. toctree::
    :maxdepth: 1
+   :hidden: 
 
    querying_the_dataset_export_task_list
    creating_a_dataset_export_task

api-ref/source/data_management/data_import_task/index.rst

@@ -1,11 +1,17 @@
+:original_name: data_import.html
+
 .. _data_import:
 
-================
 Data Import Task
 ================
 
+-  :ref:`Querying the Dataset Import Task List <listimporttasks>`
+-  :ref:`Creating an Import Task <importtask>`
+-  :ref:`Querying Details About a Dataset Import Task <descimporttask>`
+
 .. toctree::
    :maxdepth: 1
+   :hidden: 
 
    querying_the_dataset_import_task_list
    creating_an_import_task

api-ref/source/data_management/data_synchronization_task/index.rst

@@ -1,11 +1,16 @@
+:original_name: data_sync.html
+
 .. _data_sync:
 
-=========================
 Data Synchronization Task
 =========================
 
+-  :ref:`Synchronizing a Dataset <syncdatasource>`
+-  :ref:`Querying the Status of a Dataset Synchronization Task <syncdatasourcestate>`
+
 .. toctree::
    :maxdepth: 1
+   :hidden: 
 
    synchronizing_a_dataset
    querying_the_status_of_a_dataset_synchronization_task

api-ref/source/data_management/dataset_management/index.rst

@@ -1,11 +1,23 @@
+:original_name: dataset_management.html
+
 .. _dataset_management:
 
-==================
 Dataset Management
 ==================
 
+-  :ref:`Response body for querying the dataset list. <listdatasets>`
+-  :ref:`Creating a Dataset <createdataset>`
+-  :ref:`Querying Details About a Dataset <descdataset>`
+-  :ref:`Modifying a Dataset <updatedataset>`
+-  :ref:`Deleting a Dataset <deletedataset>`
+-  :ref:`Querying Dataset Statistics <liststats>`
+-  :ref:`Querying the Monitoring Data of a Dataset <getdatasetmetrics>`
+-  :ref:`Querying Details About Team Labeling Task Statistics <listworkforcetaskstats>`
+-  :ref:`Querying Details About the Progress of a Team Labeling Task Member <getworkforcetaskmetrics>`
+
 .. toctree::
    :maxdepth: 1
+   :hidden: 
 
    response_body_for_querying_the_dataset_list.
    creating_a_dataset

api-ref/source/data_management/dataset_version_management/index.rst

@@ -1,11 +1,18 @@
+:original_name: dataset_version_management.html
+
 .. _dataset_version_management:
 
-==========================
 Dataset Version Management
 ==========================
 
+-  :ref:`Querying the Dataset Version List <listdatasetversions>`
+-  :ref:`Creating a Dataset Labeling Version <createdatasetversion>`
+-  :ref:`Querying Details About a Dataset Version <describedatasetversion>`
+-  :ref:`Deleting a Dataset Labeling Version <deletedatasetversion>`
+
 .. toctree::
    :maxdepth: 1
+   :hidden: 
 
    querying_the_dataset_version_list
    creating_a_dataset_labeling_version

api-ref/source/data_management/index.rst

@@ -1,11 +1,27 @@
+:original_name: modelarts_03_0202.html
+
 .. _modelarts_03_0202:
 
-===============
 Data Management
 ===============
 
+-  :ref:`Data Management APIs <modelarts_03_0299>`
+-  :ref:`Dataset Management <dataset_management>`
+-  :ref:`Dataset Version Management <dataset_version_management>`
+-  :ref:`Sample Management <sample_management>`
+-  :ref:`Label Management <label_management>`
+-  :ref:`Manual Labeling <manual_annotation_management>`
+-  :ref:`Labeling Task Management <label_task_management>`
+-  :ref:`Team Labeling Process Management <workforce_process_management>`
+-  :ref:`Labeling Team Management <workforce_management>`
+-  :ref:`Labeling Team Member Management <workforce_worker_management>`
+-  :ref:`Data Import Task <data_import>`
+-  :ref:`Data Export Task <data_export>`
+-  :ref:`Data Synchronization Task <data_sync>`
+
 .. toctree::
    :maxdepth: 1
+   :hidden: 
 
    data_management_apis
    dataset_management/index

api-ref/source/data_management/label_management/index.rst

@@ -1,11 +1,20 @@
+:original_name: label_management.html
+
 .. _label_management:
 
-================
 Label Management
 ================
 
+-  :ref:`Querying the Dataset Label List <listlabels>`
+-  :ref:`Creating a Dataset Label <createlabels>`
+-  :ref:`Modifying Labels in Batches <updatelabels>`
+-  :ref:`Deleting Labels in Batches <deletelabels>`
+-  :ref:`Updating a Label by Label Names <updatelabel>`
+-  :ref:`Deleting a Label and the Files that Only Contain the Label <deletelabelandsamples>`
+
 .. toctree::
    :maxdepth: 1
+   :hidden: 
 
    querying_the_dataset_label_list
    creating_a_dataset_label

api-ref/source/data_management/labeling_task_management/index.rst

@@ -1,11 +1,24 @@
+:original_name: label_task_management.html
+
 .. _label_task_management:
 
-========================
 Labeling Task Management
 ========================
 
+-  :ref:`Querying the Team Labeling Task List of a Dataset <listworkforcetasks>`
+-  :ref:`Creating a Team Labeling Task <createworkforcetask>`
+-  :ref:`Querying Details About a Team Labeling Task <descworkforcetask>`
+-  :ref:`Starting a Team Labeling Task <startworkforcetask>`
+-  :ref:`Updating a Team Labeling Task <updateworkforcetask>`
+-  :ref:`Deleting a Team Labeling Task <deleteworkforcetask>`
+-  :ref:`Creating a Team Labeling Acceptance Task <startworkforcesamplingtask>`
+-  :ref:`Querying the Report of a Team Labeling Acceptance Task <getworkforcesamplingtask>`
+-  :ref:`Updating the Status of a Team Labeling Acceptance Task <updateworkforcesamplingtask>`
+-  :ref:`Querying the Team Labeling Task List by a Team Member <listworkertasks>`
+
 .. toctree::
    :maxdepth: 1
+   :hidden: 
 
    querying_the_team_labeling_task_list_of_a_dataset
    creating_a_team_labeling_task

api-ref/source/data_management/labeling_team_management/index.rst

@@ -1,11 +1,19 @@
+:original_name: workforce_management.html
+
 .. _workforce_management:
 
-========================
 Labeling Team Management
 ========================
 
+-  :ref:`Querying the Labeling Team List <listworkforces>`
+-  :ref:`Creating a Labeling Team <createworkforce>`
+-  :ref:`Querying Details About a Labeling Team <descworkforce>`
+-  :ref:`Updating a Labeling Team <updateworkforce>`
+-  :ref:`Deleting a Labeling Team <deleteworkforce>`
+
 .. toctree::
    :maxdepth: 1
+   :hidden: 
 
    querying_the_labeling_team_list
    creating_a_labeling_team

api-ref/source/data_management/labeling_team_member_management/index.rst

@@ -1,11 +1,22 @@
+:original_name: workforce_worker_management.html
+
 .. _workforce_worker_management:
 
-===============================
 Labeling Team Member Management
 ===============================
 
+-  :ref:`Sending an Email to a Labeling Team Member <sendemails>`
+-  :ref:`Querying the List of All Labeling Team Members <listallworkers>`
+-  :ref:`Querying the List of Labeling Team Members <listworkers>`
+-  :ref:`Creating a Labeling Team Member <createworker>`
+-  :ref:`Deleting Labeling Team Members in Batches <deleteworkers>`
+-  :ref:`Querying Details About Labeling Team Members <descworker>`
+-  :ref:`Updating a Labeling Team Member <updateworker>`
+-  :ref:`Deleting a Labeling Team Member <deleteworker>`
+
 .. toctree::
    :maxdepth: 1
+   :hidden: 
 
    sending_an_email_to_a_labeling_team_member
    querying_the_list_of_all_labeling_team_members

api-ref/source/data_management/manual_labeling/index.rst

@@ -1,10 +1,14 @@
+:original_name: manual_annotation_management.html
+
 .. _manual_annotation_management:
 
-===============
 Manual Labeling
 ===============
 
+-  :ref:`Updating Sample Labels in Batches <updatesamples>`
+
 .. toctree::
    :maxdepth: 1
+   :hidden: 
 
    updating_sample_labels_in_batches

api-ref/source/data_management/sample_management/index.rst

@@ -1,11 +1,21 @@
+:original_name: sample_management.html
+
 .. _sample_management:
 
-=================
 Sample Management
 =================
 
+-  :ref:`Querying the Sample List <listsamples>`
+-  :ref:`Adding Samples in Batches <uploadsamplesjson>`
+-  :ref:`Deleting Samples in Batches <deletesamples>`
+-  :ref:`Querying Details About a Sample <describesample>`
+-  :ref:`Obtaining Sample Search Condition <listsearch>`
+-  :ref:`Querying the Sample List of a Team Labeling Task by Page <listworkforcetasksamples>`
+-  :ref:`Querying Details About Team Labeling Samples <describeworkforcetasksample>`
+
 .. toctree::
    :maxdepth: 1
+   :hidden: 
 
    querying_the_sample_list
    adding_samples_in_batches

api-ref/source/data_management/team_labeling_process_management/index.rst

@@ -1,11 +1,17 @@
+:original_name: workforce_process_management.html
+
 .. _workforce_process_management:
 
-================================
 Team Labeling Process Management
 ================================
 
+-  :ref:`Submitting Sample Review Comments of an Acceptance Task <acceptsamples>`
+-  :ref:`Reviewing Team Labeling Results <reviewsamples>`
+-  :ref:`Updating Labels of Team Labeling Samples in Batches <updateworkforcetasksamples>`
+
 .. toctree::
    :maxdepth: 1
+   :hidden: 
 
    submitting_sample_review_comments_of_an_acceptance_task
    reviewing_team_labeling_results

api-ref/source/devenviron/index.rst

@@ -1,11 +1,20 @@
+:original_name: modelarts_03_0108.html
+
 .. _modelarts_03_0108:
 
-==========
 DevEnviron
 ==========
 
+-  :ref:`Creating a Development Environment Instance <modelarts_03_0110>`
+-  :ref:`Querying a List of Development Environment Instances <modelarts_03_0111>`
+-  :ref:`Querying Details About a Development Environment Instance <modelarts_03_0112>`
+-  :ref:`Modifying the Description of a Development Environment Instance <modelarts_03_0113>`
+-  :ref:`Deleting a Development Environment Instance <modelarts_03_0114>`
+-  :ref:`Managing a Development Environment Instance <modelarts_03_0115>`
+
 .. toctree::
    :maxdepth: 1
+   :hidden: 
 
    creating_a_development_environment_instance
    querying_a_list_of_development_environment_instances

api-ref/source/model_management/index.rst

@@ -1,11 +1,18 @@
+:original_name: modelarts_03_0075.html
+
 .. _modelarts_03_0075:
 
-================
 Model Management
 ================
 
+-  :ref:`Importing a Model <modelarts_03_0076>`
+-  :ref:`Querying a Model List <modelarts_03_0077>`
+-  :ref:`Querying the Details About a Model <modelarts_03_0078>`
+-  :ref:`Deleting a Model <modelarts_03_0079>`
+
 .. toctree::
    :maxdepth: 1
+   :hidden: 
 
    importing_a_model
    querying_a_model_list

api-ref/source/permissions_policies_and_supported_actions/index.rst

@@ -1,11 +1,21 @@
+:original_name: modelarts_03_0138.html
+
 .. _modelarts_03_0138:
 
-==========================================
 Permissions Policies and Supported Actions
 ==========================================
 
+-  :ref:`Introduction <modelarts_03_0146>`
+-  :ref:`ExeML Permissions <modelarts_03_0234>`
+-  :ref:`Data Management Permissions <modelarts_03_0161>`
+-  :ref:`DevEnviron Permissions <modelarts_03_0162>`
+-  :ref:`Training Job Permissions <modelarts_03_0163>`
+-  :ref:`Model Management Permissions <modelarts_03_0164>`
+-  :ref:`Service Management Permissions <modelarts_03_0165>`
+
 .. toctree::
    :maxdepth: 1
+   :hidden: 
 
    introduction
    exeml_permissions

api-ref/source/service_management/index.rst

@@ -1,11 +1,24 @@
+:original_name: modelarts_03_0081.html
+
 .. _modelarts_03_0081:
 
-==================
 Service Management
 ==================
 
+-  :ref:`Deploying a Model as a Service <modelarts_03_0082>`
+-  :ref:`Querying a Service List <modelarts_03_0083>`
+-  :ref:`Querying the Details About a Service <modelarts_03_0084>`
+-  :ref:`Updating Service Configurations <modelarts_03_0086>`
+-  :ref:`Querying Service Monitoring Information <modelarts_03_0087>`
+-  :ref:`Querying Service Update Logs <modelarts_03_0088>`
+-  :ref:`Querying Service Event Logs <modelarts_03_0155>`
+-  :ref:`Deleting a Service <modelarts_03_0089>`
+-  :ref:`Querying Supported Service Deployment Specifications <modelarts_03_0200>`
+-  :ref:`Querying Dedicated Resource Pools <modelarts_03_0201>`
+
 .. toctree::
    :maxdepth: 1
+   :hidden: 
 
    deploying_a_model_as_a_service
    querying_a_service_list

api-ref/source/training_management/index.rst

@@ -1,11 +1,19 @@
+:original_name: modelarts_03_0043.html
+
 .. _modelarts_03_0043:
 
-===================
 Training Management
 ===================
 
+-  :ref:`Training Jobs <modelarts_03_0044>`
+-  :ref:`Training Job Parameter Configuration <modelarts_03_0057>`
+-  :ref:`Visualization Jobs <modelarts_03_0063>`
+-  :ref:`Resource and Engine Specifications <modelarts_03_0071>`
+-  :ref:`Job Statuses <modelarts_03_0074>`
+
 .. toctree::
    :maxdepth: 1
+   :hidden: 
 
    training_jobs/index
    training_job_parameter_configuration/index

api-ref/source/training_management/resource_and_engine_specifications/index.rst

@@ -1,11 +1,16 @@
+:original_name: modelarts_03_0071.html
+
 .. _modelarts_03_0071:
 
-==================================
 Resource and Engine Specifications
 ==================================
 
+-  :ref:`Querying Job Resource Specifications <modelarts_03_0072>`
+-  :ref:`Querying Job Engine Specifications <modelarts_03_0073>`
+
 .. toctree::
    :maxdepth: 1
+   :hidden: 
 
    querying_job_resource_specifications
    querying_job_engine_specifications

api-ref/source/training_management/training_job_parameter_configuration/index.rst

@@ -1,11 +1,19 @@
+:original_name: modelarts_03_0057.html
+
 .. _modelarts_03_0057:
 
-====================================
 Training Job Parameter Configuration
 ====================================
 
+-  :ref:`Creating a Training Job Configuration <modelarts_03_0058>`
+-  :ref:`Querying a List of Training Job Configurations <modelarts_03_0059>`
+-  :ref:`Modifying a Training Job Configuration <modelarts_03_0060>`
+-  :ref:`Deleting a Training Job Configuration <modelarts_03_0061>`
+-  :ref:`Querying the Details About a Training Job Configuration <modelarts_03_0062>`
+
 .. toctree::
    :maxdepth: 1
+   :hidden: 
 
    creating_a_training_job_configuration
    querying_a_list_of_training_job_configurations

api-ref/source/training_management/training_jobs/index.rst

@@ -1,11 +1,26 @@
+:original_name: modelarts_03_0044.html
+
 .. _modelarts_03_0044:
 
-=============
 Training Jobs
 =============
 
+-  :ref:`Creating a Training Job <modelarts_03_0045>`
+-  :ref:`Querying a Training Job List <modelarts_03_0046>`
+-  :ref:`Querying the Details About a Training Job Version <modelarts_03_0047>`
+-  :ref:`Deleting a Version of a Training Job <modelarts_03_0048>`
+-  :ref:`Querying a List of Training Job Versions <modelarts_03_0049>`
+-  :ref:`Creating a Version of a Training Job <modelarts_03_0050>`
+-  :ref:`Stopping a Training Job <modelarts_03_0051>`
+-  :ref:`Modifying the Description of a Training Job <modelarts_03_0052>`
+-  :ref:`Deleting a Training Job <modelarts_03_0053>`
+-  :ref:`Obtaining the Name of a Training Job Log File <modelarts_03_0054>`
+-  :ref:`Querying a Built-in Algorithm <modelarts_03_0056>`
+-  :ref:`Querying Training Job Logs <modelarts_03_0149>`
+
 .. toctree::
    :maxdepth: 1
+   :hidden: 
 
    creating_a_training_job
    querying_a_training_job_list

api-ref/source/training_management/visualization_jobs/index.rst

@@ -1,11 +1,21 @@
+:original_name: modelarts_03_0063.html
+
 .. _modelarts_03_0063:
 
-==================
 Visualization Jobs
 ==================
 
+-  :ref:`Creating a Visualization Job <modelarts_03_0064>`
+-  :ref:`Querying a Visualization Job List <modelarts_03_0065>`
+-  :ref:`Querying the Details About a Visualization Job <modelarts_03_0066>`
+-  :ref:`Modifying the Description of a Visualization Job <modelarts_03_0067>`
+-  :ref:`Deleting a Visualization Job <modelarts_03_0068>`
+-  :ref:`Stopping a Visualization Job <modelarts_03_0069>`
+-  :ref:`Restarting a Visualization Job <modelarts_03_0070>`
+
 .. toctree::
    :maxdepth: 1
+   :hidden: 
 
    creating_a_visualization_job
    querying_a_visualization_job_list