search

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

Incorporate securitySchemes #111

Open conrs opened 4 years ago

conrs commented 4 years ago

e.g.

security:
  - LROrgId: []
  - BearerToken: []

components:
  parameters: {}
  securitySchemes:
    LROrgId:
      type: apiKey
      in: header
      name: LR-Org-Id
    BearerToken:
      type: http
      scheme: bearer

Useful to call out and the above are the standard auth and org ID specifications.

sirishalal commented 3 years ago

Does anyone know what is it we are asking to be done here?

forestgagnon commented 3 years ago

this is partially resolved by https://github.com/LiveRamp/reslang/issues/159, but it might not be surfaced as well in the api doc renderer as using the a semantic openapi field like securitySchemes. Not sure. Seems low priority now that we have arbitrary HTTP header support.

njaczko commented 3 years ago

It's also mostly duplicative of https://github.com/LiveRamp/reslang/issues/21 (which we closed because it was partially resolved by https://github.com/LiveRamp/reslang/issues/159)