search

faa-swim / sdcm

Issues tracking for Service Description Conceptural Model
1 stars 0 forks source link

Resource #14

Open mkaplun opened 1 year ago

mkaplun commented 1 year ago

This issue continues the discussion about the Resource class that started at one of the off-line Governance meetings.

The most discussed point was whether to have an 'id' attribute similar to most SDCM classes. But it was also argued that the attribute 'path' could be used because it uniquely identifies a resource. According to OpenAPI,

Path holds the relative paths to the individual endpoints and their operations. The path is appended to the URL from the Server Object in order to construct the full URL.

It is important to notice that 'path' is represented by a relative URI, which means that multiple resources may have the same paths.

For example:

A resource offered by development and operational services may have the same URI. Two resources, one is GETed, and another DELETEed may also have the same relative URI/URL, which raises the question of whether absolute URI can/should be used in SDCM.

Note: for the purpose of this discussion, we assume that an absolute URI provides a "physical" address to the resource, while the relative is a part of a URI that doesn't include a protocol (http) and server address.

Note: An absolute URI may also be described as one of the service endpoints and, therefore, can be presented in the Ground package.

caroluri commented 1 year ago

An individual resource will have a unique identifier (an httpURI in our case); however, copies of it can exist at different locations (URL).