Your progress is saved locally. to save it permanently.

Connect your Postman API key to validate exercisesSettings →
0 of 3 steps0%

Spec Hub can derive an OpenAPI document from the collection you already built. First switch to the Git branch where your collection lives — then generate the spec in Local View so Postman writes files under postman/specs/.

1

Switch to the Branch with Your Collection

In the Native Git module you pushed Deskly API to feature/deskly-collection. Local View only shows collections for the branch currently checked out in your connected folder — if the bottom-left branch reads main, the collection won't be in the sidebar yet.

  1. Open the Postman desktop app and switch to your [Your name] - Native Git workspace.

  2. Confirm Local View is on and your deskly-api folder is still connected. The branch name shows in the bottom left (e.g. main or feature/deskly-collection).

  3. If you're not on feature/deskly-collection, open the Postman terminal and run:

    git fetch origin
git checkout feature/deskly-collection

  4. Confirm the bottom-left branch name updates to feature/deskly-collection.

  5. In the left sidebar, expand Local Items → Collections — Deskly API should appear.

Troubleshooting

  • checkout fails — run git branch -a and use the feature/ branch name you pushed in the Native Git module.
  • Collection still missing — re-run Part 1 Step 2 to confirm that branch exists on your GitHub fork, then try git pull origin feature/deskly-collection.
2

Generate a Specification from the Deskly API Collection

With the right branch checked out, generate a single-file OpenAPI 3 spec linked to your collection.

  1. Select Deskly API under Local Items → Collections.
  2. Click View more actions (⋯) next to the collection name, then choose More → Generate specification.
  3. On the form:
    • Name: Deskly API
    • Format: YAML
  4. Click Generate Specification.

Expected outcome: Deskly API appears under Specs in the sidebar, and the collection's Overview tab shows the linked specification.

Troubleshooting: If Generate specification is greyed out, you may already have a spec linked — expand Specs, open it, or delete the old one and try again. You can only generate one spec per collection.

3

Inspect the Spec Files in Your Repo

Before you push, confirm Native Git wrote the spec to disk. You'll commit these files in Part 3.

  1. In the left sidebar, click Files to open the file tree for your connected repo.
  2. Expand postman/specs/ — you should see a folder for Deskly API containing at least one .yaml file (often the root OpenAPI file).
  3. Open the YAML file and skim the top — it should start with openapi: 3. and list paths such as /health and /desks.

Expected outcome: The spec lives under postman/specs/ next to your collection under postman/collections/, both versioned in the same repo.

← Part 1: Confirm Your Deskly SetupPart 3: Push the Spec to GitHub →