Sign in
posts

Changed on
post/api/posts

Request

  • The document declares no server URL.
  • Auth: none declared

Request body

type'NOTE' | 'OLD_QUESTION' | 'EXERCISE' required
courseIdstring required

Course ID. Must belong to the authenticated user department.

titlestring required
descriptionstring required
isAnonymousboolean
externalUrlstring
examYearnumber
moduleNumbernumber required
yearnumber required
semesternumber required
tagsstring[]

Array of tag names (max 5 tags)

Example request

{
  "tags": [
    "Linear Algebra",
    "Calculus"
  ]
}

Response

idstring required
type'NOTE' | 'OLD_QUESTION' | 'EXERCISE' required
status'PENDING' | 'APPROVED' | 'REJECTED' required
publicationStatus'PUBLISHED' | 'PENDING_REVIEW' | 'REJECTED' required
trendingScorenumber required
isAnonymousboolean required
titlestring nullable
descriptionstring nullable
externalUrlstring nullable
summarystring nullable
summarizedAtstring date-time nullable
contentWarningstring nullable
examYearnumber nullable
moduleNumbernumber nullable
yearnumber nullable
semesternumber nullable
shortCodestring required
isOwnerboolean required
createdAtstring date-time required
updatedAtstring date-time required
savedByCurrentUserboolean required
viewsnumber required
reactionCountsobject required

Map of ReactionType to count

userReactionstring nullable

Changes

  • 8ace370d5b39Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the required property // to the response with the status

  • b16c08f8c898Revision changes
    • breaking

      removed the enum value ASSIGNMENT of the request property

    • warning

      added the new EXERCISE enum value to the //// response property for the response status

    • info

      added the new EXERCISE enum value to the request property

    • info

      removed the ASSIGNMENT enum value from the //// response property for the response status