Skip to main content

Spec

What is a Spec House?

A Spec House is the repository where you store the specs of your OpenAPI to have access to them on your DevPortal. We recommend, for each project, you create a new Spec House.

Publishing your GitHub Spec House

To publish directly your Spec House you need first have a repository on GitHub with an active branch, after creating that repository open your bash and run this command:

safira-cli spec publish
  1. We ask you to put your Spec House repository by using your GitHub username as the owner and your repository name as the project (owner/project)

  2. What branch do you want publish your specs from.

  3. If you want to mock your specs or not.

Setting your GitHub Spec House

To setup your Spec House you need first have a repository on GitHub with an active branch, after creating that repository open your bash and run this command:

safira-cli spec configure
  1. On the first question you should put the branch you want the pipeline to be in.

  2. We ask you to put your Spec House repository by using your GitHub username as the owner and your repository name as the project (owner/project)

  3. What branch do you want publish your specs from.

  4. If you want to mock your specs or not.

⚠️ On the first time using safira-cli spec publish or safira-cli spec configure you will also need your GitHub token.

  1. After you setup your DevPortal and Spec House, your specs should show up on your catalog.