Pretty cool - another interesting use case for this could be to provide more information to monitoring tools that support monitoring third-party APIs (e.g like https://supergood.ai/ or my own https://www.bitstreamapis.com)
This is interesting.. with the Arazzo spec now available, I am not sure I see the point though. I'd rather keep individual "services" (APIs) in separate files, and use something like Arazzo to import the different APIs and then benefit from the workflows/steps sequencing to show how a given set of endpoints across one or more APIs works. Of course there are no tools yet that are mature with Arazzo but there are many in the works.
What would be a reason to do this with an OpenAPI doc vs using a few of them to separate services where you could have the same path name in each separate file (e.g. /users showing up in two or more separate API docs) and using Arazzo?
"What would be a reason to do this with an OpenAPI doc vs using a few of them to separate services where you could have the same path name in each separate file:" there's no particular reason. Your approach is also a good one. I simply wanted to show what's possible with a single OpenAPI document.
Pretty cool - another interesting use case for this could be to provide more information to monitoring tools that support monitoring third-party APIs (e.g like https://supergood.ai/ or my own https://www.bitstreamapis.com)
I do use a similar approach, also to add strong typing to the OAS. This way, I counter the "Unsafe Consumption of APIs" vulnerability.
This is interesting.. with the Arazzo spec now available, I am not sure I see the point though. I'd rather keep individual "services" (APIs) in separate files, and use something like Arazzo to import the different APIs and then benefit from the workflows/steps sequencing to show how a given set of endpoints across one or more APIs works. Of course there are no tools yet that are mature with Arazzo but there are many in the works.
What would be a reason to do this with an OpenAPI doc vs using a few of them to separate services where you could have the same path name in each separate file (e.g. /users showing up in two or more separate API docs) and using Arazzo?
Good points!
"What would be a reason to do this with an OpenAPI doc vs using a few of them to separate services where you could have the same path name in each separate file:" there's no particular reason. Your approach is also a good one. I simply wanted to show what's possible with a single OpenAPI document.