Yimaru-BackEnd/postman/LMS-Personas.postman_collection.json
Yared Yemane 9ff418247f Always include profile_picture in persona JSON responses.
Remove omitempty on LmsPersona.profile_picture so list/get return null when unset. Add LMS-Personas Postman collection matching current API.

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-05-20 06:25:55 -07:00

275 lines
7.9 KiB
JSON

{
"info": {
"_postman_id": "c4e8a921-62f3-4c1e-9bad-1107dfd2a701",
"name": "LMS Personas - Catalog CRUD",
"description": "Admin API for LMS persona catalog (`/api/v1/personas`). Requires bearer token with permissions: personas.list, personas.create, personas.get, personas.update, personas.delete. Personas are assigned to practices via `persona_id`; image URL lives in JSON field `profile_picture`.",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{access_token}}",
"type": "string"
}
]
},
"variable": [
{
"key": "base_url",
"value": "http://localhost:8080"
},
{
"key": "access_token",
"value": ""
},
{
"key": "persona_id",
"value": "1",
"type": "string"
}
],
"item": [
{
"name": "01 - Personas CRUD",
"item": [
{
"name": "Create persona",
"event": [
{
"listen": "test",
"script": {
"exec": [
"pm.test(\"Status code is 201\", function () {",
" pm.response.to.have.status(201);",
"});",
"const body = pm.response.json();",
"pm.test(\"Persona returned in data\", function () {",
" pm.expect(body.data).to.be.an(\"object\");",
" pm.expect(body.data.id).to.be.a(\"number\");",
"});",
"pm.collectionVariables.set(\"persona_id\", String(body.data.id));"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Postman Coach\",\n \"description\": \"Smoke-test persona from Postman\",\n \"profile_picture\": \"https://cdn.example.com/personas/postman-coach.png\",\n \"is_active\": true\n}"
},
"url": {
"raw": "{{base_url}}/api/v1/personas",
"host": [
"{{base_url}}"
],
"path": [
"api",
"v1",
"personas"
]
}
},
"response": []
},
{
"name": "List personas (active_only default)",
"event": [
{
"listen": "test",
"script": {
"exec": [
"pm.test(\"Status code is 200\", function () {",
" pm.response.to.have.status(200);",
"});",
"const body = pm.response.json();",
"pm.test(\"Paged list shape\", function () {",
" pm.expect(body.data.personas).to.be.an(\"array\");",
" pm.expect(body.data.total_count).to.be.a(\"number\");",
"});"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "GET",
"url": {
"raw": "{{base_url}}/api/v1/personas?limit=20&offset=0",
"host": [
"{{base_url}}"
],
"path": [
"api",
"v1",
"personas"
],
"query": [
{
"key": "active_only",
"value": "true",
"disabled": true
},
{
"key": "limit",
"value": "20"
},
{
"key": "offset",
"value": "0"
}
]
}
},
"response": []
},
{
"name": "List personas (include inactive)",
"request": {
"method": "GET",
"url": {
"raw": "{{base_url}}/api/v1/personas?active_only=false&limit=50&offset=0",
"host": [
"{{base_url}}"
],
"path": [
"api",
"v1",
"personas"
],
"query": [
{
"key": "active_only",
"value": "false"
},
{
"key": "limit",
"value": "50"
},
{
"key": "offset",
"value": "0"
}
]
}
},
"response": []
},
{
"name": "Get persona by ID",
"event": [
{
"listen": "test",
"script": {
"exec": [
"pm.test(\"Status code is 200\", function () {",
" pm.response.to.have.status(200);",
"});",
"const body = pm.response.json();",
"pm.test(\"Has profile_picture field shape\", function () {",
" pm.expect(body.data).to.be.an(\"object\");",
" pm.expect(body.data.name).to.be.a(\"string\");",
"});"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "GET",
"url": {
"raw": "{{base_url}}/api/v1/personas/{{persona_id}}",
"host": [
"{{base_url}}"
],
"path": [
"api",
"v1",
"personas",
"{{persona_id}}"
]
}
},
"response": []
},
{
"name": "Update persona",
"event": [
{
"listen": "test",
"script": {
"exec": [
"pm.test(\"Status code is 200\", function () {",
" pm.response.to.have.status(200);",
"});",
"const body = pm.response.json();",
"pm.test(\"Updated data returned\", function () {",
" pm.expect(body.data.profile_picture).to.include(\"alex-v2\");",
"});"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Postman Coach (updated)\",\n \"profile_picture\": \"https://cdn.example.com/personas/alex-v2.png\"\n}"
},
"url": {
"raw": "{{base_url}}/api/v1/personas/{{persona_id}}",
"host": [
"{{base_url}}"
],
"path": [
"api",
"v1",
"personas",
"{{persona_id}}"
]
}
},
"response": []
},
{
"name": "Delete persona",
"request": {
"method": "DELETE",
"url": {
"raw": "{{base_url}}/api/v1/personas/{{persona_id}}",
"host": [
"{{base_url}}"
],
"path": [
"api",
"v1",
"personas",
"{{persona_id}}"
]
}
},
"response": []
}
]
}
]
}