LiveRamp / reslang

A language for describing resource-oriented APIs & turning them into Swagger or resource diagrams. Oriented around the concepts we want to expose in the APIs.
Apache License 2.0
23 stars 7 forks source link

Set the summary field for a given API path #204

Closed nhtzr closed 2 years ago

nhtzr commented 3 years ago

As part of the developer portal effort, teams are being asked to add a summary to the OpenAPI specs so that the sidebar navigation in readme is easier to read in swagger ui

Currently if you put a string description above the operation in reslang it gets mapped to description in the OpenAPI spec

"A LiveRamp partner that can receive data"
subresource v2/Destination {
  id: string
'/v2/destinations/{id}':
    get:
      operationId: Get v2/Destination
      description: 'Fetch a single Destination'              <== Comment goes into description
      responses:
        ...

See discussion at: https://liveramp.slack.com/archives/CPBAEKS9X/p1630612353029400