Warning

This method has been deprecated and is not recommended. See below for alternatives.

apiary.manifest file was an experiment to bring multi-file approach to API Blueprint. It has been deprecated in favor of other solutions.

There is no timeline yet to migrate customers currently using it, but it has been disabled for new API Projects using GitHub Sync or GitHub Integration.

How to replace apiary.manifest?

  • Hercule for document transclusion - use your CI or build system to build a transcluded API Blueprint and push this artifact into the Apiary. Then use Read-only API Project to prevent accidental overwrites.
  • MSON data structures will minimize the amount of repeating payloads in your API Description Document.

As always, if you have any questions or issues with apiary.manifest just let us know