Get Formal API Contract Description Provides documentation for each API request in an easy-to-parse format. Requests Syntax GET http[s]://{datapathDNSname}/_rest_/request_handler_contract/ Responses Response Elements This operation lists all request handlers supported by the Spectra S3 API. The following information is given for each request handler: Request § Name of call § Request classification: amazons3, spectrads3, or internal § Path including path parameters and their types § Query parameters specifying if the parameter is required or optional, and types (string, integer, etc.) § HTTP verb (PUT, GET, etc.) § List of optional request headers, for example, range or metadata § Description of the payload if there is one Response § Expected status codes Note: The expected status are NOT exhaustive, nor are the response payload types. § What the payload is for a specific status code § What query parameters modify the payload § Description of payload if there is one § Request handler version Example Sample Request This request gets easily parsed documentation for each Spectra S3 API request. GET http://blackpearl-hostname/_rest_/request_handler_contract/ HTTP/1.1 Sample Response <Data> <Contract> <RequestHandlers> <RequestHandler Classification="amazons3" Name="com.spectralogic.s3.server.handler.reqhandler. amazons3.AbortMultiPartUploadRequestHandler"> <Request BucketRequirement="REQUIRED" HttpVerb="DELETE" ObjectRequirement="REQUIRED"> <OptionalQueryParams/> <RequiredQueryParams> <Param Name="UploadId" Type="java.util.UUID"/> </RequiredQueryParams> </Request> <ResponseCodes> <ResponseCode> <Code>204</Code> <ResponseTypes> <ResponseType Type="null"/> </ResponseTypes> </ResponseCode> </ResponseCodes> </RequestHandler> ... </RequestHandlers> </Contract> </Data>
