Package gov.nasa.pds.api.base

Interface ClassesApi

All Known Implementing Classes:

ClassesApiController

@Generated(value="org.openapitools.codegen.languages.SpringCodegen",
           date="2024-09-03T18:10:48.512595446Z[GMT]")
@Validated
public interface ClassesApi

Method Summary

Modifier and Type	Method	Description
default org.springframework.http.ResponseEntity<List<String>>	classes()	GET /classes : returns a list of the available PDS product class at this API.
default org.springframework.http.ResponseEntity<Object>	classList(String propertyClass, @Valid List<String> fields, @Valid List<String> keywords, @Min(0L) @Valid Integer limit, @Valid String q, @Valid List<String> sort, @Valid List<String> searchAfter)	GET /classes/{class} : returns all PDS products of the given PDS product class that meet all given constraints.
default Optional<org.springframework.web.context.request.NativeWebRequest>	getRequest()

Method Details

getRequest

default Optional<org.springframework.web.context.request.NativeWebRequest> getRequest()

classList

@RequestMapping(method=GET,
                value="/classes/{class}",
                produces={"*","*/*","application/csv","application/json","application/kvp+json","application/vnd.nasa.pds.pds4+json","application/vnd.nasa.pds.pds4+xml","application/xml","text/csv","text/html","text/xml"})
default org.springframework.http.ResponseEntity<Object> classList(@PathVariable("class")
 String propertyClass,
 @Valid @RequestParam(value="fields",required=false)
 @Valid List<String> fields,
 @Valid @RequestParam(value="keywords",required=false)
 @Valid List<String> keywords,
 @Min(0L) @Valid @RequestParam(value="limit",required=false,defaultValue="100")
 @Min(0L) @Valid Integer limit,
 @Valid @RequestParam(value="q",required=false)
 @Valid String q,
 @Valid @RequestParam(value="sort",required=false)
 @Valid List<String> sort,
 @Valid @RequestParam(value="search-after",required=false)
 @Valid List<String> searchAfter)
                                                           throws Exception

GET /classes/{class} : returns all PDS products of the given PDS product class that meet all given constraints.

Parameters:

propertyClass - syntax: one of the allowable enum values This is a shortcut for doing a query with ... (required)

fields - syntax: fields=field1,field2,... behavior: this parameter and the headder Accept: type determine what content is packaged for the result. While the types application/csv, application/kvp+json, and text/csv return only the fields requesteted, all of the other types have a minimal set of fields that must be returned. Duplicating a minimally required field in this parameter has not effect. The types vnd.nasa.pds.pds4+json and vnd.nasa.pds.pds4+xml have a complete set of fields that must be returned; meaning this parameter does not impact their content. When fields is not used, then the minimal set of fields, or all when minimal is an empty set, is returned. notes: the blob fields are blocked unless specifically requrested and only for the *_/csv and application/kvp+csv types. (optional)

keywords - syntax: keyword=keyword1,keyword2,... behavior: free text search on title and description (if set q is ignored (optional)

limit - syntax: limit=10 behavior: maximum number of matching results returned, for pagination (optional, default to 100)

q - syntax: q=\"vid eq 13.0\" behavior: query uses eq,ne,gt,ge,lt,le,(,),not,and,or operators. Properties are named as in 'properties' attributes, literals are strings between quotes, like \"animal\", or numbers. Detailed query specification is available at https://bit.ly/3h3D54T note: ignored when keyword is present (optional)

sort - syntax: sort=field0,field1,... behavior: currently only sorts ascending (optional)

searchAfter - syntax: search-after=sortField0Value,sortField1Value,... behavior: for each field specified in the \"sort\" qparam, specify the field value for the last result returned in the previous page It is strongly recommended to use ops:Harvest_Info/ops:harvest_date_time as your final sort field, to ensure successful pagination. Remember to url-encode special characters, ex. /products?limit=10&sort=ops%3AHarvest_Info%2Fops%3Aharvest_date_time (optional)

Returns:

Successful request (status code 200) or Unsuccessful request (status code 400) or Unsuccessful request (status code 404) or Unsuccessful request (status code 500) or Unsuccessful request (status code 501)

Throws:

Exception

classes

@RequestMapping(method=GET,
                value="/classes",
                produces={"*","*/*","application/csv","application/json","application/kvp+json","application/vnd.nasa.pds.pds4+json","application/vnd.nasa.pds.pds4+xml","application/xml","text/csv","text/html","text/xml"})
default org.springframework.http.ResponseEntity<List<String>> classes()
                                                               throws Exception

GET /classes : returns a list of the available PDS product class at this API. This is not all of the PDS product class available in the database, but simply the names that can be used in the /classes/{class} endpoints.

Returns:

Successful response is always a JSON list of the available class names (status code 200) or Unsuccessful request (status code 400) or Unsuccessful request (status code 404) or Unsuccessful request (status code 500) or Unsuccessful request (status code 501)

Throws:

Exception