Skip to content

Commit

Permalink
Remove now-redundant parameter documentation from atop "metadata" group
Browse files Browse the repository at this point in the history
  • Loading branch information
eecavanna committed Dec 3, 2024
1 parent 3f72db4 commit fe4a61e
Showing 1 changed file with 1 addition and 13 deletions.
14 changes: 1 addition & 13 deletions nmdc_runtime/api/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -235,19 +235,7 @@
parameters for the __metadata__ endpoints that do not have a red ___* required___ next to them are optional. <br/>
Unlike the compact syntax used in the __find__ endpoints, the syntax for the filter parameter of the metadata endpoints
uses [MongoDB-like language querying](https://www.mongodb.com/docs/manual/tutorial/query-documents/).
The applicable parameters of the __metadata__ endpoints, with acceptable syntax and examples, are in the table below.
| Parameter | Description | Syntax | Example |
| :---: | :-----------: | :-------: | :---: |
| collection_name | The name of the collection to be queried. For a list of collection names please see the [Database class](https://w3id.org/nmdc/Database/) of the NMDC Schema | String | `biosample_set` |
| filter | Allows conditions to be set as part of the query, returning only results that satisfy the conditions | [MongoDB-like query language](https://www.mongodb.com/docs/manual/tutorial/query-documents/). All strings should be in double quotation marks. | `{"lat_lon.latitude": {"$gt": 45.0}, "ecosystem_category": "Plants"}` |
| max_page_size | Specifies the maximum number of documents returned at a time | Integer | `25`
| page_token | Specifies the token of the page to return. If unspecified, the first page is returned. To retrieve a subsequent page, the value received as the `next_page_token` from the bottom of the previous results can be provided as a `page_token`. | String | `nmdc:sys0ae1sh583`
| projection | Indicates the desired attributes to be included in the response. Helpful for trimming down the returned results | Comma-separated list of attributes that belong to the documents in the collection being queried | `name, ecosystem_type` |
| doc_id | The unique identifier of the item being requested. For example, the identifier of a biosample or an extraction | Curie e.g. `prefix:identifier` | `nmdc:bsm-11-ha3vfb58` |<br/>
<br/>
uses [MongoDB-like language querying](https://www.mongodb.com/docs/manual/tutorial/query-documents/).
""",
},
{
Expand Down

0 comments on commit fe4a61e

Please sign in to comment.