name: "Deploying To Dev Environment"

on:
  push:
    branches:
      - development

jobs:
  hello:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
        name: "Checkout Repository"
      - uses: tellihealth/gen-postman-documentation@1.0.3
        name: "Generate Postman Documentation - Users"
        with:
          api-key: ${{ secrets.POSTMAN_API_KEY }}
          collection: "Development"
          yml: "schema/users.yml"

folder: "Users"
description: A mock postman API documentation schema.
items:
  - name: "Create A New User"
    type: "request"
    url: "{{baseUrl}}/users"
    method: "POST"
    description: |
      Sign up a new user by providing the `name` and `type` of the user.
    body: { "name": "Test User", "type": "driver" }
    headers:
      - key: "Content-Type"
        value: "application/json"
      - key: "Authorization"
        value: "Bearer {{apiKey}}"
    responses:
      - name: "User Created"
        status: 201
        body: { "id": 3, "name": "Test User", type: "driver" }
  - name: "Settings"
    type: "folder"
    description: Manage user settings here.
    items:
      - name: "Update User"
        type: "request"
        url: "{{baseUrl}}/users/1"
        method: "PUT"
        description: |
          Update a user's information by using the `name` and `type` of the user.
        body: { "name": "Test User 2", "type": "passenger" }
        headers:
          - key: "Content-Type"
            value: "application/json"
          - key: "Authorization"
            value: "Bearer {{apiKey}}"
        responses:
          - name: "User Updated"
            status: 200
            body: { "id": 1, "name": "Test User 2", type: "passenger" }
          - name: "User Not Found"
            status: 404
            body: { "error": "User Not Found" }