Support the Readme API ID being set inside the OAS file #1066
behnam-oneschema
started this conversation in
Ideas
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
As we're migrating from manual docs updates to in-repo OAS files, we're having a bunch of job steps which have:
From what I see, it looks like there's no way to batch the updates for multiple files in a single command. (Is that correct?)
So, this made me wondering what could be the blockers for being able to have a single command to sync multiple files, and of course the
id
is a basic one. Now, there are multiple ways to maintain and pass a mapping of file paths/names to ids, but the simples way that comes to mind would be being able to set the readme.com object id of the category directly into the OAS file, similar to the existing extensions, e.g.x-readme-id: ID_FOR_CATEGORY_X
.Having that, supporting syncing of multiple OAS files in a single command seem to be more feasible.
What do y'all think about this?
Beta Was this translation helpful? Give feedback.
All reactions