Update existing v1.1.0 X-Ray fluorescence (XRF) schema
As an OSDU data definitions member, I want the content schemas to be updated, published, and visible to the OSDU platform and forum. Acceptance criteria: Integration test in the gitlab trusted branch passed
The schema needs to be multi-company reviewed in the forum to incorporate possible changes to the attributes and reference lists. Once it's approved by the forum the tech team will update and test the corresponding json file.
Dependencies before start the development :
| Task | Status (Y / N) |
|---|---|
| Proposal document revised | Y |
| Multi – company review | Y |
| OSDU Forum approval | Y |
Update 14 May 2025 - Multi-company review completed. Proposal doc and associated reference lists are posted https://gitlab.opengroup.org/osdu/subcommittees/data-def/projects/Petrophysics/home/-/issues/105
Acceptance criteria:
| Number | Description |
|---|---|
| POST TEST CASES | |
| 1 | Submit a valid JSON file and verify that the data is correctly stored and the response includes success message. |
| 2 | Submit a JSON file with missing required fields and verify that the API returns a 400 Bad Request error |
| 3 | Submit a JSON file with incorrect data types and verify that the API returns a 400 Bad Request error. |
| 4 | Check that the data is serialized into the correct format (e.g., Parquet) and stored in the BLOB store. |
| GET TEST CASES | |
| 1 | Search by a valid SamplesAnalysisID ID and verify that the correct data is returned. |
| 2 | Search by an invalid SamplesAnalysisID ID and verify that the API returns a 404 Not Found error. |
Definition of Done:
| Description | Completed |
|---|---|
| Get public examples for each content schema | |
| Json file has been updated | |
| Example file has been updated | |
| Model file has been updated | |
| Test file has been updated (real data / dummy data | |
| Integration test in the gitlab trusted branch passed | |
| Post data end point in the deployed RAFS instance | |
| Documentation has been updated | |
| Content schema is consistent with other existing RAFS DDMS content schemas. | |
| An example of new content schema in the Postman collection has been created. |
ASSUMPTIONS
The approval from the Forum indicates that all the changes to the attributes and reference lists were reviewed and approved.
You can access the currently published json file here:
Link to the updated proposal spreadsheet:
The forum observations and agreements can be read here:
Petrophysics Backlog Issue: https://gitlab.opengroup.org/osdu/subcommittees/data-def/projects/Petrophysics/home/-/issues/105