Class ClientYamlSuiteRestApi

java.lang.Object
org.opensearch.test.rest.yaml.restspec.ClientYamlSuiteRestApi
public class ClientYamlSuiteRestApi extends Object
Specification of an OpenSearch endpoint used by the YAML specs to generate REST requests.

  • Method Details

    • getName

      public String getName()

    • getLocation

      public String getLocation()

    • getPaths

      public Collection<ClientYamlSuiteRestApi.Path> getPaths()

    • getParams

      public Map<String,Boolean> getParams()
      Gets all parameters supported by the api. For every parameter defines if it is required or optional.

    • isBodySupported

      public boolean isBodySupported()

    • isBodyRequired

      public boolean isBodyRequired()

    • setStability

      public void setStability(String stability)

    • getStability

      public ClientYamlSuiteRestApi.Stability getStability()

    • getBestMatchingPaths

      public List<ClientYamlSuiteRestApi.Path> getBestMatchingPaths(Set<String> params)
      Returns the best matching paths based on the provided parameters, which may include either path parts or query_string parameters. The best path is the one that has exactly the same number of placeholders to replace (e.g. /{index}/{type}/{id} when the path params are exactly index, type and id). It returns a list instead of a single path as there are cases where there is more than one best matching path: - /{index}/_alias/{name}, /{index}/_aliases/{name} - /{index}/{type}/_mapping, /{index}/{type}/_mappings, /{index}/_mappings/{type}, /{index}/_mapping/{type}