Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Requiring the "api" field in context object seems redundant and inhibits reuse. #9

Closed
timburks opened this issue Dec 10, 2020 · 1 comment

Comments

@timburks
Copy link
Contributor

Since the spec proposes using the x-sla field to link an SLA extension into an OpenAPI document, it seems unnecessary to also use the api field to link to the OpenAPI document from the Context Object in the SLA document. I think this would also prevent sharing of SLA documents among multiple APIs, because even if everything else was identical, different versions of the SLA document would need to exist for each referring API. Based on this, my general impression is that the api field should be eliminated, or at least made optional.

@pjmolina
Copy link
Contributor

Good point @timburks !
Thanks for taking the time to reflect on it.

We can discuss it in the next SIG meting and take a decision on that. You are more than invited to join if you can.

Also, feel free to make a PR if you have the time.

Make api attribute optional.

  • Why: redundant via x-sla linking mechanism.
  • Pros: allows SLA reuse to different APIs. (linked by x-sla ref)
  • Cons: lost bidirectional links.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants