Docs 10035 develop compat matrix prototype oas3 pa--DON'T CLOSE #94
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jstoiko
suggested changes
Mar 4, 2021
There was a problem hiding this comment.
I did a first pass. I'd suggest to go through my initial set of suggestions, replace all the ? with written descriptions based on either (or both) the corresponding descriptions in the RAML 1.0 spec or the OAS 3.0 spec and take it from there. I can then do one more pass and I would suggest we also ask each individual team to review and approve what's written in their product's column. Hope that makes sense.
…ttps://github.com/mulesoft/docs-general into DOCS-10035-develop-compat-matrix-prototype-oas3-PA
priyaayyar
commented
Jul 7, 2021
| endif::[] | ||
| :keywords: api, instance, manager | ||
|
|
||
| You can implement your API specification in a way that best suits your needs. The following table explains how each of the features of the API specification is best implemented and the level of support provided for the specification in API Designer. |
There was a problem hiding this comment.
Suggested change
| You can implement your API specification in a way that best suits your needs. The following table explains how each of the features of the API specification is best implemented and the level of support provided for the specification in API Designer. | |
| You can implement your API specification in a way that best suits your needs. The following table explains how each of the features of the API specification is best implemented and the level of support provided for the specification in Anypoint Exchange. |
| |=== | ||
| | Feature: Description| RAML Implementation | OAS Implementation | Exchange Support | ||
| 4+| *Modularity:* The ability to break an API specification into reusable and shared units. | ||
| | API Document: The main API specification description metadata, which is the entry point for the specification. | RAML root document | OAS root document | Allows publication and versioning of an API asset in Exchange console rendering. |
There was a problem hiding this comment.
Suggested change
| | API Document: The main API specification description metadata, which is the entry point for the specification. | RAML root document | OAS root document | Allows publication and versioning of an API asset in Exchange console rendering. | |
| | API Document: The main API specification description metadata, which is the entry point for the specification. | RAML root document | OAS root document | Allows publication and versioning of an API asset in Exchange console rendering. Additionally, advanced search is supported. |
| | Feature: Description| RAML Implementation | OAS Implementation | Exchange Support | ||
| 4+| *Modularity:* The ability to break an API specification into reusable and shared units. | ||
| | API Document: The main API specification description metadata, which is the entry point for the specification. | RAML root document | OAS root document | Allows publication and versioning of an API asset in Exchange console rendering. | ||
| | Libraries: The unit containing collections of related reusable description elements. | RAML library | Can be implemented using an empty OAS specification containing multiple components. | Allows publication of a RAML API fragment asset. |
There was a problem hiding this comment.
Suggested change
| | Libraries: The unit containing collections of related reusable description elements. | RAML library | Can be implemented using an empty OAS specification containing multiple components. | Allows publication of a RAML API fragment asset. | |
| | Libraries: The unit containing collections of related reusable description elements. | RAML library | Can be implemented using an empty OAS specification containing multiple components. | Allows publication of a RAML API fragment asset (only RAML). No console or advanced search is supported. |
| 4+| *Modularity:* The ability to break an API specification into reusable and shared units. | ||
| | API Document: The main API specification description metadata, which is the entry point for the specification. | RAML root document | OAS root document | Allows publication and versioning of an API asset in Exchange console rendering. | ||
| | Libraries: The unit containing collections of related reusable description elements. | RAML library | Can be implemented using an empty OAS specification containing multiple components. | Allows publication of a RAML API fragment asset. | ||
| | Fragments: Stand-alone component of the specification that describes a specific element. | RAML fragment | Can be implemented using an empty OAS specification containing a single component.| Allows publication of a RAML API fragment asset. |
| | API Document: The main API specification description metadata, which is the entry point for the specification. | RAML root document | OAS root document | Allows publication and versioning of an API asset in Exchange console rendering. | ||
| | Libraries: The unit containing collections of related reusable description elements. | RAML library | Can be implemented using an empty OAS specification containing multiple components. | Allows publication of a RAML API fragment asset. | ||
| | Fragments: Stand-alone component of the specification that describes a specific element. | RAML fragment | Can be implemented using an empty OAS specification containing a single component.| Allows publication of a RAML API fragment asset. | ||
| | Overlays: A partial description of the API specification that you can use to overwrite non-functional aspects of the API specification by composing it with the original specification, for example, translating the documentation to other languages. | RAML overlay | Can be simulated with JSON patch or merge preprocessing. | Modified APIs can be published as an API asset. |
There was a problem hiding this comment.
Suggested change
| | Overlays: A partial description of the API specification that you can use to overwrite non-functional aspects of the API specification by composing it with the original specification, for example, translating the documentation to other languages. | RAML overlay | Can be simulated with JSON patch or merge preprocessing. | Modified APIs can be published as an API asset. | |
| | Overlays: A partial description of the API specification that you can use to overwrite non-functional aspects of the API specification by composing it with the original specification, for example, translating the documentation to other languages. | RAML overlay | Can be simulated with JSON patch or merge preprocessing. | Allows publishing modified APIs as an API asset. |
| | Libraries: The unit containing collections of related reusable description elements. | RAML library | Can be implemented using an empty OAS specification containing multiple components. | Allows publication of a RAML API fragment asset. | ||
| | Fragments: Stand-alone component of the specification that describes a specific element. | RAML fragment | Can be implemented using an empty OAS specification containing a single component.| Allows publication of a RAML API fragment asset. | ||
| | Overlays: A partial description of the API specification that you can use to overwrite non-functional aspects of the API specification by composing it with the original specification, for example, translating the documentation to other languages. | RAML overlay | Can be simulated with JSON patch or merge preprocessing. | Modified APIs can be published as an API asset. | ||
| | Extensions: A partial description of the API spec that can be used to overwrite non-functional aspects of the API spec composing it with the original specification, like for example adding the security information for a managed API | RAML extension | Can be simulated with JSON patch or merge preprocessing. | Modified APIs can be published as an API asset. |
valkyrie69
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.