Update API docs

This commit is contained in:
xfarrow
2025-06-10 12:20:34 +02:00
parent ade6a05408
commit 443b9d826b
34 changed files with 84 additions and 43 deletions

View File

@@ -0,0 +1,20 @@
meta {
name: ActivatePerson
type: http
seq: 3
}
get {
url: http://localhost:3000/api/people/me/activation?q=3ac9c204de1676b54163ed8015c7af00
body: json
auth: none
}
params:query {
q: 3ac9c204de1676b54163ed8015c7af00
}
headers {
Content-Type: application/json
User-Agent: insomnia/2023.5.8
}

View File

@@ -0,0 +1,11 @@
meta {
name: DeleteContactInfo
type: http
seq: 11
}
delete {
url: http://localhost:3000/api/people/contactinfos/2
body: none
auth: none
}

View File

@@ -0,0 +1,15 @@
meta {
name: DeletePerson
type: http
seq: 9
}
delete {
url: http://localhost:3000/api/people/me
body: none
auth: none
}
headers {
User-Agent: insomnia/2023.5.8
}

View File

@@ -0,0 +1,11 @@
meta {
name: GetContactInfosByPerson
type: http
seq: 12
}
get {
url: http://localhost:3000/api/people/1/contactinfos
body: none
auth: none
}

View File

@@ -0,0 +1,15 @@
meta {
name: GetMyself
type: http
seq: 8
}
get {
url: http://localhost:3000/api/people/me
body: none
auth: inherit
}
headers {
User-Agent: insomnia/2023.5.8
}

View File

@@ -0,0 +1,15 @@
meta {
name: GetPerson
type: http
seq: 7
}
get {
url: http://localhost:3000/api/people/1/details
body: none
auth: none
}
headers {
User-Agent: insomnia/2023.5.8
}

View File

@@ -0,0 +1,18 @@
meta {
name: InsertContactInfo
type: http
seq: 10
}
post {
url: http://localhost:3000/api/people/myself/contactinfos
body: json
auth: inherit
}
body:json {
{
"content": "www.john.com",
"info_type": "WEBSITE"
}
}

View File

@@ -0,0 +1,23 @@
meta {
name: Login
type: http
seq: 2
}
post {
url: http://localhost:3000/api/people/me/token
body: json
auth: none
}
headers {
Content-Type: application/json
User-Agent: insomnia/2023.5.8
}
body:json {
{
"email": "john@mail.org",
"password": "password"
}
}

View File

@@ -0,0 +1,26 @@
meta {
name: Register
type: http
seq: 1
}
post {
url: http://localhost:3000/api/people
body: json
auth: none
}
headers {
Content-Type: application/json
User-Agent: insomnia/2023.5.8
}
body:json {
{
"email" : "john@mail.org",
"password" : "password",
"displayName" : "John Doe",
"aboutMe" : "I am a passionate software engineer",
"qualification" : "Software Engineer"
}
}

View File

@@ -0,0 +1,22 @@
meta {
name: RequestNewPassword
type: http
seq: 5
}
post {
url: http://localhost:3000/api/resetpassword/request
body: json
auth: none
}
headers {
Content-Type: application/json
User-Agent: insomnia/2023.5.8
}
body:json {
{
"email": "john@mail.org"
}
}

View File

@@ -0,0 +1,23 @@
meta {
name: ResetNewPassword
type: http
seq: 6
}
post {
url: http://localhost:3000/api/resetpassword/reset
body: json
auth: none
}
headers {
Content-Type: application/json
User-Agent: insomnia/2023.5.8
}
body:json {
{
"secret": "360837853e2d3cf799c709b44720b4e3",
"password": "password"
}
}

View File

@@ -0,0 +1,32 @@
meta {
name: UpdatePerson
type: http
seq: 4
}
patch {
url: http://localhost:3000/api/people/me
body: json
auth: inherit
}
headers {
Content-Type: application/json
User-Agent: insomnia/2023.5.8
}
body:json {
{
"displayName": "John Junior Doe III",
"dateOfBirth": "1970-01-01",
"openToWork": "false",
"placeOfLiving": "Oslo, Norway",
"aboutMe": "I am a passionate software engineer, but I also love art and music",
"new_password": "password",
"old_password": "password",
"qualification" : "Software Engineer at Blink Inc. & Google LLC",
"visibility": "EVERYONE",
"oldPassword": "password",
"newPassword": "password"
}
}