oasis-open / odata-rapid

Rapid - Specification, tools and libraries to support the development and adoption of simple REST-based APIs.
https://rapid.rocks
Apache License 2.0
17 stars 8 forks source link

RAPID API designer visualization association link issues #363

Open GEricson opened 2 years ago

GEricson commented 2 years ago

Comments on association links shown RSDL API designer. Using this RSDL.

type Company
{
    key stockSymbol: String
    name: String
    incorporated: DateTime
    employees: [Employee]
}

type Employee
{
    key id: Integer 
    firstName : String?
    lastName : String?
    title: String?
    **worksAt: [Company]?**
}

service
{
    competitors: [Company]
    company: Company
}
  1. Association end is shown in middle of link. It should be near the referenced resource.
  2. Association name is generally shown in the middle of the link. UML default name is 'A_resource1_resource2'.
  3. Composition and Aggregation symbols should be shown near the aggregating resource. Currently the opposite.
  4. Use of Composition. If the resource can exist independently, then Aggregation is #better.
  5. Add the CSDL partner capability. This will simplify visualization by using one link instead of two.
  6. Add Multiplicity adornments. UML default multiplicity is 1..1 (or just 1), and 1..* for collections.
  7. Optional associations are 0..1 or 0..* for collections.