person-api-application-json.json

{
  "openapi": "3.0.2",
  "info": {
    "title": "Person API",
    "version": "1.0.0",
    "contact": {
      "name": "DoIT Enterprise Integration API Team",
      "email": "api@doit.wisc.edu",
      "url": "https://go.wisc.edu/k701y6"
    },
    "description": "An API for interacting with person data at UW-Madison. Refer to the [Person API Documentation](/person-api) for more information about this API."
  },
  "servers": [
    {
      "url": "https://doit.dev.api.wisc.edu"
    }
  ],
  "security": [
    {
      "OAuth2ClientCredentials": []
    }
  ],
  "externalDocs": {
    "description": "Read more about JSON:API here",
    "url": "https://jsonapi.org/"
  },
  "paths": {
    "/people": {
      "get": {
        "description": "Get a collection of people.",
        "summary": "Get people.",
        "operationId": "get_people",
        "tags": [
          "people"
        ],
        "parameters": [
          {
            "name": "filter",
            "in": "query",
            "description": "Filter results of query using the [filter query parameter family](https://jsonapi.org/recommendations/#filtering). Refer to the [Person API Documentation](/person-api/filter-query-parameter) for more information about the `filter` query param.",
            "required": false,
            "style": "deepObject",
            "explode": true,
            "schema": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "attribute": {
                  "type": "string",
                  "example": "firstName"
                }
              }
            }
          },
          {
            "name": "fields",
            "in": "query",
            "description": "Specify the list of fields you would like to return for each resource type.  For example, `fields[people]=firstName,lastName` will just return the names for people.  If you are including related resources with 'includes' you can also specify fields on those resources as well.  For example, `includes=jobs&fields[people]=jobs&fields[jobs]=title` will just return titles for jobs.  See [Sparse Fieldsets](https://jsonapi.org/format/#fetching-sparse-fieldsets) for more details.",
            "required": false,
            "style": "deepObject",
            "explode": true,
            "schema": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "type": {
                  "type": "string",
                  "example": "people"
                }
              }