search

nasa / utm-apis

The collection of APIs for NASA's UTM project in the form of OpenAPI documents.
55 stars 35 forks source link

Better define discovery_reference fields #161

Open jeremie-leproust opened 5 years ago

jeremie-leproust commented 5 years ago

https://github.com/nasa/utm-apis/blob/d2e432b1d075691b21db633e7b14f76597a9b3db/utm-domains/utm-domain-commons.yaml#L372-L385

Most common models include a discovery_reference field. In the last weeks, in the context of UTM exchanges for UPP in the Nevada test site, we faced multiple issues based on this field. Here is a short summary:

  1. The field is optional, which is problematic while using the standard discovery (as opposed to the grid discovery). Based on https://github.com/nasa/utm-apis/issues/132, my understanding is that this field has been left optional for now. If possible, I would recommend to make it required if it also makes sense for the grid discovery
  2. The documentation of the field only gives guidance for the grid discovery, but not for the standard discovery. I would recommend to make it clear that for a standard discovery, this field should be a UUID that contains the USS instance identifier.
  3. Some common models don't include this field like the UASVolumeReservation, which doesn't allow the USS to know which USS instance emitted a UVR. I would recommend to include this field in this model as well.