SecHack365 (0.1.0)

Download OpenAPI specification:

auth

Create User

Request Body schema: application/json
required

username required	string
password required	string

Responses

Request samples

Payload

Content type

application/json

{"username": "string",
"password": "string"
}

Response samples

201
400
409
500

Content type

application/json

{ }

Login

Request Body schema: application/json
required

username required	string
password required	string

Responses

Request samples

Payload

Content type

application/json

{"username": "string",
"password": "string"
}

Response samples

204
400
401
500

Content type

application/json

{ }

Logout

Responses

Response samples

204

Content type

application/json

{ }

users

Get All Users (for debug)

Responses

Response samples

200
500

Content type

application/json

[{"id": "string",
"username": "string",
"protocol": "string",
"display_name": "string",
"profile": "string",
"icon": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"identifiers": {"activitypub": {"local_username": "string",
"host": "string",
"public_key": "string"
},
"nostr": {"npub": "string"
}
},
"post_count": 0,
"follow_count": 0,
"follower_count": 0
}
]

Get User by ID

path Parameters

id

required

string

Responses

Response samples

200
400
404
500

Content type

application/json

{"id": "string",
"username": "string",
"protocol": "string",
"display_name": "string",
"profile": "string",
"icon": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"identifiers": {"activitypub": {"local_username": "string",
"host": "string",
"public_key": "string"
},
"nostr": {"npub": "string"
}
},
"post_count": 0,
"follow_count": 0,
"follower_count": 0
}

Get Current User

Responses

Response samples

200
404
500

Content type

application/json

{"id": "string",
"username": "string",
"protocol": "string",
"display_name": "string",
"profile": "string",
"icon": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"identifiers": {"activitypub": {"local_username": "string",
"host": "string",
"public_key": "string"
},
"nostr": {"npub": "string"
}
},
"post_count": 0,
"follow_count": 0,
"follower_count": 0
}

Get Latest Posts of User

path Parameters

id

required

string

query Parameters

offset

integer

Responses

Response samples

200
400
404
500

Content type

application/json

[{"id": "string",
"user": {"username": "string",
"protocol": "string",
"display_name": "string",
"icon": "string"
},
"content": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]

Get Follows of User

path Parameters

id

required

string

Responses

Response samples

200
400
500

Content type

application/json

[{"username": "string",
"protocol": "string",
"display_name": "string",
"icon": "string"
}
]

Get Followers of User

path Parameters

id

required

string

Responses

Response samples

200
400
500

Content type

application/json

[{"username": "string",
"protocol": "string",
"display_name": "string",
"icon": "string"
}
]

ActivityPub Inbox

path Parameters

id

required

string

Responses

Response samples

202
400
401
500

Content type

application/json

{ }

Lookup (Remote/Local) User

path Parameters

username

required

string

Example: @user,@user@example.com,npub123abc

Responses

Response samples

200
400
404
500

Content type

application/json

{"id": "string",
"username": "string",
"protocol": "string",
"display_name": "string",
"profile": "string",
"icon": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"identifiers": {"activitypub": {"local_username": "string",
"host": "string",
"public_key": "string"
},
"nostr": {"npub": "string"
}
},
"post_count": 0,
"follow_count": 0,
"follower_count": 0
}

follows

Follow

Request Body schema: application/json
required

target_id

required

string

Responses

Request samples

Payload

Content type

application/json

{"target_id": "string"
}

Response samples

201
400
401
404
500

Content type

application/json

{ }

Unfollow

Request Body schema: application/json
required

target_id

required

string

Responses

Request samples

Payload

Content type

application/json

{"target_id": "string"
}

Response samples

204
400
401
404
500

Content type

application/json

{ }

Check if User is Following

path Parameters

id

required

string

Responses

Response samples

200
400
401
404
500

Content type

application/json

{"found": true
}

posts

Create Post

Request Body schema: application/json
required

content

required

string

Responses

Request samples

Payload

Content type

application/json

{"content": "string"
}

Response samples

201
400
401
500

Content type

application/json

{ }

Get Post by ID

path Parameters

id

required

string

Responses

Response samples

200
400
404
500

Content type

application/json

{"id": "string",
"user": {"username": "string",
"protocol": "string",
"display_name": "string",
"icon": "string"
},
"content": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete Post by ID

path Parameters

id

required

string

Responses

Response samples

204
400
401
404
500

Content type

application/json

{ }

Get Timeline

query Parameters

offset

integer

Responses

Response samples

200
500

Content type

application/json

[{"id": "string",
"user": {"username": "string",
"protocol": "string",
"display_name": "string",
"icon": "string"
},
"content": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]

articles

Create Article

Request Body schema: application/json
required

title required	string
content required	string

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"content": "string"
}

Response samples

201
400
401
500

Content type

application/json

{"id": "string",
"user": {"username": "string",
"protocol": "string",
"display_name": "string",
"icon": "string"
},
"title": "string",
"content": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Get Article by ID

path Parameters

id

required

string

Responses

Response samples

200

Content type

application/json

{"id": "string",
"user": {"username": "string",
"protocol": "string",
"display_name": "string",
"icon": "string"
},
"title": "string",
"content": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Get Comments by Article ID

path Parameters

id

required

string

Responses

Response samples

200

Content type

application/json

[{"id": "string",
"user": {"username": "string",
"protocol": "string",
"display_name": "string",
"icon": "string"
},
"article_id": "string",
"content": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]

images

Upload Image

Request Body schema: multipart/form-data
required

image

string <binary>

Responses

Response samples

201
400
401
500

Content type

application/json

{"url": "http://example.com"
}

reactions

Add Reaction to Post

Request Body schema: application/json
required

type required	string
post_id required	string

Responses

Request samples

Payload

Content type

application/json

{"type": "string",
"post_id": "string"
}

Response samples

201
400
401
404
500

Content type

application/json

{ }

Remove Reaction to Post

Responses

Response samples

204
400
401
404
500

Content type

application/json

{ }

config

Register a New Nostr Relay

Request Body schema: application/json
required

id required	string
url required	string
is_enable required	boolean
created_at required	string <date-time>
updated_at required	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"url": "string",
"is_enable": true,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Response samples

201
400
401
500

Content type

application/json

{ }

Get Nostr Relays List

Responses

Response samples

200
401
500

Content type

application/json

[{"id": "string",
"url": "string",
"is_enable": true,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]

Delete a Nostr Relay

Responses

Response samples

204
400
401
404
500

Content type

application/json

{ }

nodeinfo

NodeInfo 2.0

Responses

Response samples

200
500

Content type

application/json

{"openRegistrations": false,
"protocols": ["activitypub"
],
"software": {"name": "sechack365",
"version": "0.1.0"
},
"usage": {"users": {"total": 0
}
},
"services": {"inbound": { },
"outbound": { }
},
"metadata": { },
"version": "2.0"
}

.well-known

NodeInfo

Responses

Response samples

200

Content type

application/json

{"links": [{"rel": "http://nodeinfo.diaspora.software/ns/schema/2.0",
"href": "https://localhost/api/v1/nodeinfo/2.0"
}
]
}

WebFinger

query Parameters

resource

required

string

Example: resource=acct:user@example.com

Responses

Response samples

200
400
404
500

Content type

application/json

{"subject": "acct:mock@localhost",
"links": [{"rel": "self",
"type": "application/activity+json",
"href": "https:/localhost/api/v1/users/1"
}
]
}

NIP-05

query Parameters

name

required

string

Responses

Response samples

200
400
404
500

Content type

application/json

{"names": {"property1": "string",
"property2": "string"
}
}

dev (localhost only)

Generate Mock

Responses

Response samples

201
404
500

Content type

application/json

{ }

Reset Database

Responses

Response samples

204
404
500

Content type

application/json

{ }

SecHack365 (0.1.0)

auth

Create User

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Login

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Logout

Responses

Response samples

users

Get All Users (for debug)

Responses

Response samples

Get User by ID

path Parameters

Responses

Response samples

Get Current User

Responses

Response samples

Get Latest Posts of User

path Parameters

query Parameters

Responses

Response samples

Get Follows of User

path Parameters

Responses

Response samples

Get Followers of User

path Parameters

Responses

Response samples

ActivityPub Inbox

path Parameters

Responses

Response samples

Lookup (Remote/Local) User

path Parameters

Responses

Response samples

follows

Follow

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Unfollow

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Check if User is Following

path Parameters

Responses

Response samples

posts

Create Post

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get Post by ID

path Parameters

Responses

Response samples

Delete Post by ID

path Parameters

Responses

Response samples

Get Timeline

query Parameters

Responses

Response samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: multipart/form-data
required

Request Body schema: application/json
required

Request Body schema: application/json
required