starlette_jsonapi_client_example.postman_collection.json

{
	"info": {
		"_postman_id": "fe275b0d-87d9-418d-8ece-85e935aaa1c6",
		"name": "starlette_jsonapi_client_example",
		"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
	},
	"item": [
		{
			"name": "users",
			"item": [
				{
					"name": "/api/users/",
					"request": {
						"method": "GET",
						"header": [],
						"url": {
							"raw": "http://{{host}}/api/users/",
							"protocol": "http",
							"host": [
								"{{host}}"
							],
							"path": [
								"api",
								"users",
								""
							]
						}
					},
					"response": []
				},
				{
					"name": "/api/users/",
					"protocolProfileBehavior": {
						"disabledSystemHeaders": {
							"content-type": true
						}
					},
					"request": {
						"method": "POST",
						"header": [
							{
								"key": "Content-Type",
								"value": "application/vnd.api+json",
								"type": "text"
							}
						],
						"body": {
							"mode": "raw",
							"raw": "{\n    \"data\": {\n        \"type\": \"users\",\n        \"attributes\": {\n            \"username\": \"testy-mctestful\"\n        },\n        \"relationships\": {\n            \"organization\": {\n                \"data\": {\n                    \"type\": \"organizations\",\n                    \"id\": \"1\"\n                }\n            }\n        }\n    }\n}",
							"options": {
								"raw": {
									"language": "json"
								}
							}
						},
						"url": {
							"raw": "http://{{host}}/api/users/",
							"protocol": "http",
							"host": [
								"{{host}}"
							],
							"path": [
								"api",
								"users",
								""
							]
						}
					},
					"response": []
				},
				{
					"name": "/api/users/<id>",
					"request": {
						"method": "GET",
						"header": [],
						"url": {
							"raw": "http://{{host}}/api/users/1",
							"protocol": "http",
							"host": [
								"{{host}}"
							],
							"path": [
								"api",
								"users",
								"1"
							]
						}
					},
					"response": []
				},
				{
					"name": "/api/users/<id>/organization",
					"request": {
						"method": "GET",
						"header": [],
						"url": {
							"raw": "http://{{host}}/api/users/1/organization",
							"protocol": "http",
							"host": [
								"{{host}}"
							],
							"path": [
								"api",
								"users",
								"1",
								"organization"
							]
						}
					},
					"response": []
				},
				{
					"name": "/api/users/<id>?include=organization",
					"request": {
						"method": "GET",
						"header": [],
						"url": {
							"raw": "http://{{host}}/api/users/1?include=organization",
							"protocol": "http",
							"host": [
								"{{host}}"
							],
							"path": [
								"api",
								"users",
								"1"
							],
							"query": [
								{
									"key": "include",
									"value": "organization"
								}
							]
						}
					},
					"response": []
				},
				{
					"name": "/api/users/<id>",
					"protocolProfileBehavior": {
						"disabledSystemHeaders": {
							"content-type": true
						}
					},
					"request": {
						"method": "PATCH",
						"header": [
							{
								"key": "Content-Type",
								"value": "application/vnd.api+json",
								"type": "text"
							}
						],
						"body": {
							"mode": "raw",
							"raw": "{\n    \"data\": {\n        \"id\": \"1\",\n        \"type\": \"users\",\n        \"attributes\": {\n            \"username\": \"after-patch\"\n        }\n    }\n}"
						},
						"url": {
							"raw": "http://{{host}}/api/users/1",
							"protocol": "http",
							"host": [
								"{{host}}"
							],
							"path": [
								"api",
								"users",
								"1"
							]
						}
					},
					"response": []
				},
				{
					"name": "/api/users/<id>",
					"request": {
						"method": "DELETE",
						"header": [],
						"url": {
							"raw": "http://{{host}}/api/users/1",
							"protocol": "http",
							"host": [
								"{{host}}"
							],
							"path": [
								"api",
								"users",
								"1"
							]
						}
					},
					"response": []
				}
			],
			"protocolProfileBehavior": {}
		},
		{
			"name": "teams",
			"item": [
				{
					"name": "/api/teams/",
					"request": {
						"method": "GET",
						"header": [],
						"url": {
							"raw": "http://{{host}}/api/teams/",
							"protocol": "http",
							"host": [
								"{{host}}"
							],
							"path": [
								"api",
								"teams",
								""
							]
						}
					},
					"response": []
				},
				{
					"name": "/api/teams/?include=users",
					"request": {
						"method": "GET",
						"header": [],
						"url": {
							"raw": "http://{{host}}/api/teams/?include=users",
							"protocol": "http",
							"host": [
								"{{host}}"
							],
							"path": [
								"api",
								"teams",
								""
							],
							"query": [
								{
									"key": "include",
									"value": "users"
								}
							]
						}
					},
					"response": []
				},
				{
					"name": "/api/teams/",
					"protocolProfileBehavior": {
						"disabledSystemHeaders": {
							"content-type": true
						}
					},
					"request": {
						"method": "POST",
						"header": [
							{
								"key": "Content-Type",
								"type": "text",
								"value": "application/vnd.api+json"
							}
						],
						"body": {
							"mode": "raw",
							"raw": "{\n    \"data\": {\n        \"type\": \"teams\",\n        \"attributes\": {\n            \"name\": \"team-name\"\n        },\n        \"relationships\": {\n            \"users\": {\n                \"data\": [\n                    {\n                        \"type\": \"users\",\n                        \"id\": \"1\"\n                    }\n                ]\n            }\n        }\n    }\n}",
							"options": {
								"raw": {
									"language": "json"
								}
							}
						},
						"url": {
							"raw": "http://{{host}}/api/teams/",
							"protocol": "http",
							"host": [
								"{{host}}"
							],
							"path": [
								"api",
								"teams",
								""
							]
						}
					},
					"response": []
				},
				{
					"name": "/api/teams/<id>",
					"request": {
						"method": "GET",
						"header": [],
						"url": {
							"raw": "http://{{host}}/api/teams/1",
							"protocol": "http",
							"host": [
								"{{host}}"
							],
							"path": [
								"api",
								"teams",
								"1"
							]
						}
					},
					"response": []
				},
				{
					"name": "/api/teams/<id>/users",
					"request": {
						"method": "GET",
						"header": [],
						"url": {
							"raw": "http://{{host}}/api/teams/1/users",
							"protocol": "http",
							"host": [
								"{{host}}"
							],
							"path": [
								"api",
								"teams",
								"1",
								"users"
							]
						}
					},
					"response": []
				},
				{
					"name": "/api/teams/<id>?include=users",
					"request": {
						"method": "GET",
						"header": [],
						"url": {
							"raw": "http://{{host}}/api/teams/1?include=users",
							"protocol": "http",
							"host": [
								"{{host}}"
							],
							"path": [
								"api",
								"teams",
								"1"
							],
							"query": [
								{
									"key": "include",
									"value": "users"
								}
							]
						}
					},
					"response": []
				},
				{
					"name": "/api/teams/<id>?include=users,users.organization",
					"request": {
						"method": "GET",
						"header": [],
						"url": {
							"raw": "http://{{host}}/api/teams/1?include=users,users.organization",
							"protocol": "http",
							"host": [
								"{{host}}"
							],
							"path": [
								"api",
								"teams",
								"1"
							],
							"query": [
								{
									"key": "include",
									"value": "users,users.organization"
								}
							]
						}
					},
					"response": []
				},
				{
					"name": "/api/teams/<id>",
					"protocolProfileBehavior": {
						"disabledSystemHeaders": {
							"content-type": true
						}
					},
					"request": {
						"method": "PATCH",
						"header": [
							{
								"key": "Content-Type",
								"type": "text",
								"value": "application/vnd.api+json"
							}
						],
						"body": {
							"mode": "raw",
							"raw": "{\n    \"data\": {\n        \"type\": \"teams\",\n        \"attributes\": {\n            \"name\": \"after-patch\"\n        },\n        \"relationships\": {\n            \"users\": {\n                \"data\": [\n                    {\n                        \"type\": \"users\",\n                        \"id\": \"2\"\n                    }\n                ]\n            }\n        }\n    }\n}"
						},
						"url": {
							"raw": "http://{{host}}/api/teams/1",
							"protocol": "http",
							"host": [
								"{{host}}"
							],
							"path": [
								"api",
								"teams",
								"1"
							]
						}
					},
					"response": []
				},
				{
					"name": "/api/teams/<id>",
					"request": {
						"method": "DELETE",
						"header": [],
						"url": {
							"raw": "http://{{host}}/api/teams/1",
							"protocol": "http",
							"host": [
								"{{host}}"
							],
							"path": [
								"api",
								"teams",
								"1"
							]
						}
					},
					"response": []
				},
				{
					"name": "/api/teams/<parent_id>/relationships/users",
					"request": {
						"method": "GET",
						"header": [],
						"url": {
							"raw": "http://{{host}}/api/teams/1/relationships/users",
							"protocol": "http",
							"host": [
								"{{host}}"
							],
							"path": [
								"api",
								"teams",
								"1",
								"relationships",
								"users"
							]
						}
					},
					"response": []
				},
				{
					"name": "/api/teams/<parent_id>/relationships/users",
					"protocolProfileBehavior": {
						"disabledSystemHeaders": {
							"content-type": true
						}
					},
					"request": {
						"method": "PATCH",
						"header": [
							{
								"key": "Content-Type",
								"type": "text",
								"value": "application/vnd.api+json"
							}
						],
						"body": {
							"mode": "raw",
							"raw": "{\n    \"data\": []\n}"
						},
						"url": {
							"raw": "http://{{host}}/api/teams/1/relationships/users",
							"protocol": "http",
							"host": [
								"{{host}}"
							],
							"path": [
								"api",
								"teams",
								"1",
								"relationships",
								"users"
							]
						}
					},
					"response": []
				},
				{
					"name": "/api/teams/<parent_id>/relationships/users",
					"protocolProfileBehavior": {
						"disabledSystemHeaders": {
							"content-type": true
						}
					},
					"request": {
						"method": "POST",
						"header": [
							{
								"key": "Content-Type",
								"type": "text",
								"value": "application/vnd.api+json"
							}
						],
						"body": {
							"mode": "raw",
							"raw": "{\n    \"data\": [\n        {\n            \"type\": \"users\",\n            \"id\": \"1\"\n        }\n    ]\n}"
						},
						"url": {
							"raw": "http://{{host}}/api/teams/1/relationships/users",
							"protocol": "http",
							"host": [
								"{{host}}"
							],
							"path": [
								"api",
								"teams",
								"1",
								"relationships",
								"users"
							]
						}
					},
					"response": []
				},
				{
					"name": "/api/teams/<parent_id>/relationships/users",
					"protocolProfileBehavior": {
						"disabledSystemHeaders": {
							"content-type": true
						}
					},
					"request": {
						"method": "DELETE",
						"header": [
							{
								"key": "Content-Type",
								"type": "text",
								"value": "application/vnd.api+json"
							}
						],
						"body": {
							"mode": "raw",
							"raw": "{\n    \"data\": [\n        {\n            \"type\": \"users\",\n            \"id\": \"1\"\n        }\n    ]\n}"
						},
						"url": {
							"raw": "http://{{host}}/api/teams/1/relationships/users",
							"protocol": "http",
							"host": [
								"{{host}}"
							],
							"path": [
								"api",
								"teams",
								"1",
								"relationships",
								"users"
							]
						}
					},
					"response": []
				}
			],
			"event": [
				{
					"listen": "prerequest",
					"script": {
						"id": "31c0b79b-8bf0-4623-82bb-e43584514f67",
						"type": "text/javascript",
						"exec": [
							""
						]
					}
				},
				{
					"listen": "test",
					"script": {
						"id": "80f0b418-f2fb-4d29-8375-44939b1301c6",
						"type": "text/javascript",
						"exec": [
							""
						]
					}
				}
			],
			"protocolProfileBehavior": {}
		},
		{
			"name": "organizations",
			"item": [
				{
					"name": "/api/organizations/",
					"request": {
						"method": "GET",
						"header": [],
						"url": {
							"raw": "http://{{host}}/api/organizations/",
							"protocol": "http",
							"host": [
								"{{host}}"
							],
							"path": [
								"api",
								"organizations",
								""
							]
						}
					},
					"response": []
				},
				{
					"name": "/api/organizations/",
					"request": {
						"method": "POST",
						"header": [
							{
								"key": "Content-Type",
								"value": "application/vnd.api+json",
								"type": "text"
							}
						],
						"body": {
							"mode": "raw",
							"raw": "{\n    \"data\": {\n        \"type\": \"organizations\",\n        \"attributes\": {\n            \"name\": \"some-name\",\n            \"contact_url\": \"some-contact-url\",\n            \"contact_phone\": \"some-contact-phone\"\n        }\n    }\n}",
							"options": {
								"raw": {
									"language": "json"
								}
							}
						},
						"url": {
							"raw": "http://{{host}}/api/organizations/",
							"protocol": "http",
							"host": [
								"{{host}}"
							],
							"path": [
								"api",
								"organizations",
								""
							]
						}
					},
					"response": []
				},
				{
					"name": "/api/organizations/<id>",
					"request": {
						"method": "GET",
						"header": [],
						"url": {
							"raw": "http://{{host}}/api/organizations/1",
							"protocol": "http",
							"host": [
								"{{host}}"
							],
							"path": [
								"api",
								"organizations",
								"1"
							]
						}
					},
					"response": []
				},
				{
					"name": "/api/organizations/<id>",
					"protocolProfileBehavior": {
						"disabledSystemHeaders": {
							"content-type": true
						}
					},
					"request": {
						"method": "PATCH",
						"header": [
							{
								"key": "Content-Type",
								"value": "application/vnd.api+json",
								"type": "text"
							}
						],
						"body": {
							"mode": "raw",
							"raw": "{\n    \"data\": {\n        \"type\": \"organizations\",\n        \"attributes\": {\n            \"name\": \"some-name\",\n            \"contact_url\": \"some-contact-url\",\n            \"contact_phone\": \"some-contact-phone\"\n        }\n    }\n}",
							"options": {
								"raw": {
									"language": "json"
								}
							}
						},
						"url": {
							"raw": "http://{{host}}/api/organizations/1",
							"protocol": "http",
							"host": [
								"{{host}}"
							],
							"path": [
								"api",
								"organizations",
								"1"
							]
						}
					},
					"response": []
				},
				{
					"name": "/api/organizations/<id>",
					"request": {
						"method": "DELETE",
						"header": [],
						"url": {
							"raw": "http://{{host}}/api/organizations/1",
							"protocol": "http",
							"host": [
								"{{host}}"
							],
							"path": [
								"api",
								"organizations",
								"1"
							]
						}
					},
					"response": []
				}
			],
			"event": [
				{
					"listen": "prerequest",
					"script": {
						"id": "a88d2cd1-9e71-4925-abfc-f5b6b705af55",
						"type": "text/javascript",
						"exec": [
							""
						]
					}
				},
				{
					"listen": "test",
					"script": {
						"id": "c76a9b89-43b9-4da1-9b2b-cea25949f99c",
						"type": "text/javascript",
						"exec": [
							""
						]
					}
				}
			],
			"protocolProfileBehavior": {}
		}
	],
	"event": [
		{
			"listen": "prerequest",
			"script": {
				"id": "b7528020-dcb3-415e-9921-d1e49fcf0009",
				"type": "text/javascript",
				"exec": [
					""
				]
			}
		},
		{
			"listen": "test",
			"script": {
				"id": "99cbca6c-db89-45bc-a947-627873d2eb16",
				"type": "text/javascript",
				"exec": [
					""
				]
			}
		}
	],
	"variable": [
		{
			"id": "7d7aeebc-88a4-4b2e-9879-bbb8fa903234",
			"key": "host",
			"value": "127.0.0.1:8000"
		}
	],
	"protocolProfileBehavior": {}
}