Create GET Schema Method for Reservoir Simulation Rock Physics Model CONTENT SCHEMA
As an OSDU data definitions member, I want the GET Schema method to be created to support the Reservoir Simulation Rock Physics Model Content Schema. The method must fetch the record and throw the corresponding messages,(Check AC section).
Dependencies before start the development :
| Task | Status (Y / N) |
|---|---|
| Proposal document revised | Y |
| Multi – company review | Y |
| OSDU Forum approval | Y |
Acceptance criteria:
| AC | Completed |
|---|---|
| Returns 200 and JSON Schema for Valid analysistype and Version. Given a valid analysistype and a valid content_schema_version. When I send a GET request to /mytype/data/schema with header Accept: application/json;version=1.0.0. Then the response status code is 200 OK and the response body contains a valid JSON schema for that type and version. Example Request: GET /mytype/data/schema Accept: application/json;version=1.0.0 Example Response: json { "title": "MyType Schema", "type": "object", "properties": { ... } } |
|
| Returns 404 for Invalid analysistype or Version Given an invalid analysistype or a version that does not exist. When I send a GET request to /notype/data/schema with header Accept: application/json;version=9.9.9 Then the response status code is 404 Not Found And the response body contains a message indicating the schema was not found. Example Request: GET /notype/data/schema Accept: Application/json;version=9.9.9 Example Response: json { "message": "Schema not found for notype and version 9.9.9" } |
|
| Accept Header is Required for Version Selection Given a valid analysistype When I send a GET request to /mytype/data/schema without the Accept header specifying a version Then the response status code is 404 Not Found And the response body contains a message indicating the schema was not found. |
|
| Response Model is Always JSON Given any request to the endpoint When I send a GET request Then the response content type is application/json. |
|
End point:
/api/rafs-ddms/v2/reservoir_simulation_rock_physics_model/data/schema
SCHEMA and reference links
JSON example:
Source Data Sample:
Edited by Raul Isunza