Package gov.nasa.pds.api.base

Interface BundlesApi

All Known Implementing Classes:
BundlesApiController
@Generated(value="org.openapitools.codegen.languages.SpringCodegen", date="2023-10-09T23:25:15.897294088Z[GMT]") @Validated public interface BundlesApi

  • Method Details

    • getRequest

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

    • bundleList

      @RequestMapping(method=GET, value="/bundles", 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> bundleList(@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, @Min(0L) @Valid @RequestParam(value="start",required=false,defaultValue="0") @Min(0L) @Valid Integer start)
      GET /bundles : deprecated
      Parameters:
      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=asc(field0),desc(field1),... behavior: is this implemented? (optional)
      start - syntax: start=12 behavior: offset in matching result list, for pagination (optional, default to 0)
      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)

    • bundlesLidvid

      @RequestMapping(method=GET, value="/bundles/{identifier}", 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> bundlesLidvid(@PathVariable("identifier") String identifier, @Valid @RequestParam(value="fields",required=false) @Valid List<String> fields)
      GET /bundles/{identifier} : deprecated
      Parameters:
      identifier - syntax: lidvid or lid behavior (lid): returns one or more items whose lid matches this lid exactly. If the endpoint ends with the identifier or /latest then a signle result is returned and it is the highest version. If the endpoint ends with /all then all versions of the lid are returned. behavior (lidvid): returns one and only one item whose lidvid matches this lidvid exactly. note: the current lid/lidvid resolution will match all the lids that start with lid. In other words, it acts like a glob of foobar*. It behavesn this way from first character to the last note: simple sorting of the lidvid is being done to select the latest from the end of the list. However, the versions 1.0, 2.0, and 13.0 will sort to 1.0, 13.0, and 2.0 so the end of the list may not be the latest. (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)
      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)

    • bundlesLidvidAll

      @RequestMapping(method=GET, value="/bundles/{identifier}/all", 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> bundlesLidvidAll(@PathVariable("identifier") String identifier, @Valid @RequestParam(value="fields",required=false) @Valid List<String> fields, @Min(0L) @Valid @RequestParam(value="limit",required=false,defaultValue="100") @Min(0L) @Valid Integer limit, @Valid @RequestParam(value="sort",required=false) @Valid List<String> sort, @Min(0L) @Valid @RequestParam(value="start",required=false,defaultValue="0") @Min(0L) @Valid Integer start)
      GET /bundles/{identifier}/all : deprecated
      Parameters:
      identifier - syntax: lidvid or lid behavior (lid): returns one or more items whose lid matches this lid exactly. If the endpoint ends with the identifier or /latest then a signle result is returned and it is the highest version. If the endpoint ends with /all then all versions of the lid are returned. behavior (lidvid): returns one and only one item whose lidvid matches this lidvid exactly. note: the current lid/lidvid resolution will match all the lids that start with lid. In other words, it acts like a glob of foobar*. It behavesn this way from first character to the last note: simple sorting of the lidvid is being done to select the latest from the end of the list. However, the versions 1.0, 2.0, and 13.0 will sort to 1.0, 13.0, and 2.0 so the end of the list may not be the latest. (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)
      limit - syntax: limit=10 behavior: maximum number of matching results returned, for pagination (optional, default to 100)
      sort - syntax: sort=asc(field0),desc(field1),... behavior: is this implemented? (optional)
      start - syntax: start=12 behavior: offset in matching result list, for pagination (optional, default to 0)
      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)

    • bundlesLidvidCollections

      @RequestMapping(method=GET, value="/bundles/{identifier}/collections", 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> bundlesLidvidCollections(@PathVariable("identifier") String identifier, @Valid @RequestParam(value="fields",required=false) @Valid List<String> fields, @Min(0L) @Valid @RequestParam(value="limit",required=false,defaultValue="100") @Min(0L) @Valid Integer limit, @Valid @RequestParam(value="sort",required=false) @Valid List<String> sort, @Min(0L) @Valid @RequestParam(value="start",required=false,defaultValue="0") @Min(0L) @Valid Integer start)
      GET /bundles/{identifier}/collections : deprecated
      Parameters:
      identifier - syntax: lidvid or lid behavior (lid): returns one or more items whose lid matches this lid exactly. If the endpoint ends with the identifier or /latest then a signle result is returned and it is the highest version. If the endpoint ends with /all then all versions of the lid are returned. behavior (lidvid): returns one and only one item whose lidvid matches this lidvid exactly. note: the current lid/lidvid resolution will match all the lids that start with lid. In other words, it acts like a glob of foobar*. It behavesn this way from first character to the last note: simple sorting of the lidvid is being done to select the latest from the end of the list. However, the versions 1.0, 2.0, and 13.0 will sort to 1.0, 13.0, and 2.0 so the end of the list may not be the latest. (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)
      limit - syntax: limit=10 behavior: maximum number of matching results returned, for pagination (optional, default to 100)
      sort - syntax: sort=asc(field0),desc(field1),... behavior: is this implemented? (optional)
      start - syntax: start=12 behavior: offset in matching result list, for pagination (optional, default to 0)
      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)

    • bundlesLidvidCollectionsAll

      @RequestMapping(method=GET, value="/bundles/{identifier}/collections/all", 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> bundlesLidvidCollectionsAll(@PathVariable("identifier") String identifier, @Valid @RequestParam(value="fields",required=false) @Valid List<String> fields, @Min(0L) @Valid @RequestParam(value="limit",required=false,defaultValue="100") @Min(0L) @Valid Integer limit, @Valid @RequestParam(value="sort",required=false) @Valid List<String> sort, @Min(0L) @Valid @RequestParam(value="start",required=false,defaultValue="0") @Min(0L) @Valid Integer start)
      GET /bundles/{identifier}/collections/all : deprecated
      Parameters:
      identifier - syntax: lidvid or lid behavior (lid): returns one or more items whose lid matches this lid exactly. If the endpoint ends with the identifier or /latest then a signle result is returned and it is the highest version. If the endpoint ends with /all then all versions of the lid are returned. behavior (lidvid): returns one and only one item whose lidvid matches this lidvid exactly. note: the current lid/lidvid resolution will match all the lids that start with lid. In other words, it acts like a glob of foobar*. It behavesn this way from first character to the last note: simple sorting of the lidvid is being done to select the latest from the end of the list. However, the versions 1.0, 2.0, and 13.0 will sort to 1.0, 13.0, and 2.0 so the end of the list may not be the latest. (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)
      limit - syntax: limit=10 behavior: maximum number of matching results returned, for pagination (optional, default to 100)
      sort - syntax: sort=asc(field0),desc(field1),... behavior: is this implemented? (optional)
      start - syntax: start=12 behavior: offset in matching result list, for pagination (optional, default to 0)
      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)

    • bundlesLidvidCollectionsLatest

      @RequestMapping(method=GET, value="/bundles/{identifier}/collections/latest", 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> bundlesLidvidCollectionsLatest(@PathVariable("identifier") String identifier, @Valid @RequestParam(value="fields",required=false) @Valid List<String> fields, @Min(0L) @Valid @RequestParam(value="limit",required=false,defaultValue="100") @Min(0L) @Valid Integer limit, @Valid @RequestParam(value="sort",required=false) @Valid List<String> sort, @Min(0L) @Valid @RequestParam(value="start",required=false,defaultValue="0") @Min(0L) @Valid Integer start)
      GET /bundles/{identifier}/collections/latest : deprecated
      Parameters:
      identifier - syntax: lidvid or lid behavior (lid): returns one or more items whose lid matches this lid exactly. If the endpoint ends with the identifier or /latest then a signle result is returned and it is the highest version. If the endpoint ends with /all then all versions of the lid are returned. behavior (lidvid): returns one and only one item whose lidvid matches this lidvid exactly. note: the current lid/lidvid resolution will match all the lids that start with lid. In other words, it acts like a glob of foobar*. It behavesn this way from first character to the last note: simple sorting of the lidvid is being done to select the latest from the end of the list. However, the versions 1.0, 2.0, and 13.0 will sort to 1.0, 13.0, and 2.0 so the end of the list may not be the latest. (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)
      limit - syntax: limit=10 behavior: maximum number of matching results returned, for pagination (optional, default to 100)
      sort - syntax: sort=asc(field0),desc(field1),... behavior: is this implemented? (optional)
      start - syntax: start=12 behavior: offset in matching result list, for pagination (optional, default to 0)
      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)

    • bundlesLidvidLatest

      @RequestMapping(method=GET, value="/bundles/{identifier}/latest", 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> bundlesLidvidLatest(@PathVariable("identifier") String identifier, @Valid @RequestParam(value="fields",required=false) @Valid List<String> fields)
      GET /bundles/{identifier}/latest : deprecated
      Parameters:
      identifier - syntax: lidvid or lid behavior (lid): returns one or more items whose lid matches this lid exactly. If the endpoint ends with the identifier or /latest then a signle result is returned and it is the highest version. If the endpoint ends with /all then all versions of the lid are returned. behavior (lidvid): returns one and only one item whose lidvid matches this lidvid exactly. note: the current lid/lidvid resolution will match all the lids that start with lid. In other words, it acts like a glob of foobar*. It behavesn this way from first character to the last note: simple sorting of the lidvid is being done to select the latest from the end of the list. However, the versions 1.0, 2.0, and 13.0 will sort to 1.0, 13.0, and 2.0 so the end of the list may not be the latest. (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)
      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)

    • bundlesLidvidProducts

      @RequestMapping(method=GET, value="/bundles/{identifier}/products", 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> bundlesLidvidProducts(@PathVariable("identifier") String identifier, @Valid @RequestParam(value="fields",required=false) @Valid List<String> fields, @Min(0L) @Valid @RequestParam(value="limit",required=false,defaultValue="100") @Min(0L) @Valid Integer limit, @Valid @RequestParam(value="sort",required=false) @Valid List<String> sort, @Min(0L) @Valid @RequestParam(value="start",required=false,defaultValue="0") @Min(0L) @Valid Integer start)
      GET /bundles/{identifier}/products : deprecated
      Parameters:
      identifier - syntax: lidvid or lid behavior (lid): returns one or more items whose lid matches this lid exactly. If the endpoint ends with the identifier or /latest then a signle result is returned and it is the highest version. If the endpoint ends with /all then all versions of the lid are returned. behavior (lidvid): returns one and only one item whose lidvid matches this lidvid exactly. note: the current lid/lidvid resolution will match all the lids that start with lid. In other words, it acts like a glob of foobar*. It behavesn this way from first character to the last note: simple sorting of the lidvid is being done to select the latest from the end of the list. However, the versions 1.0, 2.0, and 13.0 will sort to 1.0, 13.0, and 2.0 so the end of the list may not be the latest. (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)
      limit - syntax: limit=10 behavior: maximum number of matching results returned, for pagination (optional, default to 100)
      sort - syntax: sort=asc(field0),desc(field1),... behavior: is this implemented? (optional)
      start - syntax: start=12 behavior: offset in matching result list, for pagination (optional, default to 0)
      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)