OpenAPI data archive format?

[unilynx]

I have an OpenAPI for which i periodically make a full snapshot of the data. I would like to store/offer this data in a standard format, eg a zip file containing the spec, all API responses grouped into JSON files an an index teling which URLs are in which file

For the web we have WARC but has anything like that ever been proposed for the data hosted by an OpenAPI service?

I know it's trivially to build something myself, but especially with an archive format it would be nice to have independent tooling to verify the implementation, eg to be able to run simulated fetch-es against the archive and then comparing with the real-time version

[handrews]

@unilynx are you talking about archiving your API's contents? What role would OpenAPI play in this?

[unilynx]

Yes, the contents

I'm not sure if it's within OpenAPI's scope, but other OpenAPI users might have the similar requirements (Eg. think governmental archiving laws, archive.org like things?).

WARC for HTML sites plus assets has standard solutions to create, verify and browse archives. I'm looking for similar (de-facto) standard solutions for archiving an API before potentially reinventing the entire wheel

In this case I have an API with educational data. I'm already archiving it (collecting all responses in a big JSON file keyed by URL, adding the relevant openapi specification) and I can give that archive to someone else and he can manually work with this huge JSON file, but he can't point a SwaggerUI at it, or verify the file's self consistency.

(well at least a JSON file won't be as hard to parse 50 years from now as a Word 5 DOC file would be)

[handrews]

@unilynx yeah I'm afraid this is out of scope for this project, or at least for the core OpenAPI Specification itself. It could be a companion specification of some sort under the OpenAPI Initiative umbrella, but you'd need to recruit a working group of enough interested people to build such a spec. We can't take it on within our current working groups.

[handrews]

If you are interested in trying to charter a working group, please join our slack (there's an invite link on www.openapis.org under "participate") as that is where such things are discussed.