swagger-example.json

{
    "swagger": "2.0",
    "info": {
      "description": "This is an example BFF service for the Contact Picker Smart Widget",
      "version": "1.0.0",
      "title": "Contact Picker BFF",
      "contact": {
        "email": "joeri.sebrechts@digipolis.be"
      },
      "license": {
        "name": "MIT"
      }
    },
    "host": "localhost:3000",
    "basePath": "/api",
    "schemes": [
      "http"
    ],
    "paths": {
      "/medewerkers": {
        "get": {
          "summary": "Return the matching contacts from mprofiel",
          "description": "Search is performed by first or last name, combining the results.",
          "operationId": "listMedewerkers",
          "produces": [
            "application/json"
          ],
          "parameters": [
            {
              "name": "search",
              "in": "query",
              "description": "The search string to match contacts by",
              "required": true,
              "type": "string"
            }
          ],
          "responses": {
            "200": {
              "description": "successful operation",
              "schema": {
                "$ref": "#/definitions/Contacts"
              }
            }
          }
        }
      }
    },
    "definitions": {
      "Contact": {
        "required": [
          "id",
          "name"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "firstName": {
            "type": "string"
          },
          "lastName": {
            "type": "string"
          },
          "userName": {
            "type": "string",
            "description": "The login id of this user"
          },
          "email": {
            "type": "string"
          },
          "domain": {
            "type": "string",
            "description": "The AD domain that the user belongs to"
          },
          "avatarUrl": {
            "type": "string"
          }
        }
      },
      "Contacts": {
        "type": "array",
        "items": {
          "$ref": "#/definitions/Contact"
        }
      }
    }
  }