Posts

Public Posts

Create a new public post

Each post begins as a draft. A user can only have one active draft at a time. If a draft already exists, it must be published or deleted before a new one can be created.

POST/posts

Body

application/json

titlestring

Example: "My First Post"

descriptionstring

Example: "This is the content of my first post."

tagsarray of string

postTypestring

Example: "blog"

Response

201409

Created

Body

application/json

postIdstring (uuid)

Example: "550e8400-e29b-41d4-a716-446655440000"

titlestring

Example: "My First Post"

descriptionstring

Example: "This is the content of my first post."

tagsarray of string

postTypestring

Example: "blog"

accessTypeenum

PUBLICPRIVATE

statusenum

DRAFTACTIVEARCHIVED

created_atstring (date-time)

updated_atstring (date-time)

deleted_atstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/posts', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201

{
  "postId": "550e8400-e29b-41d4-a716-446655440000",
  "title": "My First Post",
  "description": "This is the content of my first post.",
  "tags": [
    "example",
    "firstPost"
  ],
  "postType": "blog",
  "accessType": "PUBLIC",
  "status": "DRAFT",
  "created_at": "2024-12-22T22:36:07.774Z",
  "updated_at": "2024-12-22T22:36:07.774Z",
  "deleted_at": "2024-12-22T22:36:07.774Z"
}

Retrieve a list of public posts

Retrieves a list of public posts with optional filtering. Users can filter by tags, creation date, status (draft or published), or post type.

GET/posts

Query parameters

Response

200

A list of posts

Body

application/json

postIdstring (uuid)

Example: "550e8400-e29b-41d4-a716-446655440000"

titlestring

Example: "My First Post"

descriptionstring

Example: "This is the content of my first post."

tagsarray of string

postTypestring

Example: "blog"

accessTypeenum

PUBLICPRIVATE

statusenum

DRAFTACTIVEARCHIVED

created_atstring (date-time)

updated_atstring (date-time)

deleted_atstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/posts', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "postId": "550e8400-e29b-41d4-a716-446655440000",
    "title": "My First Post",
    "description": "This is the content of my first post.",
    "tags": [
      "example",
      "firstPost"
    ],
    "postType": "blog",
    "accessType": "PUBLIC",
    "status": "DRAFT",
    "created_at": "2024-12-22T22:36:07.774Z",
    "updated_at": "2024-12-22T22:36:07.774Z",
    "deleted_at": "2024-12-22T22:36:07.774Z"
  }
]

Retrieve a public post by ID

Retrieves the details of a public post by its unique identifier.

GET/posts/{id}

Path parameters

id*string

Response

200404

Post found

Body

application/json

postIdstring (uuid)

Example: "550e8400-e29b-41d4-a716-446655440000"

titlestring

Example: "My First Post"

descriptionstring

Example: "This is the content of my first post."

tagsarray of string

postTypestring

Example: "blog"

accessTypeenum

PUBLICPRIVATE

statusenum

DRAFTACTIVEARCHIVED

created_atstring (date-time)

updated_atstring (date-time)

deleted_atstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/posts/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "postId": "550e8400-e29b-41d4-a716-446655440000",
  "title": "My First Post",
  "description": "This is the content of my first post.",
  "tags": [
    "example",
    "firstPost"
  ],
  "postType": "blog",
  "accessType": "PUBLIC",
  "status": "DRAFT",
  "created_at": "2024-12-22T22:36:07.774Z",
  "updated_at": "2024-12-22T22:36:07.774Z",
  "deleted_at": "2024-12-22T22:36:07.774Z"
}

Update an existing public post

Updates the title, content, tags, or post type of an existing public post.

PUT/posts/{id}

Path parameters

id*string

Body

application/json

titlestring

Example: "Updated Title"

descriptionstring

Example: "Updated content of the post."

tagsarray of string

postTypestring

Example: "news"

Response

200404

Updated successfully

Body

application/json

postIdstring (uuid)

Example: "550e8400-e29b-41d4-a716-446655440000"

titlestring

Example: "My First Post"

descriptionstring

Example: "This is the content of my first post."

tagsarray of string

postTypestring

Example: "blog"

accessTypeenum

PUBLICPRIVATE

statusenum

DRAFTACTIVEARCHIVED

created_atstring (date-time)

updated_atstring (date-time)

deleted_atstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/posts/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "postId": "550e8400-e29b-41d4-a716-446655440000",
  "title": "My First Post",
  "description": "This is the content of my first post.",
  "tags": [
    "example",
    "firstPost"
  ],
  "postType": "blog",
  "accessType": "PUBLIC",
  "status": "DRAFT",
  "created_at": "2024-12-22T22:36:07.774Z",
  "updated_at": "2024-12-22T22:36:07.774Z",
  "deleted_at": "2024-12-22T22:36:07.774Z"
}

Delete a public post by ID

Deletes a public post by its ID. This action is irreversible.

DELETE/posts/{id}

Path parameters

id*string

Response

204404

No Content - Post successfully deleted

Request

JavaScriptCurlPython

const response = await fetch('/posts/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Create a new private post

Identical to creating a public post, but this post is private.

POST/private/posts

Body

application/json

titlestring

Example: "My First Private Post"

descriptionstring

Example: "This is the content of my first private post."

tagsarray of string

postTypestring

Example: "privateBlog"

Response

201409

Created

Body

application/json

postIdstring (uuid)

Example: "550e8400-e29b-41d4-a716-446655440000"

titlestring

Example: "My First Post"

descriptionstring

Example: "This is the content of my first post."

tagsarray of string

postTypestring

Example: "blog"

accessTypeenum

PUBLICPRIVATE

statusenum

DRAFTACTIVEARCHIVED

created_atstring (date-time)

updated_atstring (date-time)

deleted_atstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/private/posts', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201

{
  "postId": "550e8400-e29b-41d4-a716-446655440000",
  "title": "My First Post",
  "description": "This is the content of my first post.",
  "tags": [
    "example",
    "firstPost"
  ],
  "postType": "blog",
  "accessType": "PUBLIC",
  "status": "DRAFT",
  "created_at": "2024-12-22T22:36:07.774Z",
  "updated_at": "2024-12-22T22:36:07.774Z",
  "deleted_at": "2024-12-22T22:36:07.774Z"
}

Retrieve a list of private posts

Retrieves a list of private posts with optional filtering. Users can filter by tags, creation date, status (draft or published), or post type.

GET/private/posts

Query parameters

Response

200

A list of private posts

Body

application/json

postIdstring (uuid)

Example: "550e8400-e29b-41d4-a716-446655440000"

titlestring

Example: "My First Post"

descriptionstring

Example: "This is the content of my first post."

tagsarray of string

postTypestring

Example: "blog"

accessTypeenum

PUBLICPRIVATE

statusenum

DRAFTACTIVEARCHIVED

created_atstring (date-time)

updated_atstring (date-time)

deleted_atstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/private/posts', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "postId": "550e8400-e29b-41d4-a716-446655440000",
    "title": "My First Post",
    "description": "This is the content of my first post.",
    "tags": [
      "example",
      "firstPost"
    ],
    "postType": "blog",
    "accessType": "PUBLIC",
    "status": "DRAFT",
    "created_at": "2024-12-22T22:36:07.774Z",
    "updated_at": "2024-12-22T22:36:07.774Z",
    "deleted_at": "2024-12-22T22:36:07.774Z"
  }
]

Retrieve a private post by ID

Retrieves the details of a private post by its unique identifier.

GET/private/posts/{id}

Path parameters

id*string

Response

200404

Post found

Body

application/json

postIdstring (uuid)

Example: "550e8400-e29b-41d4-a716-446655440000"

titlestring

Example: "My First Post"

descriptionstring

Example: "This is the content of my first post."

tagsarray of string

postTypestring

Example: "blog"

accessTypeenum

PUBLICPRIVATE

statusenum

DRAFTACTIVEARCHIVED

created_atstring (date-time)

updated_atstring (date-time)

deleted_atstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/private/posts/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "postId": "550e8400-e29b-41d4-a716-446655440000",
  "title": "My First Post",
  "description": "This is the content of my first post.",
  "tags": [
    "example",
    "firstPost"
  ],
  "postType": "blog",
  "accessType": "PUBLIC",
  "status": "DRAFT",
  "created_at": "2024-12-22T22:36:07.774Z",
  "updated_at": "2024-12-22T22:36:07.774Z",
  "deleted_at": "2024-12-22T22:36:07.774Z"
}

Update an existing private post

Updates the title, content, tags, or post type of an existing private post.

PUT/private/posts/{id}

Path parameters

id*string

Body

application/json

titlestring

Example: "Updated Private Title"

descriptionstring

Example: "Updated content of the private post."

tagsarray of string

postTypestring

Example: "privateNews"

Response

200404

Updated successfully

Body

application/json

postIdstring (uuid)

Example: "550e8400-e29b-41d4-a716-446655440000"

titlestring

Example: "My First Post"

descriptionstring

Example: "This is the content of my first post."

tagsarray of string

postTypestring

Example: "blog"

accessTypeenum

PUBLICPRIVATE

statusenum

DRAFTACTIVEARCHIVED

created_atstring (date-time)

updated_atstring (date-time)

deleted_atstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/private/posts/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "postId": "550e8400-e29b-41d4-a716-446655440000",
  "title": "My First Post",
  "description": "This is the content of my first post.",
  "tags": [
    "example",
    "firstPost"
  ],
  "postType": "blog",
  "accessType": "PUBLIC",
  "status": "DRAFT",
  "created_at": "2024-12-22T22:36:07.774Z",
  "updated_at": "2024-12-22T22:36:07.774Z",
  "deleted_at": "2024-12-22T22:36:07.774Z"
}

Delete a private post by ID

Deletes a private post by its ID. This action is irreversible.

DELETE/private/posts/{id}

Path parameters

id*string

Response

204404

No Content - Post successfully deleted

Request

JavaScriptCurlPython

const response = await fetch('/private/posts/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();