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

Is "OpenAPI profile" formally defined anywhere? #10

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

Is "OpenAPI profile" formally defined anywhere? #10

timburks opened this issue Dec 10, 2020 · 1 comment

Comments

@timburks
Copy link
Contributor

From the introduction of the spec: "SLA4OAI builds on top of the OpenAPI Specification to add an optional profile for defining SLA (Service Level Agreements) over the APIs."

Reading this, I thought that the phrase "optional profile" might refer to a formal (or at least documented) definition of "profile" within OpenAPI, but I haven't been able to find such a definition anywhere. A more commonly-used term might be "specification extension".

Thus the sentence that I quoted might be revised to: "SLA4OAI builds on the OpenAPI specification by defining a specification extension that describes Service Level Agreements (SLAs) for APIs."

pafmon added a commit that referenced this issue Dec 14, 2020
@pafmon
Copy link
Contributor

pafmon commented Dec 14, 2020

Good point Tim, I do agree with your proposal; I have already created a P/R (#11) with your rewording so we can discuss/accept it on the next TC meeting.

pjmolina added a commit that referenced this issue Dec 17, 2020
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

3 participants