QC/Validate existing metadata with SMDA

[mferrera]

We need a route that ensures the data configured in config.json is valid compared to the data in SMDA.

This should perhaps be a separate route paths, lint/ or validate/, as other forms or more granular linting may be possible in the future. Perhaps on a resource basis.

But, some fields have extra dependencies, such as the rms: field which requires accessing the RMS project from an opened RMS instance via rmsapi.

[GibranAlfa]

this should probably be in datamodels, but putting in here for validation discussion:

1. possibility to add field that is not in SMDA, like exploration field. in this case, maybe the field uuid is optional?
2. brazilian fields do not have coordinate system today, so maybe we should optionally allow None for CS?
3. should we allow multiple countries? today it's allowed but not sure about the use case (should probably support this for a field that exists in multiple countries)

some ideas from planning meeting for supporting unofficial field:

• create a new class for masterdata (e.g. unofficial_data) for unofficial field, and put empty/dummy values in Smda class for field because the field does not exist in SMDA
• or just edit the current field in Smda class by adding official flag (we prefer this solution)

class Smda(BaseModel):
    """The ``masterdata.smda`` block contains SMDA-related attributes."""

    coordinate_system: CoordinateSystem
    """Reference to coordinate system known to SMDA.
    See :class:`CoordinateSystem`."""

    country: list[CountryItem]
    """A list referring to countries known to SMDA. First item is primary.
    See :class:`CountryItem`."""

    discovery: list[DiscoveryItem]
    """A list referring to discoveries known to SMDA. First item is primary.
    See :class:`DiscoveryItem`."""

    field: list[FieldItem]
    """A list referring to fields known to SMDA. First item is primary.
    See :class:`FieldItem`."""

    stratigraphic_column: StratigraphicColumn
    """Reference to stratigraphic column known to SMDA.
    See :class:`StratigraphicColumn`."""

class FieldItem(BaseModel):
    """A single field in the ``masterdata.smda.field`` list of fields
    known to SMDA."""

    identifier: str = Field(examples=["OseFax"])
    """Identifier known to SMDA."""

    uuid: UUID | None = None
    """UUID known to SMDA."""

    official: bool = True
    """Whether the field exists in SMDA.""""

and possibly for discovery as well.

some other notes:

• maybe we should connect country to field? -> Discussed and concluded that we won't store a fields's connection to a country
• should add a requirement for country to be at least one.

---

we decided on the second option to support unofficial field, not enough time to discuss about brazilian field

---

Action item:

• update this in datamodels (probably another refinement and discussion for optional coordinate system before merging it)
• need endpoints in fmu-settings-api to search for countries and stratigraphy columns directly, not through aggregated result from POST /smda/masterdata

[slangeveld]

Conclusions from planning meeting 18.02

• Add a new field official to class FieldItem (see discussion above).
• Add a requirement to both field and country in class Smda that the number of items needs to be at least one.

[GibranAlfa]

related issue:

• Support unofficial field in FieldItem in Smda fmu-datamodels#158
• Add endpoints to search for country and stratigraphic column from SMDA #298