Package gov.nasa.pds.api.base

Interface DocsApi

All Known Implementing Classes:

DocsApiController

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

Method Summary

Modifier and Type	Method	Description
default org.springframework.http.ResponseEntity<Object>	docs(@NotNull @Valid List<String> indices, @Valid String body)	POST /docs : WORK IN PROGRESS: search on all registry documents by posting an OpenSearch DSL query
default Optional<org.springframework.web.context.request.NativeWebRequest>	getRequest()

Method Details

getRequest

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

docs

@RequestMapping(method=POST,
                value="/docs",
                produces="*",
                consumes="application/json")
default org.springframework.http.ResponseEntity<Object> docs(@NotNull @Valid @RequestParam(value="indices",required=true)
 @NotNull @Valid List<String> indices,
 @Valid @RequestBody
 @Valid String body)
                                                      throws Exception

POST /docs : WORK IN PROGRESS: search on all registry documents by posting an OpenSearch DSL query

Parameters:

indices - syntax: indices=index1,index2... notes: OpenSearch indices (required)

body - OpenSearch DSL query (required)

Returns:

Successful request (status code 200)

Throws:

Exception