APIs.json 0.17 Proposal

[kinlane]

I have posted a draft proposal for APIs.json 0.17 based upon the work we've been doing with APIs.io.

This release is primarily about adding:

• aid - A unique identifier at the collection and api levels.
• overlays - References to collection and api level overlays.

After that, I'd like to introduce a handful of property types:

• GettingStarted
• DeprecationPolicy
• GraphQLSchema
• Integrations
• PostmanWorkspace
• ServiceLevelAgreement
• Versioning
• Webhooks

These property types were identified profiling 75 APIs published to APIs.io.

You can see the latest version in use in the APIs.json Artisanal project:

• Stripe
• Twilio

Please share your thoughts and comments below, and let's keep iterating on the spec towards 1.0.

[kinlane]

I remember, I was going to add an OpenAI plugin manifest -- will update it! #78

[kinlane]

Adding from common by Robert Buchanan on LinkedIn - we should make aid a URN - https://www.issn.org/services/online-services/urn/

[ChristophWeber]

aid could also be DSN, Data Source Name, which in practice is quite similar to a URN when referencing internet resources. However, a DSN does not have the requirement to register a namespace with IANA or ISSN which I think no API owner will bother to do.

[kinlane]

Nice. Thank you @ChristophWeber -- adding into the mix to consider, and I think this gets closer than a URN.