Skip to content

Commit 7608694

Browse files
committed
HARMONY-1898: Update readthedocs.
1 parent db8ead6 commit 7608694

File tree

2 files changed

+3
-25
lines changed

2 files changed

+3
-25
lines changed

docs/api.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ The classes in the ``harmony`` package that are used for crafting a request, sub
1717

1818
.. autoclass:: harmony.CapabilitiesRequest
1919

20+
.. autoclass:: harmony.LabelsRequest
21+
2022
.. autoclass:: harmony.Client
2123

2224
When creating a request, the ``BBox`` and ``Collection`` classes are used to create a valid request.

harmony/harmony.py

Lines changed: 1 addition & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -242,12 +242,6 @@ class HttpMethod(Enum):
242242
243243
This enum defines the standard HTTP methods that can be used when making requests
244244
to the Harmony API.
245-
246-
Attributes:
247-
GET (str): The HTTP GET method, used for retrieving resources.
248-
PUT (str): The HTTP PUT method, used for updating or replacing resources.
249-
POST (str): The HTTP POST method, used for creating new resources.
250-
DELETE (str): The HTTP DELETE method, used for removing resources.
251245
"""
252246
GET = "GET"
253247
PUT = "PUT"
@@ -557,13 +551,6 @@ class CapabilitiesRequest(BaseRequest):
557551
capabilities_version (str, optional): The version of the collection
558552
capabilities request API.
559553
560-
Attributes:
561-
collection_id (str or None): The CMR collection ID.
562-
short_name (str or None): The short name of the CMR collection.
563-
capabilities_version (str or None): The version of the capabilities API.
564-
variable_name_to_query_param (dict): Mapping of attribute names to
565-
their corresponding query parameter names.
566-
567554
Returns:
568555
CapabilitiesRequest: An instance of the request configured with
569556
the provided parameters.
@@ -610,12 +597,6 @@ class LabelsRequest(BaseRequest):
610597
labels (List[str]): A list of labels to be added or removed.
611598
job_ids (List[str]): A list of job IDs to which the labels apply.
612599
613-
Attributes:
614-
labels (List[str]): The labels to be created or deleted.
615-
job_ids (List[str]): The IDs of the jobs associated with the labels.
616-
variable_name_to_query_param (dict): Mapping of attribute names to
617-
their corresponding query parameter names.
618-
619600
Returns:
620601
LabelsRequest: An instance of the request configured with the provided parameters.
621602
"""
@@ -642,12 +623,7 @@ def error_messages(self) -> List[str]:
642623

643624

644625
class LinkType(Enum):
645-
"""The type of URL to provide when returning links to data.
646-
647-
s3: Returns an Amazon Web Services (AWS) S3 URL.
648-
http: Returns a standard HTTP URL.
649-
https: Returns a standard HTTPS URL.
650-
"""
626+
"""The type of URL to provide when returning links to data."""
651627
s3 = 's3'
652628
http = 'http'
653629
https = 'https'

0 commit comments

Comments
 (0)