12072 lines
313 KiB
YAML
12072 lines
313 KiB
YAML
definitions:
|
|
netidhub-saas-be_app_module_article_approval_flows_request.SubmitForApprovalRequest:
|
|
properties:
|
|
articleId:
|
|
type: integer
|
|
workflowId:
|
|
type: integer
|
|
required:
|
|
- articleId
|
|
type: object
|
|
netidhub-saas-be_app_module_articles_request.SubmitForApprovalRequest:
|
|
properties:
|
|
message:
|
|
maxLength: 500
|
|
type: string
|
|
workflow_id:
|
|
minimum: 1
|
|
type: integer
|
|
type: object
|
|
paginator.Pagination:
|
|
properties:
|
|
count:
|
|
type: integer
|
|
limit:
|
|
type: integer
|
|
nextPage:
|
|
type: integer
|
|
page:
|
|
type: integer
|
|
previousPage:
|
|
type: integer
|
|
sort:
|
|
type: string
|
|
sortBy:
|
|
type: string
|
|
totalPage:
|
|
type: integer
|
|
type: object
|
|
request.ActivityLogsCreateRequest:
|
|
properties:
|
|
activityTypeId:
|
|
type: integer
|
|
articleId:
|
|
type: integer
|
|
url:
|
|
type: string
|
|
userId:
|
|
type: integer
|
|
visitorIp:
|
|
type: string
|
|
required:
|
|
- activityTypeId
|
|
- url
|
|
type: object
|
|
request.ActivityLogsUpdateRequest:
|
|
properties:
|
|
activityTypeId:
|
|
type: integer
|
|
articleId:
|
|
type: integer
|
|
id:
|
|
type: integer
|
|
url:
|
|
type: string
|
|
userId:
|
|
type: integer
|
|
required:
|
|
- activityTypeId
|
|
- id
|
|
- url
|
|
type: object
|
|
request.AdminUserCreateRequest:
|
|
properties:
|
|
address:
|
|
type: string
|
|
dateOfBirth:
|
|
type: string
|
|
email:
|
|
type: string
|
|
fullname:
|
|
type: string
|
|
genderType:
|
|
type: string
|
|
identityGroup:
|
|
type: string
|
|
identityGroupNumber:
|
|
type: string
|
|
identityNumber:
|
|
type: string
|
|
identityType:
|
|
type: string
|
|
lastEducation:
|
|
type: string
|
|
password:
|
|
type: string
|
|
phoneNumber:
|
|
type: string
|
|
username:
|
|
type: string
|
|
workType:
|
|
type: string
|
|
required:
|
|
- email
|
|
- fullname
|
|
- password
|
|
- username
|
|
type: object
|
|
request.AdvertisementCreateRequest:
|
|
properties:
|
|
description:
|
|
type: string
|
|
placement:
|
|
type: string
|
|
redirectLink:
|
|
type: string
|
|
title:
|
|
type: string
|
|
required:
|
|
- description
|
|
- placement
|
|
- redirectLink
|
|
- title
|
|
type: object
|
|
request.AdvertisementUpdateRequest:
|
|
properties:
|
|
description:
|
|
type: string
|
|
id:
|
|
type: integer
|
|
placement:
|
|
type: string
|
|
redirectLink:
|
|
type: string
|
|
title:
|
|
type: string
|
|
required:
|
|
- description
|
|
- id
|
|
- placement
|
|
- redirectLink
|
|
- title
|
|
type: object
|
|
request.ApprovalActionRequest:
|
|
properties:
|
|
action:
|
|
enum:
|
|
- approve
|
|
- revision
|
|
- reject
|
|
type: string
|
|
message:
|
|
type: string
|
|
required:
|
|
- action
|
|
type: object
|
|
request.ApprovalWorkflowStepRequest:
|
|
properties:
|
|
autoApproveAfterHours:
|
|
type: integer
|
|
branchName:
|
|
type: string
|
|
branchOrder:
|
|
type: integer
|
|
canSkip:
|
|
type: boolean
|
|
conditionType:
|
|
description: '''user_level'', ''user_level_hierarchy'', ''always'', ''custom'''
|
|
type: string
|
|
conditionValue:
|
|
description: JSON string for conditions
|
|
type: string
|
|
isActive:
|
|
type: boolean
|
|
isParallel:
|
|
type: boolean
|
|
parentStepId:
|
|
description: Multi-branch support fields
|
|
type: integer
|
|
requiredUserLevelId:
|
|
type: integer
|
|
stepName:
|
|
type: string
|
|
stepOrder:
|
|
type: integer
|
|
required:
|
|
- requiredUserLevelId
|
|
- stepName
|
|
- stepOrder
|
|
type: object
|
|
request.ApprovalWorkflowsCreateRequest:
|
|
properties:
|
|
autoPublish:
|
|
type: boolean
|
|
description:
|
|
type: string
|
|
isActive:
|
|
type: boolean
|
|
isDefault:
|
|
type: boolean
|
|
name:
|
|
type: string
|
|
requiresApproval:
|
|
type: boolean
|
|
steps:
|
|
items:
|
|
$ref: '#/definitions/request.ApprovalWorkflowStepRequest'
|
|
type: array
|
|
required:
|
|
- description
|
|
- name
|
|
type: object
|
|
request.ApprovalWorkflowsUpdateRequest:
|
|
properties:
|
|
autoPublish:
|
|
type: boolean
|
|
description:
|
|
type: string
|
|
isActive:
|
|
type: boolean
|
|
isDefault:
|
|
type: boolean
|
|
name:
|
|
type: string
|
|
requiresApproval:
|
|
type: boolean
|
|
required:
|
|
- description
|
|
- name
|
|
type: object
|
|
request.ApprovalWorkflowsWithStepsCreateRequest:
|
|
properties:
|
|
autoPublish:
|
|
type: boolean
|
|
description:
|
|
type: string
|
|
isActive:
|
|
type: boolean
|
|
isDefault:
|
|
type: boolean
|
|
name:
|
|
type: string
|
|
requiresApproval:
|
|
type: boolean
|
|
steps:
|
|
items:
|
|
$ref: '#/definitions/request.ApprovalWorkflowStepRequest'
|
|
minItems: 1
|
|
type: array
|
|
required:
|
|
- description
|
|
- name
|
|
- steps
|
|
type: object
|
|
request.ApprovalWorkflowsWithStepsUpdateRequest:
|
|
properties:
|
|
autoPublish:
|
|
type: boolean
|
|
description:
|
|
type: string
|
|
isActive:
|
|
type: boolean
|
|
isDefault:
|
|
type: boolean
|
|
name:
|
|
type: string
|
|
requiresApproval:
|
|
type: boolean
|
|
steps:
|
|
items:
|
|
$ref: '#/definitions/request.ApprovalWorkflowStepRequest'
|
|
minItems: 1
|
|
type: array
|
|
required:
|
|
- description
|
|
- name
|
|
- steps
|
|
type: object
|
|
request.ArticleApprovalStepLogsCreateRequest:
|
|
properties:
|
|
approvalStatusId:
|
|
type: integer
|
|
approvedAt:
|
|
type: string
|
|
approverUserId:
|
|
type: integer
|
|
articleApprovalFlowId:
|
|
type: integer
|
|
comments:
|
|
maxLength: 1000
|
|
type: string
|
|
dueDate:
|
|
type: string
|
|
isAutoApproved:
|
|
type: boolean
|
|
workflowStepId:
|
|
type: integer
|
|
required:
|
|
- approvalStatusId
|
|
- articleApprovalFlowId
|
|
- workflowStepId
|
|
type: object
|
|
request.ArticleApprovalStepLogsUpdateRequest:
|
|
properties:
|
|
approvalStatusId:
|
|
type: integer
|
|
approvedAt:
|
|
type: string
|
|
approverUserId:
|
|
type: integer
|
|
comments:
|
|
maxLength: 1000
|
|
type: string
|
|
dueDate:
|
|
type: string
|
|
isAutoApproved:
|
|
type: boolean
|
|
type: object
|
|
request.ArticleApprovalsCreateRequest:
|
|
properties:
|
|
articleId:
|
|
type: integer
|
|
message:
|
|
type: string
|
|
statusId:
|
|
type: integer
|
|
required:
|
|
- articleId
|
|
- message
|
|
- statusId
|
|
type: object
|
|
request.ArticleApprovalsUpdateRequest:
|
|
properties:
|
|
articleId:
|
|
type: integer
|
|
id:
|
|
type: integer
|
|
message:
|
|
type: string
|
|
statusId:
|
|
type: integer
|
|
required:
|
|
- articleId
|
|
- id
|
|
- message
|
|
- statusId
|
|
type: object
|
|
request.ArticleCategoriesCreateRequest:
|
|
properties:
|
|
createdById:
|
|
type: integer
|
|
description:
|
|
type: string
|
|
oldCategoryId:
|
|
type: integer
|
|
parentId:
|
|
type: integer
|
|
slug:
|
|
type: string
|
|
statusId:
|
|
type: integer
|
|
tags:
|
|
type: string
|
|
title:
|
|
type: string
|
|
required:
|
|
- description
|
|
- statusId
|
|
- title
|
|
type: object
|
|
request.ArticleCategoriesUpdateRequest:
|
|
properties:
|
|
createdById:
|
|
type: integer
|
|
description:
|
|
type: string
|
|
id:
|
|
type: integer
|
|
isPublish:
|
|
type: boolean
|
|
parentId:
|
|
type: integer
|
|
publishedAt:
|
|
type: string
|
|
slug:
|
|
type: string
|
|
statusId:
|
|
type: integer
|
|
tags:
|
|
type: string
|
|
title:
|
|
type: string
|
|
required:
|
|
- description
|
|
- id
|
|
- statusId
|
|
- title
|
|
type: object
|
|
request.ArticleCommentsApprovalRequest:
|
|
properties:
|
|
id:
|
|
type: integer
|
|
statusId:
|
|
type: integer
|
|
required:
|
|
- id
|
|
- statusId
|
|
type: object
|
|
request.ArticleCommentsCreateRequest:
|
|
properties:
|
|
articleId:
|
|
type: integer
|
|
isPublic:
|
|
type: boolean
|
|
message:
|
|
type: string
|
|
parentId:
|
|
type: integer
|
|
required:
|
|
- articleId
|
|
- message
|
|
type: object
|
|
request.ArticleCommentsUpdateRequest:
|
|
properties:
|
|
articleId:
|
|
type: integer
|
|
id:
|
|
type: integer
|
|
isPublic:
|
|
type: boolean
|
|
message:
|
|
type: string
|
|
parentId:
|
|
type: integer
|
|
required:
|
|
- articleId
|
|
- id
|
|
- message
|
|
type: object
|
|
request.ArticleFilesUpdateRequest:
|
|
properties:
|
|
articleId:
|
|
type: integer
|
|
fileAlt:
|
|
type: string
|
|
fileName:
|
|
type: string
|
|
filePath:
|
|
type: string
|
|
fileThumbnail:
|
|
type: string
|
|
fileUrl:
|
|
type: string
|
|
heightPixel:
|
|
type: string
|
|
id:
|
|
type: integer
|
|
isPublish:
|
|
type: boolean
|
|
publishedAt:
|
|
type: string
|
|
size:
|
|
type: string
|
|
statusId:
|
|
type: integer
|
|
widthPixel:
|
|
type: string
|
|
required:
|
|
- articleId
|
|
- id
|
|
- isPublish
|
|
- publishedAt
|
|
- statusId
|
|
type: object
|
|
request.ArticleNulisAICreateRequest:
|
|
properties:
|
|
articleId:
|
|
type: integer
|
|
categoryId:
|
|
type: integer
|
|
creatorId:
|
|
type: integer
|
|
description:
|
|
type: string
|
|
htmlDescription:
|
|
type: string
|
|
nulisAiId:
|
|
type: integer
|
|
tags:
|
|
type: string
|
|
title:
|
|
type: string
|
|
required:
|
|
- articleId
|
|
- categoryId
|
|
- creatorId
|
|
- description
|
|
- htmlDescription
|
|
- nulisAiId
|
|
- tags
|
|
- title
|
|
type: object
|
|
request.ArticleNulisAIUpdateRequest:
|
|
properties:
|
|
articleId:
|
|
type: integer
|
|
categoryId:
|
|
type: integer
|
|
creatorId:
|
|
type: integer
|
|
description:
|
|
type: string
|
|
htmlDescription:
|
|
type: string
|
|
id:
|
|
type: integer
|
|
nulisAiId:
|
|
type: integer
|
|
tags:
|
|
type: string
|
|
title:
|
|
type: string
|
|
updated_at:
|
|
type: string
|
|
required:
|
|
- articleId
|
|
- categoryId
|
|
- creatorId
|
|
- description
|
|
- htmlDescription
|
|
- id
|
|
- nulisAiId
|
|
- tags
|
|
- title
|
|
type: object
|
|
request.ArticlesCreateRequest:
|
|
properties:
|
|
aiArticleId:
|
|
type: integer
|
|
categoryIds:
|
|
type: string
|
|
createdAt:
|
|
type: string
|
|
createdById:
|
|
type: integer
|
|
description:
|
|
type: string
|
|
htmlDescription:
|
|
type: string
|
|
isDraft:
|
|
type: boolean
|
|
isPublish:
|
|
type: boolean
|
|
oldId:
|
|
type: integer
|
|
slug:
|
|
type: string
|
|
tags:
|
|
type: string
|
|
title:
|
|
type: string
|
|
typeId:
|
|
type: integer
|
|
required:
|
|
- categoryIds
|
|
- description
|
|
- htmlDescription
|
|
- slug
|
|
- tags
|
|
- title
|
|
- typeId
|
|
type: object
|
|
request.ArticlesUpdateRequest:
|
|
properties:
|
|
aiArticleId:
|
|
type: integer
|
|
categoryIds:
|
|
type: string
|
|
createdAt:
|
|
type: string
|
|
createdById:
|
|
type: integer
|
|
description:
|
|
type: string
|
|
htmlDescription:
|
|
type: string
|
|
isDraft:
|
|
type: boolean
|
|
isPublish:
|
|
type: boolean
|
|
slug:
|
|
type: string
|
|
statusId:
|
|
type: integer
|
|
tags:
|
|
type: string
|
|
title:
|
|
type: string
|
|
typeId:
|
|
type: integer
|
|
required:
|
|
- categoryIds
|
|
- description
|
|
- htmlDescription
|
|
- slug
|
|
- tags
|
|
- title
|
|
- typeId
|
|
type: object
|
|
request.BookmarksCreateRequest:
|
|
properties:
|
|
articleId:
|
|
type: integer
|
|
required:
|
|
- articleId
|
|
type: object
|
|
request.BulkCreateApprovalWorkflowStepsRequest:
|
|
properties:
|
|
steps:
|
|
items:
|
|
$ref: '#/definitions/request.CreateApprovalWorkflowStepsRequest'
|
|
maxItems: 20
|
|
minItems: 1
|
|
type: array
|
|
workflowId:
|
|
type: integer
|
|
required:
|
|
- steps
|
|
- workflowId
|
|
type: object
|
|
request.BulkCreateSubClientsRequest:
|
|
properties:
|
|
parentClientId:
|
|
type: string
|
|
subClients:
|
|
items:
|
|
$ref: '#/definitions/request.ClientsCreateSubClientDetail'
|
|
minItems: 1
|
|
type: array
|
|
required:
|
|
- parentClientId
|
|
- subClients
|
|
type: object
|
|
request.BulkProcessApprovalRequest:
|
|
properties:
|
|
approvalStatusId:
|
|
type: integer
|
|
comments:
|
|
maxLength: 1000
|
|
type: string
|
|
logIds:
|
|
items:
|
|
type: integer
|
|
maxItems: 50
|
|
minItems: 1
|
|
type: array
|
|
statusId:
|
|
type: integer
|
|
stepLogIds:
|
|
items:
|
|
type: integer
|
|
maxItems: 50
|
|
minItems: 1
|
|
type: array
|
|
userId:
|
|
type: integer
|
|
required:
|
|
- approvalStatusId
|
|
- logIds
|
|
- statusId
|
|
- stepLogIds
|
|
- userId
|
|
type: object
|
|
request.CitiesCreateRequest:
|
|
properties:
|
|
city_name:
|
|
type: string
|
|
prov_id:
|
|
type: integer
|
|
required:
|
|
- city_name
|
|
- prov_id
|
|
type: object
|
|
request.CitiesUpdateRequest:
|
|
properties:
|
|
city_name:
|
|
type: string
|
|
id:
|
|
type: integer
|
|
prov_id:
|
|
type: integer
|
|
required:
|
|
- city_name
|
|
- id
|
|
- prov_id
|
|
type: object
|
|
request.ClientApprovalSettingsRequest:
|
|
properties:
|
|
approvalExemptCategories:
|
|
items:
|
|
type: integer
|
|
type: array
|
|
approvalExemptRoles:
|
|
items:
|
|
type: integer
|
|
type: array
|
|
approvalExemptUsers:
|
|
items:
|
|
type: integer
|
|
type: array
|
|
autoPublishArticles:
|
|
type: boolean
|
|
isActive:
|
|
type: boolean
|
|
requireApprovalFor:
|
|
items:
|
|
type: string
|
|
type: array
|
|
requiresApproval:
|
|
type: boolean
|
|
skipApprovalFor:
|
|
items:
|
|
type: string
|
|
type: array
|
|
type: object
|
|
request.ClientWithUserCreateRequest:
|
|
properties:
|
|
adminUser:
|
|
allOf:
|
|
- $ref: '#/definitions/request.AdminUserCreateRequest'
|
|
description: Admin user information
|
|
client:
|
|
allOf:
|
|
- $ref: '#/definitions/request.ClientsCreateRequest'
|
|
description: Client information
|
|
required:
|
|
- adminUser
|
|
- client
|
|
type: object
|
|
request.ClientsCreateRequest:
|
|
properties:
|
|
clientType:
|
|
description: Enum validation
|
|
enum:
|
|
- parent_client
|
|
- sub_client
|
|
- standalone
|
|
type: string
|
|
description:
|
|
type: string
|
|
maxStorage:
|
|
type: integer
|
|
maxUsers:
|
|
description: Resource limits
|
|
type: integer
|
|
name:
|
|
type: string
|
|
parentClientId:
|
|
description: 'Optional: only for sub_client type'
|
|
type: string
|
|
settings:
|
|
description: Custom settings (JSON string)
|
|
type: string
|
|
required:
|
|
- clientType
|
|
- name
|
|
type: object
|
|
request.ClientsCreateSubClientDetail:
|
|
properties:
|
|
description:
|
|
type: string
|
|
maxStorage:
|
|
type: integer
|
|
maxUsers:
|
|
type: integer
|
|
name:
|
|
type: string
|
|
required:
|
|
- name
|
|
type: object
|
|
request.ClientsUpdateRequest:
|
|
properties:
|
|
clientType:
|
|
enum:
|
|
- parent_client
|
|
- sub_client
|
|
- standalone
|
|
type: string
|
|
description:
|
|
type: string
|
|
isActive:
|
|
type: boolean
|
|
maxStorage:
|
|
type: integer
|
|
maxUsers:
|
|
description: Resource limits
|
|
type: integer
|
|
name:
|
|
type: string
|
|
parentClientId:
|
|
type: string
|
|
settings:
|
|
description: Custom settings
|
|
type: string
|
|
type: object
|
|
request.ComprehensiveWorkflowDetailRequest:
|
|
properties:
|
|
workflowId:
|
|
type: integer
|
|
required:
|
|
- workflowId
|
|
type: object
|
|
request.CreateApprovalWorkflowStepsRequest:
|
|
properties:
|
|
approverRoleId:
|
|
type: integer
|
|
autoApprove:
|
|
type: boolean
|
|
description:
|
|
maxLength: 500
|
|
type: string
|
|
isOptional:
|
|
type: boolean
|
|
requiresComment:
|
|
type: boolean
|
|
stepName:
|
|
maxLength: 100
|
|
minLength: 3
|
|
type: string
|
|
stepOrder:
|
|
minimum: 1
|
|
type: integer
|
|
timeoutHours:
|
|
maximum: 720
|
|
minimum: 1
|
|
type: integer
|
|
workflowId:
|
|
type: integer
|
|
required:
|
|
- approverRoleId
|
|
- stepName
|
|
- stepOrder
|
|
- workflowId
|
|
type: object
|
|
request.CreateApprovalWorkflowWithClientSettingsRequest:
|
|
properties:
|
|
autoPublish:
|
|
type: boolean
|
|
clientApprovalSettings:
|
|
allOf:
|
|
- $ref: '#/definitions/request.ClientApprovalSettingsRequest'
|
|
description: Client approval settings
|
|
description:
|
|
type: string
|
|
isActive:
|
|
type: boolean
|
|
isDefault:
|
|
type: boolean
|
|
name:
|
|
description: Workflow details
|
|
type: string
|
|
requiresApproval:
|
|
type: boolean
|
|
steps:
|
|
items:
|
|
$ref: '#/definitions/request.ApprovalWorkflowStepRequest'
|
|
minItems: 1
|
|
type: array
|
|
required:
|
|
- clientApprovalSettings
|
|
- description
|
|
- name
|
|
- steps
|
|
type: object
|
|
request.CreateClientApprovalSettingsRequest:
|
|
properties:
|
|
approvalExemptCategories:
|
|
items:
|
|
type: integer
|
|
type: array
|
|
approvalExemptRoles:
|
|
items:
|
|
type: integer
|
|
type: array
|
|
approvalExemptUsers:
|
|
items:
|
|
type: integer
|
|
type: array
|
|
autoPublishArticles:
|
|
type: boolean
|
|
defaultWorkflowId:
|
|
minimum: 1
|
|
type: integer
|
|
isActive:
|
|
type: boolean
|
|
requireApprovalFor:
|
|
items:
|
|
type: string
|
|
type: array
|
|
requiresApproval:
|
|
type: boolean
|
|
skipApprovalFor:
|
|
items:
|
|
type: string
|
|
type: array
|
|
type: object
|
|
request.CustomStaticPagesCreateRequest:
|
|
properties:
|
|
description:
|
|
type: string
|
|
htmlBody:
|
|
type: string
|
|
slug:
|
|
type: string
|
|
title:
|
|
type: string
|
|
required:
|
|
- htmlBody
|
|
- slug
|
|
- title
|
|
type: object
|
|
request.CustomStaticPagesUpdateRequest:
|
|
properties:
|
|
description:
|
|
type: string
|
|
htmlBody:
|
|
type: string
|
|
id:
|
|
type: integer
|
|
slug:
|
|
type: string
|
|
title:
|
|
type: string
|
|
updated_at:
|
|
type: string
|
|
required:
|
|
- htmlBody
|
|
- id
|
|
- slug
|
|
- title
|
|
type: object
|
|
request.DisableApprovalRequest:
|
|
properties:
|
|
handleAction:
|
|
description: How to handle pending articles
|
|
enum:
|
|
- auto_approve
|
|
- keep_pending
|
|
- reset_to_draft
|
|
type: string
|
|
reason:
|
|
maxLength: 500
|
|
type: string
|
|
required:
|
|
- handleAction
|
|
- reason
|
|
type: object
|
|
request.EnableApprovalRequest:
|
|
properties:
|
|
defaultWorkflowId:
|
|
minimum: 1
|
|
type: integer
|
|
reason:
|
|
maxLength: 500
|
|
type: string
|
|
type: object
|
|
request.FeedbacksCreateRequest:
|
|
properties:
|
|
commentFromEmail:
|
|
type: string
|
|
commentFromName:
|
|
type: string
|
|
message:
|
|
type: string
|
|
required:
|
|
- commentFromEmail
|
|
- commentFromName
|
|
- message
|
|
type: object
|
|
request.FeedbacksUpdateRequest:
|
|
properties:
|
|
commentFromEmail:
|
|
type: string
|
|
commentFromName:
|
|
type: string
|
|
id:
|
|
type: integer
|
|
message:
|
|
type: string
|
|
required:
|
|
- commentFromEmail
|
|
- commentFromName
|
|
- id
|
|
- message
|
|
type: object
|
|
request.MagazinesCreateRequest:
|
|
properties:
|
|
createdById:
|
|
type: integer
|
|
description:
|
|
type: string
|
|
isPublish:
|
|
type: boolean
|
|
pageUrl:
|
|
type: string
|
|
publishedAt:
|
|
type: string
|
|
statusId:
|
|
type: integer
|
|
thumbnailPath:
|
|
type: string
|
|
thumbnailUrl:
|
|
type: string
|
|
title:
|
|
type: string
|
|
required:
|
|
- description
|
|
- statusId
|
|
- title
|
|
type: object
|
|
request.MagazinesUpdateRequest:
|
|
properties:
|
|
createdById:
|
|
type: integer
|
|
description:
|
|
type: string
|
|
id:
|
|
type: integer
|
|
isPublish:
|
|
type: boolean
|
|
pageUrl:
|
|
type: string
|
|
publishedAt:
|
|
type: string
|
|
statusId:
|
|
type: integer
|
|
thumbnailPath:
|
|
type: string
|
|
thumbnailUrl:
|
|
type: string
|
|
title:
|
|
type: string
|
|
required:
|
|
- description
|
|
- id
|
|
- statusId
|
|
- title
|
|
type: object
|
|
request.MasterMenusCreateRequest:
|
|
properties:
|
|
description:
|
|
type: string
|
|
group:
|
|
type: string
|
|
icon:
|
|
type: string
|
|
moduleId:
|
|
type: integer
|
|
name:
|
|
type: string
|
|
parentMenuId:
|
|
type: integer
|
|
statusId:
|
|
type: integer
|
|
required:
|
|
- description
|
|
- group
|
|
- moduleId
|
|
- name
|
|
- statusId
|
|
type: object
|
|
request.MasterModulesCreateRequest:
|
|
properties:
|
|
description:
|
|
type: string
|
|
name:
|
|
type: string
|
|
pathUrl:
|
|
type: string
|
|
statusId:
|
|
type: integer
|
|
required:
|
|
- description
|
|
- name
|
|
- pathUrl
|
|
- statusId
|
|
type: object
|
|
request.MasterModulesUpdateRequest:
|
|
properties:
|
|
description:
|
|
type: string
|
|
id:
|
|
type: integer
|
|
name:
|
|
type: string
|
|
pathUrl:
|
|
type: string
|
|
statusId:
|
|
type: integer
|
|
required:
|
|
- description
|
|
- id
|
|
- name
|
|
- pathUrl
|
|
- statusId
|
|
type: object
|
|
request.MoveClientRequest:
|
|
properties:
|
|
targetParentId:
|
|
description: null = move to root (standalone)
|
|
type: string
|
|
type: object
|
|
request.ProcessApprovalRequest:
|
|
properties:
|
|
approvalStatusId:
|
|
type: integer
|
|
comments:
|
|
maxLength: 1000
|
|
type: string
|
|
statusId:
|
|
type: integer
|
|
userId:
|
|
type: integer
|
|
required:
|
|
- approvalStatusId
|
|
- statusId
|
|
- userId
|
|
type: object
|
|
request.ReorderApprovalWorkflowStepsRequest:
|
|
properties:
|
|
stepOrders:
|
|
items:
|
|
properties:
|
|
id:
|
|
type: integer
|
|
stepOrder:
|
|
minimum: 1
|
|
type: integer
|
|
required:
|
|
- id
|
|
- stepOrder
|
|
type: object
|
|
minItems: 1
|
|
type: array
|
|
required:
|
|
- stepOrders
|
|
type: object
|
|
request.ResubmitRequest:
|
|
properties:
|
|
message:
|
|
type: string
|
|
type: object
|
|
request.SchedulesCreateRequest:
|
|
properties:
|
|
createdById:
|
|
type: integer
|
|
description:
|
|
type: string
|
|
endDate:
|
|
type: string
|
|
endTime:
|
|
type: string
|
|
isLiveStreaming:
|
|
type: boolean
|
|
liveStreamingUrl:
|
|
type: string
|
|
location:
|
|
type: string
|
|
posterImagePath:
|
|
type: string
|
|
speakers:
|
|
type: string
|
|
startDate:
|
|
type: string
|
|
startTime:
|
|
type: string
|
|
title:
|
|
type: string
|
|
typeId:
|
|
type: integer
|
|
required:
|
|
- description
|
|
- location
|
|
- speakers
|
|
- title
|
|
- typeId
|
|
type: object
|
|
request.SchedulesUpdateRequest:
|
|
properties:
|
|
description:
|
|
type: string
|
|
endDate:
|
|
type: string
|
|
endTime:
|
|
type: string
|
|
isLiveStreaming:
|
|
type: boolean
|
|
liveStreamingUrl:
|
|
type: string
|
|
location:
|
|
type: string
|
|
posterImagePath:
|
|
type: string
|
|
speakers:
|
|
type: string
|
|
startDate:
|
|
type: string
|
|
startTime:
|
|
type: string
|
|
statusId:
|
|
type: integer
|
|
title:
|
|
type: string
|
|
typeId:
|
|
type: integer
|
|
required:
|
|
- description
|
|
- location
|
|
- speakers
|
|
- title
|
|
- typeId
|
|
type: object
|
|
request.SetDefaultWorkflowRequest:
|
|
properties:
|
|
workflowId:
|
|
minimum: 1
|
|
type: integer
|
|
type: object
|
|
request.SubscriptionCreateRequest:
|
|
properties:
|
|
email:
|
|
type: string
|
|
required:
|
|
- email
|
|
type: object
|
|
request.SubscriptionUpdateRequest:
|
|
properties:
|
|
email:
|
|
type: string
|
|
id:
|
|
type: integer
|
|
required:
|
|
- email
|
|
- id
|
|
type: object
|
|
request.ToggleApprovalRequest:
|
|
properties:
|
|
requiresApproval:
|
|
type: boolean
|
|
type: object
|
|
request.UpdateApprovalWorkflowStepsRequest:
|
|
properties:
|
|
approverRoleId:
|
|
type: integer
|
|
autoApprove:
|
|
type: boolean
|
|
description:
|
|
maxLength: 500
|
|
type: string
|
|
isOptional:
|
|
type: boolean
|
|
requiresComment:
|
|
type: boolean
|
|
stepName:
|
|
maxLength: 100
|
|
minLength: 3
|
|
type: string
|
|
stepOrder:
|
|
minimum: 1
|
|
type: integer
|
|
timeoutHours:
|
|
maximum: 720
|
|
minimum: 1
|
|
type: integer
|
|
type: object
|
|
request.UpdateApprovalWorkflowWithClientSettingsRequest:
|
|
properties:
|
|
clientSettings:
|
|
allOf:
|
|
- $ref: '#/definitions/request.ClientApprovalSettingsRequest'
|
|
description: Client approval settings
|
|
description:
|
|
type: string
|
|
isActive:
|
|
type: boolean
|
|
isDefault:
|
|
type: boolean
|
|
name:
|
|
description: Workflow details
|
|
type: string
|
|
steps:
|
|
description: Workflow steps
|
|
items:
|
|
$ref: '#/definitions/request.ApprovalWorkflowStepRequest'
|
|
type: array
|
|
workflowId:
|
|
type: integer
|
|
required:
|
|
- name
|
|
- steps
|
|
- workflowId
|
|
type: object
|
|
request.UpdateClientApprovalSettingsRequest:
|
|
properties:
|
|
approvalExemptCategories:
|
|
items:
|
|
type: integer
|
|
type: array
|
|
approvalExemptRoles:
|
|
items:
|
|
type: integer
|
|
type: array
|
|
approvalExemptUsers:
|
|
items:
|
|
type: integer
|
|
type: array
|
|
autoPublishArticles:
|
|
type: boolean
|
|
defaultWorkflowId:
|
|
description: double pointer to allow nil
|
|
type: integer
|
|
isActive:
|
|
type: boolean
|
|
requireApprovalFor:
|
|
items:
|
|
type: string
|
|
type: array
|
|
requiresApproval:
|
|
type: boolean
|
|
skipApprovalFor:
|
|
items:
|
|
type: string
|
|
type: array
|
|
type: object
|
|
request.UserEmailValidationRequest:
|
|
properties:
|
|
newEmail:
|
|
type: string
|
|
oldEmail:
|
|
type: string
|
|
password:
|
|
type: string
|
|
username:
|
|
type: string
|
|
type: object
|
|
request.UserForgotPassword:
|
|
properties:
|
|
username:
|
|
type: string
|
|
type: object
|
|
request.UserLevelsApprovalRequest:
|
|
properties:
|
|
ids:
|
|
type: string
|
|
isApprovalActive:
|
|
type: boolean
|
|
required:
|
|
- ids
|
|
- isApprovalActive
|
|
type: object
|
|
request.UserLevelsCreateRequest:
|
|
properties:
|
|
aliasName:
|
|
type: string
|
|
group:
|
|
type: string
|
|
isActive:
|
|
type: boolean
|
|
isApprovalActive:
|
|
type: boolean
|
|
levelNumber:
|
|
type: integer
|
|
name:
|
|
type: string
|
|
parentLevelId:
|
|
type: integer
|
|
provinceId:
|
|
type: integer
|
|
required:
|
|
- aliasName
|
|
- levelNumber
|
|
- name
|
|
type: object
|
|
request.UserLevelsUpdateRequest:
|
|
properties:
|
|
aliasName:
|
|
type: string
|
|
group:
|
|
type: string
|
|
isApprovalActive:
|
|
type: boolean
|
|
levelNumber:
|
|
type: integer
|
|
name:
|
|
type: string
|
|
parentLevelId:
|
|
type: integer
|
|
provinceId:
|
|
type: integer
|
|
required:
|
|
- aliasName
|
|
- levelNumber
|
|
- name
|
|
type: object
|
|
request.UserLogin:
|
|
properties:
|
|
password:
|
|
type: string
|
|
refreshToken:
|
|
type: string
|
|
username:
|
|
type: string
|
|
type: object
|
|
request.UserOtpRequest:
|
|
properties:
|
|
email:
|
|
type: string
|
|
name:
|
|
type: string
|
|
required:
|
|
- email
|
|
type: object
|
|
request.UserOtpValidation:
|
|
properties:
|
|
email:
|
|
type: string
|
|
otpCode:
|
|
type: string
|
|
username:
|
|
type: string
|
|
type: object
|
|
request.UserResetPassword:
|
|
properties:
|
|
codeRequest:
|
|
type: string
|
|
confirmPassword:
|
|
type: string
|
|
password:
|
|
type: string
|
|
userId:
|
|
type: string
|
|
type: object
|
|
request.UserRoleAccessesCreateRequest:
|
|
properties:
|
|
isAdminEnabled:
|
|
type: boolean
|
|
isApprovalEnabled:
|
|
type: boolean
|
|
isDeleteEnabled:
|
|
type: boolean
|
|
isInsertEnabled:
|
|
type: boolean
|
|
isUpdateEnabled:
|
|
type: boolean
|
|
isViewEnabled:
|
|
type: boolean
|
|
menuId:
|
|
type: integer
|
|
required:
|
|
- isAdminEnabled
|
|
- isApprovalEnabled
|
|
- isDeleteEnabled
|
|
- isInsertEnabled
|
|
- isUpdateEnabled
|
|
- isViewEnabled
|
|
- menuId
|
|
type: object
|
|
request.UserRoleAccessesUpdateRequest:
|
|
properties:
|
|
id:
|
|
type: integer
|
|
is_admin_enabled:
|
|
type: boolean
|
|
is_approval_enabled:
|
|
type: boolean
|
|
is_delete_enabled:
|
|
type: boolean
|
|
is_insert_enabled:
|
|
type: boolean
|
|
is_update_enabled:
|
|
type: boolean
|
|
is_view_enabled:
|
|
type: boolean
|
|
menu_id:
|
|
type: integer
|
|
user_role_id:
|
|
type: integer
|
|
required:
|
|
- id
|
|
- is_admin_enabled
|
|
- is_approval_enabled
|
|
- is_delete_enabled
|
|
- is_insert_enabled
|
|
- is_update_enabled
|
|
- is_view_enabled
|
|
- menu_id
|
|
- user_role_id
|
|
type: object
|
|
request.UserRolesCreateRequest:
|
|
properties:
|
|
code:
|
|
type: string
|
|
description:
|
|
type: string
|
|
name:
|
|
type: string
|
|
statusId:
|
|
type: integer
|
|
userLevelIds:
|
|
items:
|
|
type: integer
|
|
type: array
|
|
userRoleAccess:
|
|
items:
|
|
$ref: '#/definitions/request.UserRoleAccessesCreateRequest'
|
|
type: array
|
|
required:
|
|
- code
|
|
- description
|
|
- name
|
|
- statusId
|
|
- userLevelIds
|
|
- userRoleAccess
|
|
type: object
|
|
request.UserRolesUpdateRequest:
|
|
properties:
|
|
code:
|
|
type: string
|
|
description:
|
|
type: string
|
|
level_number:
|
|
type: integer
|
|
name:
|
|
type: string
|
|
status_id:
|
|
type: integer
|
|
userLevelIds:
|
|
items:
|
|
type: integer
|
|
type: array
|
|
required:
|
|
- code
|
|
- description
|
|
- level_number
|
|
- name
|
|
- status_id
|
|
- userLevelIds
|
|
type: object
|
|
request.UserSavePassword:
|
|
properties:
|
|
confirmPassword:
|
|
type: string
|
|
password:
|
|
type: string
|
|
type: object
|
|
request.UsersCreateRequest:
|
|
properties:
|
|
address:
|
|
type: string
|
|
clientId:
|
|
type: string
|
|
dateOfBirth:
|
|
type: string
|
|
email:
|
|
type: string
|
|
fullname:
|
|
type: string
|
|
genderType:
|
|
type: string
|
|
identityGroup:
|
|
type: string
|
|
identityGroupNumber:
|
|
type: string
|
|
identityNumber:
|
|
type: string
|
|
identityType:
|
|
type: string
|
|
lastEducation:
|
|
type: string
|
|
password:
|
|
type: string
|
|
phoneNumber:
|
|
type: string
|
|
userLevelId:
|
|
type: integer
|
|
userRoleId:
|
|
type: integer
|
|
username:
|
|
type: string
|
|
workType:
|
|
type: string
|
|
required:
|
|
- email
|
|
- fullname
|
|
- password
|
|
- userLevelId
|
|
- userRoleId
|
|
- username
|
|
type: object
|
|
request.UsersUpdateRequest:
|
|
properties:
|
|
address:
|
|
type: string
|
|
dateOfBirth:
|
|
type: string
|
|
email:
|
|
type: string
|
|
fullname:
|
|
type: string
|
|
genderType:
|
|
type: string
|
|
identityGroup:
|
|
type: string
|
|
identityGroupNumber:
|
|
type: string
|
|
identityNumber:
|
|
type: string
|
|
identityType:
|
|
type: string
|
|
lastEducation:
|
|
type: string
|
|
phoneNumber:
|
|
type: string
|
|
statusId:
|
|
type: integer
|
|
userLevelId:
|
|
type: integer
|
|
userRoleId:
|
|
type: integer
|
|
username:
|
|
type: string
|
|
workType:
|
|
type: string
|
|
required:
|
|
- email
|
|
- fullname
|
|
- userLevelId
|
|
- userRoleId
|
|
- username
|
|
type: object
|
|
response.BadRequestError:
|
|
properties:
|
|
code:
|
|
example: 400
|
|
type: integer
|
|
message:
|
|
example: bad request
|
|
type: string
|
|
success:
|
|
example: false
|
|
type: boolean
|
|
type: object
|
|
response.InternalServerError:
|
|
properties:
|
|
code:
|
|
example: 500
|
|
type: integer
|
|
message:
|
|
example: internal server error
|
|
type: string
|
|
success:
|
|
example: false
|
|
type: boolean
|
|
type: object
|
|
response.Response:
|
|
properties:
|
|
code:
|
|
example: 200
|
|
type: integer
|
|
data: {}
|
|
messages:
|
|
items: {}
|
|
type: array
|
|
meta: {}
|
|
success:
|
|
example: true
|
|
type: boolean
|
|
type: object
|
|
response.UnauthorizedError:
|
|
properties:
|
|
code:
|
|
example: 401
|
|
type: integer
|
|
message:
|
|
example: unauthorized access
|
|
type: string
|
|
success:
|
|
example: false
|
|
type: boolean
|
|
type: object
|
|
info:
|
|
contact: {}
|
|
paths:
|
|
/activity-logs:
|
|
get:
|
|
description: API for getting all ActivityLogs
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
type: string
|
|
- in: query
|
|
name: activityTypeId
|
|
type: integer
|
|
- in: query
|
|
name: articleId
|
|
type: integer
|
|
- in: query
|
|
name: url
|
|
type: string
|
|
- in: query
|
|
name: userId
|
|
type: integer
|
|
- in: query
|
|
name: count
|
|
type: integer
|
|
- in: query
|
|
name: limit
|
|
type: integer
|
|
- in: query
|
|
name: nextPage
|
|
type: integer
|
|
- in: query
|
|
name: page
|
|
type: integer
|
|
- in: query
|
|
name: previousPage
|
|
type: integer
|
|
- in: query
|
|
name: sort
|
|
type: string
|
|
- in: query
|
|
name: sortBy
|
|
type: string
|
|
- in: query
|
|
name: totalPage
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get all ActivityLogs
|
|
tags:
|
|
- ActivityLogs
|
|
post:
|
|
description: API for create ActivityLogs
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
type: string
|
|
- description: Insert the X-Csrf-Token
|
|
in: header
|
|
name: X-Csrf-Token
|
|
type: string
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.ActivityLogsCreateRequest'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Create ActivityLogs
|
|
tags:
|
|
- ActivityLogs
|
|
/activity-logs/{id}:
|
|
delete:
|
|
description: API for delete ActivityLogs
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
type: string
|
|
- description: Insert the X-Csrf-Token
|
|
in: header
|
|
name: X-Csrf-Token
|
|
type: string
|
|
- description: ActivityLogs ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: delete ActivityLogs
|
|
tags:
|
|
- ActivityLogs
|
|
put:
|
|
description: API for update ActivityLogs
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
type: string
|
|
- description: Insert the X-Csrf-Token
|
|
in: header
|
|
name: X-Csrf-Token
|
|
type: string
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.ActivityLogsUpdateRequest'
|
|
- description: ActivityLogs ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: update ActivityLogs
|
|
tags:
|
|
- ActivityLogs
|
|
/activity-logs/detail/{id}:
|
|
get:
|
|
description: API for getting one ActivityLogs
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
type: string
|
|
- description: ActivityLogs ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get one ActivityLogs
|
|
tags:
|
|
- ActivityLogs
|
|
/activity-logs/statistics:
|
|
get:
|
|
description: API for get activity stats ActivityLogs
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get activity stats ActivityLogs
|
|
tags:
|
|
- ActivityLogs
|
|
/advertisement:
|
|
get:
|
|
description: API for getting all Advertisement
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
type: string
|
|
- in: query
|
|
name: description
|
|
type: string
|
|
- in: query
|
|
name: isPublish
|
|
type: boolean
|
|
- in: query
|
|
name: placement
|
|
type: string
|
|
- in: query
|
|
name: redirectLink
|
|
type: string
|
|
- in: query
|
|
name: statusId
|
|
type: integer
|
|
- in: query
|
|
name: title
|
|
type: string
|
|
- in: query
|
|
name: count
|
|
type: integer
|
|
- in: query
|
|
name: limit
|
|
type: integer
|
|
- in: query
|
|
name: nextPage
|
|
type: integer
|
|
- in: query
|
|
name: page
|
|
type: integer
|
|
- in: query
|
|
name: previousPage
|
|
type: integer
|
|
- in: query
|
|
name: sort
|
|
type: string
|
|
- in: query
|
|
name: sortBy
|
|
type: string
|
|
- in: query
|
|
name: totalPage
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get all Advertisement
|
|
tags:
|
|
- Advertisement
|
|
post:
|
|
description: API for create Advertisement
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
type: string
|
|
- description: Insert the X-Csrf-Token
|
|
in: header
|
|
name: X-Csrf-Token
|
|
type: string
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.AdvertisementCreateRequest'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Create Advertisement
|
|
tags:
|
|
- Advertisement
|
|
/advertisement/{id}:
|
|
delete:
|
|
description: API for delete Advertisement
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
type: string
|
|
- description: Insert the X-Csrf-Token
|
|
in: header
|
|
name: X-Csrf-Token
|
|
type: string
|
|
- description: Advertisement ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: delete Advertisement
|
|
tags:
|
|
- Advertisement
|
|
get:
|
|
description: API for getting one Advertisement
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
type: string
|
|
- description: Advertisement ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get one Advertisement
|
|
tags:
|
|
- Advertisement
|
|
put:
|
|
description: API for update Advertisement
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
type: string
|
|
- description: Insert the X-Csrf-Token
|
|
in: header
|
|
name: X-Csrf-Token
|
|
type: string
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.AdvertisementUpdateRequest'
|
|
- description: Advertisement ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: update Advertisement
|
|
tags:
|
|
- Advertisement
|
|
/advertisement/publish/{id}:
|
|
put:
|
|
description: API for Update Publish Advertisement
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
type: string
|
|
- description: Insert the X-Csrf-Token
|
|
in: header
|
|
name: X-Csrf-Token
|
|
type: string
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- description: Advertisement ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
- description: Advertisement Publish Status
|
|
in: query
|
|
name: isPublish
|
|
required: true
|
|
type: boolean
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Update Publish Advertisement
|
|
tags:
|
|
- Advertisement
|
|
/advertisement/upload/{id}:
|
|
post:
|
|
description: API for Upload File Advertisement
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
type: string
|
|
- description: Insert the X-Csrf-Token
|
|
in: header
|
|
name: X-Csrf-Token
|
|
type: string
|
|
- description: Upload file
|
|
in: formData
|
|
name: file
|
|
required: true
|
|
type: file
|
|
- description: Advertisement ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Upload Advertisement
|
|
tags:
|
|
- Advertisement
|
|
/advertisement/viewer/{filename}:
|
|
get:
|
|
description: API for Viewer Advertisement
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
type: string
|
|
- description: Content File Name
|
|
in: path
|
|
name: filename
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Viewer Advertisement
|
|
tags:
|
|
- Advertisement
|
|
/approval-workflow-steps:
|
|
get:
|
|
description: API for getting all ApprovalWorkflowSteps
|
|
parameters:
|
|
- description: Insert the Authorization
|
|
in: header
|
|
name: Authorization
|
|
required: true
|
|
type: string
|
|
- description: Workflow ID filter
|
|
in: query
|
|
name: workflowId
|
|
type: integer
|
|
- description: Step order filter
|
|
in: query
|
|
name: stepOrder
|
|
type: integer
|
|
- description: Step name filter
|
|
in: query
|
|
name: stepName
|
|
type: string
|
|
- description: User level ID filter
|
|
in: query
|
|
name: userLevelId
|
|
type: integer
|
|
- description: Is optional filter
|
|
in: query
|
|
name: isOptional
|
|
type: boolean
|
|
- description: Is active filter
|
|
in: query
|
|
name: isActive
|
|
type: boolean
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get all ApprovalWorkflowSteps
|
|
tags:
|
|
- ApprovalWorkflowSteps
|
|
post:
|
|
description: API for saving ApprovalWorkflowSteps
|
|
parameters:
|
|
- description: Insert the Authorization
|
|
in: header
|
|
name: Authorization
|
|
required: true
|
|
type: string
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.CreateApprovalWorkflowStepsRequest'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Save ApprovalWorkflowSteps
|
|
tags:
|
|
- ApprovalWorkflowSteps
|
|
/approval-workflow-steps/{id}:
|
|
delete:
|
|
description: API for deleting ApprovalWorkflowSteps
|
|
parameters:
|
|
- description: Insert the Authorization
|
|
in: header
|
|
name: Authorization
|
|
required: true
|
|
type: string
|
|
- description: ApprovalWorkflowSteps ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Delete ApprovalWorkflowSteps
|
|
tags:
|
|
- ApprovalWorkflowSteps
|
|
get:
|
|
description: API for getting one ApprovalWorkflowSteps
|
|
parameters:
|
|
- description: Insert the Authorization
|
|
in: header
|
|
name: Authorization
|
|
required: true
|
|
type: string
|
|
- description: ApprovalWorkflowSteps ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get one ApprovalWorkflowSteps
|
|
tags:
|
|
- ApprovalWorkflowSteps
|
|
put:
|
|
description: API for updating ApprovalWorkflowSteps
|
|
parameters:
|
|
- description: Insert the Authorization
|
|
in: header
|
|
name: Authorization
|
|
required: true
|
|
type: string
|
|
- description: ApprovalWorkflowSteps ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.UpdateApprovalWorkflowStepsRequest'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Update ApprovalWorkflowSteps
|
|
tags:
|
|
- ApprovalWorkflowSteps
|
|
/approval-workflow-steps/bulk:
|
|
post:
|
|
description: API for bulk creating ApprovalWorkflowSteps
|
|
parameters:
|
|
- description: Insert the Authorization
|
|
in: header
|
|
name: Authorization
|
|
required: true
|
|
type: string
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.BulkCreateApprovalWorkflowStepsRequest'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Bulk create ApprovalWorkflowSteps
|
|
tags:
|
|
- ApprovalWorkflowSteps
|
|
/approval-workflow-steps/role/{roleId}:
|
|
get:
|
|
description: API for getting ApprovalWorkflowSteps by Role ID
|
|
parameters:
|
|
- description: Insert the Authorization
|
|
in: header
|
|
name: Authorization
|
|
required: true
|
|
type: string
|
|
- description: Role ID
|
|
in: path
|
|
name: roleId
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get ApprovalWorkflowSteps by Role ID
|
|
tags:
|
|
- ApprovalWorkflowSteps
|
|
/approval-workflow-steps/workflow/{workflowId}:
|
|
get:
|
|
description: API for getting ApprovalWorkflowSteps by Workflow ID
|
|
parameters:
|
|
- description: Insert the Authorization
|
|
in: header
|
|
name: Authorization
|
|
required: true
|
|
type: string
|
|
- description: Workflow ID
|
|
in: path
|
|
name: workflowId
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get ApprovalWorkflowSteps by Workflow ID
|
|
tags:
|
|
- ApprovalWorkflowSteps
|
|
/approval-workflow-steps/workflow/{workflowId}/reorder:
|
|
put:
|
|
description: API for reordering ApprovalWorkflowSteps
|
|
parameters:
|
|
- description: Insert the Authorization
|
|
in: header
|
|
name: Authorization
|
|
required: true
|
|
type: string
|
|
- description: Workflow ID
|
|
in: path
|
|
name: workflowId
|
|
required: true
|
|
type: integer
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.ReorderApprovalWorkflowStepsRequest'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Reorder ApprovalWorkflowSteps
|
|
tags:
|
|
- ApprovalWorkflowSteps
|
|
/approval-workflows:
|
|
get:
|
|
description: API for getting all ApprovalWorkflows
|
|
parameters:
|
|
- description: Insert the Authorization
|
|
in: header
|
|
name: Authorization
|
|
required: true
|
|
type: string
|
|
- in: query
|
|
name: description
|
|
type: string
|
|
- in: query
|
|
name: isActive
|
|
type: boolean
|
|
- in: query
|
|
name: isDefault
|
|
type: boolean
|
|
- in: query
|
|
name: name
|
|
type: string
|
|
- in: query
|
|
name: count
|
|
type: integer
|
|
- in: query
|
|
name: limit
|
|
type: integer
|
|
- in: query
|
|
name: nextPage
|
|
type: integer
|
|
- in: query
|
|
name: page
|
|
type: integer
|
|
- in: query
|
|
name: previousPage
|
|
type: integer
|
|
- in: query
|
|
name: sort
|
|
type: string
|
|
- in: query
|
|
name: sortBy
|
|
type: string
|
|
- in: query
|
|
name: totalPage
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get all ApprovalWorkflows
|
|
tags:
|
|
- ApprovalWorkflows
|
|
post:
|
|
description: API for saving ApprovalWorkflows
|
|
parameters:
|
|
- description: Insert the Authorization
|
|
in: header
|
|
name: Authorization
|
|
required: true
|
|
type: string
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.ApprovalWorkflowsCreateRequest'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Save ApprovalWorkflows
|
|
tags:
|
|
- ApprovalWorkflows
|
|
/approval-workflows/{id}:
|
|
delete:
|
|
description: API for deleting ApprovalWorkflows
|
|
parameters:
|
|
- description: Insert the Authorization
|
|
in: header
|
|
name: Authorization
|
|
required: true
|
|
type: string
|
|
- description: ApprovalWorkflows ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Delete ApprovalWorkflows
|
|
tags:
|
|
- ApprovalWorkflows
|
|
get:
|
|
description: API for getting one ApprovalWorkflows
|
|
parameters:
|
|
- description: Insert the Authorization
|
|
in: header
|
|
name: Authorization
|
|
required: true
|
|
type: string
|
|
- description: ApprovalWorkflows ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get one ApprovalWorkflows
|
|
tags:
|
|
- ApprovalWorkflows
|
|
put:
|
|
description: API for updating ApprovalWorkflows
|
|
parameters:
|
|
- description: Insert the Authorization
|
|
in: header
|
|
name: Authorization
|
|
required: true
|
|
type: string
|
|
- description: ApprovalWorkflows ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.ApprovalWorkflowsUpdateRequest'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Update ApprovalWorkflows
|
|
tags:
|
|
- ApprovalWorkflows
|
|
/approval-workflows/{id}/activate:
|
|
put:
|
|
description: API for activating ApprovalWorkflows
|
|
parameters:
|
|
- description: Insert the Authorization
|
|
in: header
|
|
name: Authorization
|
|
required: true
|
|
type: string
|
|
- description: ApprovalWorkflows ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Activate ApprovalWorkflows
|
|
tags:
|
|
- ApprovalWorkflows
|
|
/approval-workflows/{id}/deactivate:
|
|
put:
|
|
description: API for deactivating ApprovalWorkflows
|
|
parameters:
|
|
- description: Insert the Authorization
|
|
in: header
|
|
name: Authorization
|
|
required: true
|
|
type: string
|
|
- description: ApprovalWorkflows ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Deactivate ApprovalWorkflows
|
|
tags:
|
|
- ApprovalWorkflows
|
|
/approval-workflows/{id}/set-default:
|
|
put:
|
|
description: API for setting default ApprovalWorkflows
|
|
parameters:
|
|
- description: Insert the Authorization
|
|
in: header
|
|
name: Authorization
|
|
required: true
|
|
type: string
|
|
- description: ApprovalWorkflows ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Set default ApprovalWorkflows
|
|
tags:
|
|
- ApprovalWorkflows
|
|
/approval-workflows/{id}/with-steps:
|
|
get:
|
|
description: API for getting ApprovalWorkflows with steps
|
|
parameters:
|
|
- description: Insert the Authorization
|
|
in: header
|
|
name: Authorization
|
|
required: true
|
|
type: string
|
|
- description: ApprovalWorkflows ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get ApprovalWorkflows with steps
|
|
tags:
|
|
- ApprovalWorkflows
|
|
put:
|
|
description: API for updating ApprovalWorkflows with steps
|
|
parameters:
|
|
- description: Insert the Authorization
|
|
in: header
|
|
name: Authorization
|
|
required: true
|
|
type: string
|
|
- description: ApprovalWorkflows ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
- description: ApprovalWorkflows with steps data
|
|
in: body
|
|
name: req
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.ApprovalWorkflowsWithStepsUpdateRequest'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Update ApprovalWorkflows with steps
|
|
tags:
|
|
- ApprovalWorkflows
|
|
/approval-workflows/comprehensive-details:
|
|
post:
|
|
description: API for getting comprehensive details of approval workflow including
|
|
steps, client settings, and related data
|
|
parameters:
|
|
- description: Insert the Authorization
|
|
in: header
|
|
name: Authorization
|
|
required: true
|
|
type: string
|
|
- description: Workflow detail request
|
|
in: body
|
|
name: req
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.ComprehensiveWorkflowDetailRequest'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get comprehensive approval workflow details
|
|
tags:
|
|
- ApprovalWorkflows
|
|
/approval-workflows/default:
|
|
get:
|
|
description: API for getting default ApprovalWorkflows
|
|
parameters:
|
|
- description: Insert the Authorization
|
|
in: header
|
|
name: Authorization
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get default ApprovalWorkflows
|
|
tags:
|
|
- ApprovalWorkflows
|
|
/approval-workflows/with-client-settings:
|
|
post:
|
|
description: API for creating ApprovalWorkflows with workflow steps and client
|
|
approval settings in a single call
|
|
parameters:
|
|
- description: Insert the Authorization
|
|
in: header
|
|
name: Authorization
|
|
required: true
|
|
type: string
|
|
- description: Comprehensive approval workflow data
|
|
in: body
|
|
name: req
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.CreateApprovalWorkflowWithClientSettingsRequest'
|
|
responses:
|
|
"201":
|
|
description: Created
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Create comprehensive ApprovalWorkflows with client settings
|
|
tags:
|
|
- ApprovalWorkflows
|
|
put:
|
|
description: API for updating ApprovalWorkflows with workflow steps and client
|
|
approval settings in a single call
|
|
parameters:
|
|
- description: Insert the Authorization
|
|
in: header
|
|
name: Authorization
|
|
required: true
|
|
type: string
|
|
- description: Comprehensive approval workflow update data
|
|
in: body
|
|
name: req
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.UpdateApprovalWorkflowWithClientSettingsRequest'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Update comprehensive ApprovalWorkflows with client settings
|
|
tags:
|
|
- ApprovalWorkflows
|
|
/approval-workflows/with-steps:
|
|
post:
|
|
description: API for creating ApprovalWorkflows with steps
|
|
parameters:
|
|
- description: Insert the Authorization
|
|
in: header
|
|
name: Authorization
|
|
required: true
|
|
type: string
|
|
- description: ApprovalWorkflows with steps data
|
|
in: body
|
|
name: req
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.ApprovalWorkflowsWithStepsCreateRequest'
|
|
responses:
|
|
"201":
|
|
description: Created
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Create ApprovalWorkflows with steps
|
|
tags:
|
|
- ApprovalWorkflows
|
|
/article-approval-flows:
|
|
get:
|
|
description: API for getting all ArticleApprovalFlows
|
|
parameters:
|
|
- description: Insert the Authorization
|
|
in: header
|
|
name: Authorization
|
|
required: true
|
|
type: string
|
|
- in: query
|
|
name: articleId
|
|
type: integer
|
|
- in: query
|
|
name: currentStep
|
|
type: integer
|
|
- in: query
|
|
name: dateFrom
|
|
type: string
|
|
- in: query
|
|
name: dateTo
|
|
type: string
|
|
- in: query
|
|
name: statusId
|
|
type: integer
|
|
- in: query
|
|
name: submittedBy
|
|
type: integer
|
|
- in: query
|
|
name: workflowId
|
|
type: integer
|
|
- in: query
|
|
name: count
|
|
type: integer
|
|
- in: query
|
|
name: limit
|
|
type: integer
|
|
- in: query
|
|
name: nextPage
|
|
type: integer
|
|
- in: query
|
|
name: page
|
|
type: integer
|
|
- in: query
|
|
name: previousPage
|
|
type: integer
|
|
- in: query
|
|
name: sort
|
|
type: string
|
|
- in: query
|
|
name: sortBy
|
|
type: string
|
|
- in: query
|
|
name: totalPage
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get all ArticleApprovalFlows
|
|
tags:
|
|
- ArticleApprovalFlows
|
|
/article-approval-flows/{id}:
|
|
get:
|
|
description: API for getting one ArticleApprovalFlows
|
|
parameters:
|
|
- description: Insert the Authorization
|
|
in: header
|
|
name: Authorization
|
|
required: true
|
|
type: string
|
|
- description: ArticleApprovalFlows ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get one ArticleApprovalFlows
|
|
tags:
|
|
- ArticleApprovalFlows
|
|
/article-approval-flows/{id}/approve:
|
|
put:
|
|
description: API for approving article
|
|
parameters:
|
|
- description: Insert the Authorization
|
|
in: header
|
|
name: Authorization
|
|
required: true
|
|
type: string
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- description: ArticleApprovalFlows ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
- description: Approval action data
|
|
in: body
|
|
name: req
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.ApprovalActionRequest'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Approve article
|
|
tags:
|
|
- ArticleApprovalFlows
|
|
/article-approval-flows/{id}/multi-branch-approve:
|
|
post:
|
|
description: API for processing multi-branch approval with conditional routing
|
|
parameters:
|
|
- description: Insert the Authorization
|
|
in: header
|
|
name: Authorization
|
|
required: true
|
|
type: string
|
|
- description: ArticleApprovalFlows ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
- description: Approval action data
|
|
in: body
|
|
name: req
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.ApprovalActionRequest'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Process multi-branch approval
|
|
tags:
|
|
- ArticleApprovalFlows
|
|
/article-approval-flows/{id}/next-steps-preview:
|
|
get:
|
|
description: API for getting preview of next steps based on submitter's user
|
|
level
|
|
parameters:
|
|
- description: Insert the Authorization
|
|
in: header
|
|
name: Authorization
|
|
required: true
|
|
type: string
|
|
- description: ArticleApprovalFlows ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get next steps preview for multi-branch workflow
|
|
tags:
|
|
- ArticleApprovalFlows
|
|
/article-approval-flows/{id}/resubmit:
|
|
put:
|
|
description: API for resubmitting article after revision
|
|
parameters:
|
|
- description: Insert the Authorization
|
|
in: header
|
|
name: Authorization
|
|
required: true
|
|
type: string
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- description: ArticleApprovalFlows ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
- description: Resubmit data
|
|
in: body
|
|
name: req
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.ResubmitRequest'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Resubmit article after revision
|
|
tags:
|
|
- ArticleApprovalFlows
|
|
/article-approval-flows/analytics:
|
|
get:
|
|
description: API for getting approval analytics
|
|
parameters:
|
|
- description: Insert the Authorization
|
|
in: header
|
|
name: Authorization
|
|
required: true
|
|
type: string
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- description: Period filter (daily, weekly, monthly)
|
|
in: query
|
|
name: period
|
|
type: string
|
|
- description: Start date filter (YYYY-MM-DD)
|
|
in: query
|
|
name: startDate
|
|
type: string
|
|
- description: End date filter (YYYY-MM-DD)
|
|
in: query
|
|
name: endDate
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get approval analytics
|
|
tags:
|
|
- ArticleApprovalFlows
|
|
/article-approval-flows/articles/{articleId}/approve:
|
|
post:
|
|
description: API for approving an article using its currently active approval
|
|
flow (simplified version)
|
|
parameters:
|
|
- description: Insert the Authorization
|
|
in: header
|
|
name: Authorization
|
|
required: true
|
|
type: string
|
|
- description: Article ID
|
|
in: path
|
|
name: articleId
|
|
required: true
|
|
type: integer
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.ApprovalActionRequest'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Approve article by its active approval flow
|
|
tags:
|
|
- ArticleApprovalFlows
|
|
/article-approval-flows/dashboard-stats:
|
|
get:
|
|
description: API for getting dashboard statistics
|
|
parameters:
|
|
- description: Insert the Authorization
|
|
in: header
|
|
name: Authorization
|
|
required: true
|
|
type: string
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get dashboard statistics
|
|
tags:
|
|
- ArticleApprovalFlows
|
|
/article-approval-flows/history:
|
|
get:
|
|
description: API for getting approval history
|
|
parameters:
|
|
- description: Insert the Authorization
|
|
in: header
|
|
name: Authorization
|
|
required: true
|
|
type: string
|
|
- description: Article ID filter
|
|
in: query
|
|
name: articleId
|
|
type: integer
|
|
- description: User ID filter
|
|
in: query
|
|
name: userId
|
|
type: integer
|
|
- in: query
|
|
name: count
|
|
type: integer
|
|
- in: query
|
|
name: limit
|
|
type: integer
|
|
- in: query
|
|
name: nextPage
|
|
type: integer
|
|
- in: query
|
|
name: page
|
|
type: integer
|
|
- in: query
|
|
name: previousPage
|
|
type: integer
|
|
- in: query
|
|
name: sort
|
|
type: string
|
|
- in: query
|
|
name: sortBy
|
|
type: string
|
|
- in: query
|
|
name: totalPage
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get approval history
|
|
tags:
|
|
- ArticleApprovalFlows
|
|
/article-approval-flows/my-queue:
|
|
get:
|
|
description: API for getting my approval queue
|
|
parameters:
|
|
- description: Insert the Authorization
|
|
in: header
|
|
name: Authorization
|
|
required: true
|
|
type: string
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- description: Include article preview
|
|
in: query
|
|
name: includePreview
|
|
type: boolean
|
|
- description: Show only urgent articles
|
|
in: query
|
|
name: urgentOnly
|
|
type: boolean
|
|
- in: query
|
|
name: count
|
|
type: integer
|
|
- in: query
|
|
name: limit
|
|
type: integer
|
|
- in: query
|
|
name: nextPage
|
|
type: integer
|
|
- in: query
|
|
name: page
|
|
type: integer
|
|
- in: query
|
|
name: previousPage
|
|
type: integer
|
|
- in: query
|
|
name: sort
|
|
type: string
|
|
- in: query
|
|
name: sortBy
|
|
type: string
|
|
- in: query
|
|
name: totalPage
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get my approval queue
|
|
tags:
|
|
- ArticleApprovalFlows
|
|
/article-approval-flows/pending:
|
|
get:
|
|
description: API for getting pending approvals
|
|
parameters:
|
|
- description: Insert the Authorization
|
|
in: header
|
|
name: Authorization
|
|
required: true
|
|
type: string
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- in: query
|
|
name: count
|
|
type: integer
|
|
- in: query
|
|
name: limit
|
|
type: integer
|
|
- in: query
|
|
name: nextPage
|
|
type: integer
|
|
- in: query
|
|
name: page
|
|
type: integer
|
|
- in: query
|
|
name: previousPage
|
|
type: integer
|
|
- in: query
|
|
name: sort
|
|
type: string
|
|
- in: query
|
|
name: sortBy
|
|
type: string
|
|
- in: query
|
|
name: totalPage
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get pending approvals
|
|
tags:
|
|
- ArticleApprovalFlows
|
|
/article-approval-flows/submit:
|
|
post:
|
|
description: API for submitting article for approval
|
|
parameters:
|
|
- description: Insert the Authorization
|
|
in: header
|
|
name: Authorization
|
|
required: true
|
|
type: string
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- description: Submit for approval data
|
|
in: body
|
|
name: req
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/netidhub-saas-be_app_module_article_approval_flows_request.SubmitForApprovalRequest'
|
|
responses:
|
|
"201":
|
|
description: Created
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Submit article for approval
|
|
tags:
|
|
- ArticleApprovalFlows
|
|
/article-approval-flows/workload-stats:
|
|
get:
|
|
description: API for getting workload statistics
|
|
parameters:
|
|
- description: Insert the Authorization
|
|
in: header
|
|
name: Authorization
|
|
required: true
|
|
type: string
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get workload statistics
|
|
tags:
|
|
- ArticleApprovalFlows
|
|
/article-approval-step-logs:
|
|
get:
|
|
description: API for getting all ArticleApprovalStepLogs
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
required: true
|
|
type: string
|
|
- in: query
|
|
name: approvalStatusId
|
|
type: integer
|
|
- in: query
|
|
name: approverUserId
|
|
type: integer
|
|
- in: query
|
|
name: articleApprovalFlowId
|
|
type: integer
|
|
- in: query
|
|
name: dateFrom
|
|
type: string
|
|
- in: query
|
|
name: dateTo
|
|
type: string
|
|
- in: query
|
|
name: isAutoApproved
|
|
type: boolean
|
|
- in: query
|
|
name: workflowStepId
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get all ArticleApprovalStepLogs
|
|
tags:
|
|
- ArticleApprovalStepLogs
|
|
post:
|
|
description: API for saving ArticleApprovalStepLogs
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
required: true
|
|
type: string
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.ArticleApprovalStepLogsCreateRequest'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Save ArticleApprovalStepLogs
|
|
tags:
|
|
- ArticleApprovalStepLogs
|
|
/article-approval-step-logs/{id}:
|
|
delete:
|
|
description: API for deleting ArticleApprovalStepLogs
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
required: true
|
|
type: string
|
|
- description: ArticleApprovalStepLogs ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Delete ArticleApprovalStepLogs
|
|
tags:
|
|
- ArticleApprovalStepLogs
|
|
get:
|
|
description: API for getting one ArticleApprovalStepLogs
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
required: true
|
|
type: string
|
|
- description: ArticleApprovalStepLogs ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get one ArticleApprovalStepLogs
|
|
tags:
|
|
- ArticleApprovalStepLogs
|
|
put:
|
|
description: API for updating ArticleApprovalStepLogs
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
required: true
|
|
type: string
|
|
- description: ArticleApprovalStepLogs ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.ArticleApprovalStepLogsUpdateRequest'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Update ArticleApprovalStepLogs
|
|
tags:
|
|
- ArticleApprovalStepLogs
|
|
/article-approval-step-logs/{id}/auto-approve:
|
|
post:
|
|
description: API for automatically approving a step
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
required: true
|
|
type: string
|
|
- description: Step Log ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
- description: Auto approval reason
|
|
in: query
|
|
name: reason
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Auto Approve Step
|
|
tags:
|
|
- ArticleApprovalStepLogs
|
|
/article-approval-step-logs/{id}/process:
|
|
post:
|
|
description: API for processing approval step
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
required: true
|
|
type: string
|
|
- description: Step Log ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.ProcessApprovalRequest'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Process Approval
|
|
tags:
|
|
- ArticleApprovalStepLogs
|
|
/article-approval-step-logs/approver/{user_id}:
|
|
get:
|
|
description: API for getting ArticleApprovalStepLogs by Approver User ID
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
required: true
|
|
type: string
|
|
- description: Approver User ID
|
|
in: path
|
|
name: user_id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get ArticleApprovalStepLogs by Approver User ID
|
|
tags:
|
|
- ArticleApprovalStepLogs
|
|
/article-approval-step-logs/bulk-process:
|
|
post:
|
|
description: API for bulk processing approval steps
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
required: true
|
|
type: string
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.BulkProcessApprovalRequest'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Bulk Process Approvals
|
|
tags:
|
|
- ArticleApprovalStepLogs
|
|
/article-approval-step-logs/flow/{flow_id}:
|
|
get:
|
|
description: API for getting ArticleApprovalStepLogs by Approval Flow ID
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
required: true
|
|
type: string
|
|
- description: Approval Flow ID
|
|
in: path
|
|
name: flow_id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get ArticleApprovalStepLogs by Approval Flow ID
|
|
tags:
|
|
- ArticleApprovalStepLogs
|
|
/article-approval-step-logs/history:
|
|
get:
|
|
description: API for getting approval history
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
required: true
|
|
type: string
|
|
- description: Filter by article ID
|
|
in: query
|
|
name: article_id
|
|
type: integer
|
|
- description: Filter by user ID
|
|
in: query
|
|
name: user_id
|
|
type: integer
|
|
- description: Filter from date (YYYY-MM-DD)
|
|
in: query
|
|
name: from_date
|
|
type: string
|
|
- description: Filter to date (YYYY-MM-DD)
|
|
in: query
|
|
name: to_date
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get Approval History
|
|
tags:
|
|
- ArticleApprovalStepLogs
|
|
/article-approval-step-logs/overdue:
|
|
get:
|
|
description: API for getting overdue approvals
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
required: true
|
|
type: string
|
|
- description: Filter by user ID
|
|
in: query
|
|
name: user_id
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get Overdue Approvals
|
|
tags:
|
|
- ArticleApprovalStepLogs
|
|
/article-approval-step-logs/pending:
|
|
get:
|
|
description: API for getting pending approvals
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
required: true
|
|
type: string
|
|
- description: Filter by user ID
|
|
in: query
|
|
name: user_id
|
|
type: integer
|
|
- description: Filter by role ID
|
|
in: query
|
|
name: role_id
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get Pending Approvals
|
|
tags:
|
|
- ArticleApprovalStepLogs
|
|
/article-approval-step-logs/stats:
|
|
get:
|
|
description: API for getting approval statistics
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
required: true
|
|
type: string
|
|
- description: Filter from date (YYYY-MM-DD)
|
|
in: query
|
|
name: from_date
|
|
type: string
|
|
- description: Filter to date (YYYY-MM-DD)
|
|
in: query
|
|
name: to_date
|
|
type: string
|
|
- description: Filter by workflow ID
|
|
in: query
|
|
name: workflow_id
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get Approval Statistics
|
|
tags:
|
|
- ArticleApprovalStepLogs
|
|
/article-approval-step-logs/step/{step_id}:
|
|
get:
|
|
description: API for getting ArticleApprovalStepLogs by Workflow Step ID
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
required: true
|
|
type: string
|
|
- description: Workflow Step ID
|
|
in: path
|
|
name: step_id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get ArticleApprovalStepLogs by Workflow Step ID
|
|
tags:
|
|
- ArticleApprovalStepLogs
|
|
/article-approval-step-logs/user/{user_id}/workload:
|
|
get:
|
|
description: API for getting user workload statistics
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
required: true
|
|
type: string
|
|
- description: User ID
|
|
in: path
|
|
name: user_id
|
|
required: true
|
|
type: integer
|
|
- description: Include detailed statistics
|
|
in: query
|
|
name: include_stats
|
|
type: boolean
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get User Workload
|
|
tags:
|
|
- ArticleApprovalStepLogs
|
|
/article-approvals:
|
|
get:
|
|
description: API for getting all ArticleApprovals
|
|
parameters:
|
|
- in: query
|
|
name: approvalAtLevel
|
|
type: integer
|
|
- in: query
|
|
name: approvalBy
|
|
type: integer
|
|
- in: query
|
|
name: articleId
|
|
type: integer
|
|
- in: query
|
|
name: message
|
|
type: string
|
|
- in: query
|
|
name: statusId
|
|
type: integer
|
|
- in: query
|
|
name: count
|
|
type: integer
|
|
- in: query
|
|
name: limit
|
|
type: integer
|
|
- in: query
|
|
name: nextPage
|
|
type: integer
|
|
- in: query
|
|
name: page
|
|
type: integer
|
|
- in: query
|
|
name: previousPage
|
|
type: integer
|
|
- in: query
|
|
name: sort
|
|
type: string
|
|
- in: query
|
|
name: sortBy
|
|
type: string
|
|
- in: query
|
|
name: totalPage
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get all ArticleApprovals
|
|
tags:
|
|
- ArticleApprovals
|
|
post:
|
|
description: API for create ArticleApprovals
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
type: string
|
|
- description: Insert the X-Csrf-Token
|
|
in: header
|
|
name: X-Csrf-Token
|
|
type: string
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.ArticleApprovalsCreateRequest'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Create ArticleApprovals
|
|
tags:
|
|
- ArticleApprovals
|
|
/article-approvals/{id}:
|
|
delete:
|
|
description: API for delete ArticleApprovals
|
|
parameters:
|
|
- description: Insert the X-Csrf-Token
|
|
in: header
|
|
name: X-Csrf-Token
|
|
type: string
|
|
- description: ArticleApprovals ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: delete ArticleApprovals
|
|
tags:
|
|
- ArticleApprovals
|
|
get:
|
|
description: API for getting one ArticleApprovals
|
|
parameters:
|
|
- description: ArticleApprovals ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get one ArticleApprovals
|
|
tags:
|
|
- ArticleApprovals
|
|
put:
|
|
description: API for update ArticleApprovals
|
|
parameters:
|
|
- description: Insert the X-Csrf-Token
|
|
in: header
|
|
name: X-Csrf-Token
|
|
type: string
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.ArticleApprovalsUpdateRequest'
|
|
- description: ArticleApprovals ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: update ArticleApprovals
|
|
tags:
|
|
- ArticleApprovals
|
|
/article-categories:
|
|
get:
|
|
description: API for getting all ArticleCategories
|
|
parameters:
|
|
- description: Insert the Authorization
|
|
in: header
|
|
name: Authorization
|
|
required: true
|
|
type: string
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- in: query
|
|
name: UserLevelId
|
|
type: integer
|
|
- in: query
|
|
name: UserLevelNumber
|
|
type: integer
|
|
- in: query
|
|
name: description
|
|
type: string
|
|
- in: query
|
|
name: isPublish
|
|
type: boolean
|
|
- in: query
|
|
name: parentId
|
|
type: integer
|
|
- in: query
|
|
name: statusId
|
|
type: integer
|
|
- in: query
|
|
name: title
|
|
type: string
|
|
- in: query
|
|
name: count
|
|
type: integer
|
|
- in: query
|
|
name: limit
|
|
type: integer
|
|
- in: query
|
|
name: nextPage
|
|
type: integer
|
|
- in: query
|
|
name: page
|
|
type: integer
|
|
- in: query
|
|
name: previousPage
|
|
type: integer
|
|
- in: query
|
|
name: sort
|
|
type: string
|
|
- in: query
|
|
name: sortBy
|
|
type: string
|
|
- in: query
|
|
name: totalPage
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get all ArticleCategories
|
|
tags:
|
|
- Article Categories
|
|
post:
|
|
description: API for create ArticleCategories
|
|
parameters:
|
|
- description: Insert the Authorization
|
|
in: header
|
|
name: Authorization
|
|
required: true
|
|
type: string
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.ArticleCategoriesCreateRequest'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Create ArticleCategories
|
|
tags:
|
|
- Article Categories
|
|
/article-categories/{id}:
|
|
delete:
|
|
description: API for delete ArticleCategories
|
|
parameters:
|
|
- description: Insert the Authorization
|
|
in: header
|
|
name: Authorization
|
|
required: true
|
|
type: string
|
|
- description: ArticleCategories ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: delete ArticleCategories
|
|
tags:
|
|
- Article Categories
|
|
get:
|
|
description: API for getting one ArticleCategories
|
|
parameters:
|
|
- description: Insert the Authorization
|
|
in: header
|
|
name: Authorization
|
|
required: true
|
|
type: string
|
|
- description: ArticleCategories ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get one ArticleCategories
|
|
tags:
|
|
- Article Categories
|
|
put:
|
|
description: API for update ArticleCategories
|
|
parameters:
|
|
- description: Insert the Authorization
|
|
in: header
|
|
name: Authorization
|
|
required: true
|
|
type: string
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.ArticleCategoriesUpdateRequest'
|
|
- description: ArticleCategories ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: update ArticleCategories
|
|
tags:
|
|
- Article Categories
|
|
/article-categories/old/{id}:
|
|
get:
|
|
description: API for getting one ArticleCategories
|
|
parameters:
|
|
- description: Insert the Authorization
|
|
in: header
|
|
name: Authorization
|
|
required: true
|
|
type: string
|
|
- description: ArticleCategories Old ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get one ArticleCategories
|
|
tags:
|
|
- Article Categories
|
|
/article-categories/slug/{slug}:
|
|
get:
|
|
description: API for getting one ArticleCategories
|
|
parameters:
|
|
- description: Insert the Authorization
|
|
in: header
|
|
name: Authorization
|
|
required: true
|
|
type: string
|
|
- description: ArticleCategories Slug
|
|
in: path
|
|
name: slug
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get one ArticleCategories
|
|
tags:
|
|
- Article Categories
|
|
/article-categories/thumbnail/{id}:
|
|
post:
|
|
description: API for Upload ArticleCategories Thumbnail
|
|
parameters:
|
|
- description: Insert the Authorization
|
|
in: header
|
|
name: Authorization
|
|
required: true
|
|
type: string
|
|
- description: Upload thumbnail
|
|
in: formData
|
|
name: files
|
|
required: true
|
|
type: file
|
|
- description: ArticleCategories ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Upload ArticleCategories Thumbnail
|
|
tags:
|
|
- Article Categories
|
|
/article-categories/thumbnail/viewer/{id}:
|
|
get:
|
|
description: API for View Thumbnail of ArticleCategories
|
|
parameters:
|
|
- description: Insert the Authorization
|
|
in: header
|
|
name: Authorization
|
|
required: true
|
|
type: string
|
|
- description: ArticleCategories ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Viewer ArticleCategories
|
|
tags:
|
|
- Article Categories
|
|
/article-category-details:
|
|
get:
|
|
description: API for getting all ArticleCategoryDetails
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"404":
|
|
description: Not Found
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"422":
|
|
description: Unprocessable Entity
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get all ArticleCategoryDetails
|
|
tags:
|
|
- Untags
|
|
post:
|
|
description: API for create ArticleCategoryDetails
|
|
parameters:
|
|
- description: Insert the X-Csrf-Token
|
|
in: header
|
|
name: X-Csrf-Token
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"404":
|
|
description: Not Found
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"422":
|
|
description: Unprocessable Entity
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
security:
|
|
- Bearer: []
|
|
summary: Create ArticleCategoryDetails
|
|
tags:
|
|
- Untags
|
|
/article-category-details/{id}:
|
|
delete:
|
|
description: API for delete ArticleCategoryDetails
|
|
parameters:
|
|
- description: Insert the X-Csrf-Token
|
|
in: header
|
|
name: X-Csrf-Token
|
|
type: string
|
|
- description: ArticleCategoryDetails ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"404":
|
|
description: Not Found
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"422":
|
|
description: Unprocessable Entity
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
security:
|
|
- Bearer: []
|
|
summary: delete ArticleCategoryDetails
|
|
tags:
|
|
- Untags
|
|
get:
|
|
description: API for getting one ArticleCategoryDetails
|
|
parameters:
|
|
- description: ArticleCategoryDetails ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"404":
|
|
description: Not Found
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"422":
|
|
description: Unprocessable Entity
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get one ArticleCategoryDetails
|
|
tags:
|
|
- Untags
|
|
put:
|
|
description: API for update ArticleCategoryDetails
|
|
parameters:
|
|
- description: Insert the X-Csrf-Token
|
|
in: header
|
|
name: X-Csrf-Token
|
|
type: string
|
|
- description: ArticleCategoryDetails ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"404":
|
|
description: Not Found
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"422":
|
|
description: Unprocessable Entity
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
security:
|
|
- Bearer: []
|
|
summary: update ArticleCategoryDetails
|
|
tags:
|
|
- Untags
|
|
/article-comments:
|
|
get:
|
|
description: API for getting all ArticleComments
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
type: string
|
|
- in: query
|
|
name: articleId
|
|
type: integer
|
|
- in: query
|
|
name: commentFrom
|
|
type: integer
|
|
- in: query
|
|
name: isPublic
|
|
type: boolean
|
|
- in: query
|
|
name: message
|
|
type: string
|
|
- in: query
|
|
name: parentId
|
|
type: integer
|
|
- in: query
|
|
name: count
|
|
type: integer
|
|
- in: query
|
|
name: limit
|
|
type: integer
|
|
- in: query
|
|
name: nextPage
|
|
type: integer
|
|
- in: query
|
|
name: page
|
|
type: integer
|
|
- in: query
|
|
name: previousPage
|
|
type: integer
|
|
- in: query
|
|
name: sort
|
|
type: string
|
|
- in: query
|
|
name: sortBy
|
|
type: string
|
|
- in: query
|
|
name: totalPage
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get all ArticleComments
|
|
tags:
|
|
- ArticleComments
|
|
post:
|
|
description: API for create ArticleComments
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
type: string
|
|
- description: Insert the X-Csrf-Token
|
|
in: header
|
|
name: X-Csrf-Token
|
|
type: string
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.ArticleCommentsCreateRequest'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Create ArticleComments
|
|
tags:
|
|
- ArticleComments
|
|
/article-comments/{id}:
|
|
delete:
|
|
description: API for delete ArticleComments
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
type: string
|
|
- description: Insert the X-Csrf-Token
|
|
in: header
|
|
name: X-Csrf-Token
|
|
type: string
|
|
- description: ArticleComments ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: delete ArticleComments
|
|
tags:
|
|
- ArticleComments
|
|
get:
|
|
description: API for getting one ArticleComments
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
type: string
|
|
- description: ArticleComments ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get one ArticleComments
|
|
tags:
|
|
- ArticleComments
|
|
put:
|
|
description: API for update ArticleComments
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
type: string
|
|
- description: Insert the X-Csrf-Token
|
|
in: header
|
|
name: X-Csrf-Token
|
|
type: string
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.ArticleCommentsUpdateRequest'
|
|
- description: ArticleComments ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: update ArticleComments
|
|
tags:
|
|
- ArticleComments
|
|
/article-comments/approval:
|
|
post:
|
|
description: API for Approval ArticleComments
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
type: string
|
|
- description: Insert the X-Csrf-Token
|
|
in: header
|
|
name: X-Csrf-Token
|
|
type: string
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.ArticleCommentsApprovalRequest'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Approval ArticleComments
|
|
tags:
|
|
- ArticleComments
|
|
/article-files:
|
|
get:
|
|
description: API for getting all ArticleFiles
|
|
parameters:
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- in: query
|
|
name: articleId
|
|
type: integer
|
|
- in: query
|
|
name: fileName
|
|
type: string
|
|
- in: query
|
|
name: isPublish
|
|
type: boolean
|
|
- in: query
|
|
name: statusId
|
|
type: integer
|
|
- in: query
|
|
name: count
|
|
type: integer
|
|
- in: query
|
|
name: limit
|
|
type: integer
|
|
- in: query
|
|
name: nextPage
|
|
type: integer
|
|
- in: query
|
|
name: page
|
|
type: integer
|
|
- in: query
|
|
name: previousPage
|
|
type: integer
|
|
- in: query
|
|
name: sort
|
|
type: string
|
|
- in: query
|
|
name: sortBy
|
|
type: string
|
|
- in: query
|
|
name: totalPage
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get all ArticleFiles
|
|
tags:
|
|
- Article Files
|
|
/article-files/{articleId}:
|
|
post:
|
|
description: API for create ArticleFiles
|
|
parameters:
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- description: Upload file
|
|
in: formData
|
|
name: files
|
|
required: true
|
|
type: file
|
|
- description: Article ID
|
|
in: path
|
|
name: articleId
|
|
required: true
|
|
type: integer
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Upload ArticleFiles
|
|
tags:
|
|
- Article Files
|
|
/article-files/{id}:
|
|
delete:
|
|
description: API for delete ArticleFiles
|
|
parameters:
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- description: ArticleFiles ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Delete ArticleFiles
|
|
tags:
|
|
- Article Files
|
|
get:
|
|
description: API for getting one ArticleFiles
|
|
parameters:
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- description: ArticleFiles ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get one ArticleFiles
|
|
tags:
|
|
- Article Files
|
|
put:
|
|
description: API for update ArticleFiles
|
|
parameters:
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.ArticleFilesUpdateRequest'
|
|
- description: ArticleFiles ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Update ArticleFiles
|
|
tags:
|
|
- Article Files
|
|
/article-files/upload-status/{uploadId}:
|
|
get:
|
|
description: API for GetUploadStatus ArticleFiles
|
|
parameters:
|
|
- description: Upload ID of ArticleFiles
|
|
in: path
|
|
name: uploadId
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: GetUploadStatus ArticleFiles
|
|
tags:
|
|
- Article Files
|
|
/article-files/viewer/{filename}:
|
|
get:
|
|
description: API for Viewer ArticleFiles
|
|
parameters:
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- description: Article File Name
|
|
in: path
|
|
name: filename
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Viewer ArticleFiles
|
|
tags:
|
|
- Article Files
|
|
/article-nulis-ai:
|
|
get:
|
|
description: API for getting all ArticleNulisAI
|
|
parameters:
|
|
- in: query
|
|
name: articleId
|
|
type: integer
|
|
- in: query
|
|
name: categoryId
|
|
type: integer
|
|
- in: query
|
|
name: creatorId
|
|
type: integer
|
|
- in: query
|
|
name: description
|
|
type: string
|
|
- in: query
|
|
name: htmlDescription
|
|
type: string
|
|
- in: query
|
|
name: nulisAiId
|
|
type: integer
|
|
- in: query
|
|
name: tags
|
|
type: string
|
|
- in: query
|
|
name: title
|
|
type: string
|
|
- in: query
|
|
name: count
|
|
type: integer
|
|
- in: query
|
|
name: limit
|
|
type: integer
|
|
- in: query
|
|
name: nextPage
|
|
type: integer
|
|
- in: query
|
|
name: page
|
|
type: integer
|
|
- in: query
|
|
name: previousPage
|
|
type: integer
|
|
- in: query
|
|
name: sort
|
|
type: string
|
|
- in: query
|
|
name: sortBy
|
|
type: string
|
|
- in: query
|
|
name: totalPage
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get all ArticleNulisAI
|
|
tags:
|
|
- ArticleNulisAI
|
|
post:
|
|
description: API for create ArticleNulisAI
|
|
parameters:
|
|
- description: Insert the X-Csrf-Token
|
|
in: header
|
|
name: X-Csrf-Token
|
|
type: string
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.ArticleNulisAICreateRequest'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Create ArticleNulisAI
|
|
tags:
|
|
- ArticleNulisAI
|
|
/article-nulis-ai/{id}:
|
|
delete:
|
|
description: API for delete ArticleNulisAI
|
|
parameters:
|
|
- description: Insert the X-Csrf-Token
|
|
in: header
|
|
name: X-Csrf-Token
|
|
type: string
|
|
- description: ArticleNulisAI ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: delete ArticleNulisAI
|
|
tags:
|
|
- ArticleNulisAI
|
|
get:
|
|
description: API for getting one ArticleNulisAI
|
|
parameters:
|
|
- description: ArticleNulisAI ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get one ArticleNulisAI
|
|
tags:
|
|
- ArticleNulisAI
|
|
put:
|
|
description: API for update ArticleNulisAI
|
|
parameters:
|
|
- description: Insert the X-Csrf-Token
|
|
in: header
|
|
name: X-Csrf-Token
|
|
type: string
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.ArticleNulisAIUpdateRequest'
|
|
- description: ArticleNulisAI ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: update ArticleNulisAI
|
|
tags:
|
|
- ArticleNulisAI
|
|
/article-nulis-ai/publish:
|
|
post:
|
|
description: API for publish ArticleNulisAI
|
|
parameters:
|
|
- description: Insert the X-Csrf-Token
|
|
in: header
|
|
name: X-Csrf-Token
|
|
type: string
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.ArticleNulisAIUpdateRequest'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: publish ArticleNulisAI
|
|
tags:
|
|
- ArticleNulisAI
|
|
/articles:
|
|
get:
|
|
description: API for getting all Articles
|
|
parameters:
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- in: query
|
|
name: category
|
|
type: string
|
|
- in: query
|
|
name: categoryId
|
|
type: integer
|
|
- in: query
|
|
name: createdById
|
|
type: integer
|
|
- in: query
|
|
name: description
|
|
type: string
|
|
- in: query
|
|
name: isBanner
|
|
type: boolean
|
|
- in: query
|
|
name: isDraft
|
|
type: boolean
|
|
- in: query
|
|
name: isPublish
|
|
type: boolean
|
|
- in: query
|
|
name: statusId
|
|
type: integer
|
|
- in: query
|
|
name: tags
|
|
type: string
|
|
- in: query
|
|
name: title
|
|
type: string
|
|
- in: query
|
|
name: typeId
|
|
type: integer
|
|
- in: query
|
|
name: count
|
|
type: integer
|
|
- in: query
|
|
name: limit
|
|
type: integer
|
|
- in: query
|
|
name: nextPage
|
|
type: integer
|
|
- in: query
|
|
name: page
|
|
type: integer
|
|
- in: query
|
|
name: previousPage
|
|
type: integer
|
|
- in: query
|
|
name: sort
|
|
type: string
|
|
- in: query
|
|
name: sortBy
|
|
type: string
|
|
- in: query
|
|
name: totalPage
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get all Articles
|
|
tags:
|
|
- Articles
|
|
post:
|
|
description: API for create Articles
|
|
parameters:
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.ArticlesCreateRequest'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Create Articles
|
|
tags:
|
|
- Articles
|
|
/articles/{id}:
|
|
delete:
|
|
description: API for delete Articles
|
|
parameters:
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- description: Articles ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Delete Articles
|
|
tags:
|
|
- Articles
|
|
get:
|
|
description: API for getting one Articles
|
|
parameters:
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get one Articles
|
|
tags:
|
|
- Articles
|
|
put:
|
|
description: API for update Articles
|
|
parameters:
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.ArticlesUpdateRequest'
|
|
- description: Articles ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Update Articles
|
|
tags:
|
|
- Articles
|
|
/articles/{id}/approval-status:
|
|
get:
|
|
description: API for getting article approval status and workflow progress
|
|
parameters:
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- description: article id
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get Article Approval Status
|
|
tags:
|
|
- Articles
|
|
/articles/{id}/submit-approval:
|
|
post:
|
|
description: API for submitting article for approval workflow
|
|
parameters:
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- description: article id
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
- description: approval request data
|
|
in: body
|
|
name: req
|
|
schema:
|
|
$ref: '#/definitions/netidhub-saas-be_app_module_articles_request.SubmitForApprovalRequest'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Submit Article for Approval
|
|
tags:
|
|
- Articles
|
|
/articles/banner/{id}:
|
|
put:
|
|
description: API for Update Banner Articles
|
|
parameters:
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- description: Articles ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
- description: Articles Banner Status
|
|
in: query
|
|
name: isBanner
|
|
required: true
|
|
type: boolean
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Update Banner Articles
|
|
tags:
|
|
- Articles
|
|
/articles/old-id/{id}:
|
|
get:
|
|
description: API for getting one Articles
|
|
parameters:
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get one Articles
|
|
tags:
|
|
- Articles
|
|
/articles/pending-approval:
|
|
get:
|
|
description: API for getting articles pending approval for current user level
|
|
parameters:
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- description: page number
|
|
in: query
|
|
name: page
|
|
type: integer
|
|
- description: items per page
|
|
in: query
|
|
name: limit
|
|
type: integer
|
|
- description: article type id
|
|
in: query
|
|
name: typeId
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get Pending Approvals
|
|
tags:
|
|
- Articles
|
|
/articles/publish-scheduling:
|
|
post:
|
|
description: API for Publish Schedule of Article
|
|
parameters:
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- description: article id
|
|
in: query
|
|
name: id
|
|
type: integer
|
|
- description: publish date
|
|
in: query
|
|
name: date
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: PublishScheduling Articles
|
|
tags:
|
|
- Articles
|
|
/articles/statistic/monthly:
|
|
get:
|
|
description: API for ArticleMonthlyStats of Article
|
|
parameters:
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- description: year
|
|
in: query
|
|
name: year
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: ArticleMonthlyStats Articles
|
|
tags:
|
|
- Articles
|
|
/articles/statistic/summary:
|
|
get:
|
|
description: API for Summary Stats of Article
|
|
parameters:
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: SummaryStats Articles
|
|
tags:
|
|
- Articles
|
|
/articles/statistic/user-levels:
|
|
get:
|
|
description: API for ArticlePerUserLevelStats of Article
|
|
parameters:
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- description: start date
|
|
in: query
|
|
name: startDate
|
|
type: string
|
|
- description: start date
|
|
in: query
|
|
name: endDate
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: ArticlePerUserLevelStats Articles
|
|
tags:
|
|
- Articles
|
|
/articles/thumbnail/{id}:
|
|
post:
|
|
description: API for Save Thumbnail of Articles
|
|
parameters:
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- description: Articles ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Save Thumbnail Articles
|
|
tags:
|
|
- Articles
|
|
/articles/thumbnail/viewer/{thumbnailName}:
|
|
get:
|
|
description: API for View Thumbnail of Article
|
|
parameters:
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- description: Articles Thumbnail Name
|
|
in: path
|
|
name: thumbnailName
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Viewer Articles Thumbnail
|
|
tags:
|
|
- Articles
|
|
/articles/waiting-for-approval:
|
|
get:
|
|
description: API for getting articles that are waiting for approval by the current
|
|
user's level
|
|
parameters:
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- default: 1
|
|
description: Page number
|
|
in: query
|
|
name: page
|
|
type: integer
|
|
- default: 10
|
|
description: Items per page
|
|
in: query
|
|
name: limit
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get articles waiting for approval by current user level
|
|
tags:
|
|
- Articles
|
|
/bookmarks:
|
|
get:
|
|
description: API for getting all Bookmarks
|
|
parameters:
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- in: query
|
|
name: articleId
|
|
type: integer
|
|
- in: query
|
|
name: userId
|
|
type: integer
|
|
- in: query
|
|
name: count
|
|
type: integer
|
|
- in: query
|
|
name: limit
|
|
type: integer
|
|
- in: query
|
|
name: nextPage
|
|
type: integer
|
|
- in: query
|
|
name: page
|
|
type: integer
|
|
- in: query
|
|
name: previousPage
|
|
type: integer
|
|
- in: query
|
|
name: sort
|
|
type: string
|
|
- in: query
|
|
name: sortBy
|
|
type: string
|
|
- in: query
|
|
name: totalPage
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get all Bookmarks
|
|
tags:
|
|
- Bookmarks
|
|
post:
|
|
description: API for creating new Bookmark
|
|
parameters:
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- description: Bookmark data
|
|
in: body
|
|
name: req
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.BookmarksCreateRequest'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Create new Bookmark
|
|
tags:
|
|
- Bookmarks
|
|
/bookmarks/{id}:
|
|
delete:
|
|
description: API for deleting Bookmark
|
|
parameters:
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- description: Bookmark ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Delete Bookmark
|
|
tags:
|
|
- Bookmarks
|
|
get:
|
|
description: API for getting Bookmark by ID
|
|
parameters:
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- description: Bookmark ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get Bookmark by ID
|
|
tags:
|
|
- Bookmarks
|
|
/bookmarks/summary:
|
|
get:
|
|
description: API for getting bookmark summary including total count and recent
|
|
bookmarks
|
|
parameters:
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get Bookmark Summary for User
|
|
tags:
|
|
- Bookmarks
|
|
/bookmarks/toggle/{articleId}:
|
|
post:
|
|
description: API for toggling bookmark status for an article
|
|
parameters:
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- description: Article ID
|
|
in: path
|
|
name: articleId
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Toggle Bookmark (Add/Remove)
|
|
tags:
|
|
- Bookmarks
|
|
/bookmarks/user:
|
|
get:
|
|
description: API for getting Bookmarks by User ID
|
|
parameters:
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- in: query
|
|
name: articleId
|
|
type: integer
|
|
- in: query
|
|
name: userId
|
|
type: integer
|
|
- in: query
|
|
name: count
|
|
type: integer
|
|
- in: query
|
|
name: limit
|
|
type: integer
|
|
- in: query
|
|
name: nextPage
|
|
type: integer
|
|
- in: query
|
|
name: page
|
|
type: integer
|
|
- in: query
|
|
name: previousPage
|
|
type: integer
|
|
- in: query
|
|
name: sort
|
|
type: string
|
|
- in: query
|
|
name: sortBy
|
|
type: string
|
|
- in: query
|
|
name: totalPage
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get Bookmarks by User ID
|
|
tags:
|
|
- Bookmarks
|
|
/cities:
|
|
get:
|
|
description: API for getting all Cities
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"404":
|
|
description: Not Found
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"422":
|
|
description: Unprocessable Entity
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get all Cities
|
|
tags:
|
|
- Untags
|
|
post:
|
|
description: API for create Cities
|
|
parameters:
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.CitiesCreateRequest'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"404":
|
|
description: Not Found
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"422":
|
|
description: Unprocessable Entity
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
security:
|
|
- Bearer: []
|
|
summary: Create Cities
|
|
tags:
|
|
- Untags
|
|
/cities/{id}:
|
|
delete:
|
|
description: API for delete Cities
|
|
parameters:
|
|
- description: Cities ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"404":
|
|
description: Not Found
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"422":
|
|
description: Unprocessable Entity
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
security:
|
|
- Bearer: []
|
|
summary: Delete Cities
|
|
tags:
|
|
- Untags
|
|
get:
|
|
description: API for getting one Cities
|
|
parameters:
|
|
- description: Cities ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"404":
|
|
description: Not Found
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"422":
|
|
description: Unprocessable Entity
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get one Cities
|
|
tags:
|
|
- Untags
|
|
put:
|
|
consumes:
|
|
- application/json
|
|
description: API for update Cities
|
|
parameters:
|
|
- description: Cities ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.CitiesUpdateRequest'
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"404":
|
|
description: Not Found
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"422":
|
|
description: Unprocessable Entity
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
security:
|
|
- Bearer: []
|
|
summary: Update Cities
|
|
tags:
|
|
- Untags
|
|
/client-approval-settings:
|
|
delete:
|
|
description: API for deleting client approval settings
|
|
parameters:
|
|
- description: Insert the Authorization
|
|
in: header
|
|
name: Authorization
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Delete Client Approval Settings
|
|
tags:
|
|
- ClientApprovalSettings
|
|
get:
|
|
description: API for getting client approval settings
|
|
parameters:
|
|
- description: Insert the Authorization
|
|
in: header
|
|
name: Authorization
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get Client Approval Settings
|
|
tags:
|
|
- ClientApprovalSettings
|
|
post:
|
|
description: API for creating client approval settings
|
|
parameters:
|
|
- description: Insert the Authorization
|
|
in: header
|
|
name: Authorization
|
|
required: true
|
|
type: string
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.CreateClientApprovalSettingsRequest'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Create Client Approval Settings
|
|
tags:
|
|
- ClientApprovalSettings
|
|
put:
|
|
description: API for updating client approval settings
|
|
parameters:
|
|
- description: Insert the Authorization
|
|
in: header
|
|
name: Authorization
|
|
required: true
|
|
type: string
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.UpdateClientApprovalSettingsRequest'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Update Client Approval Settings
|
|
tags:
|
|
- ClientApprovalSettings
|
|
/client-approval-settings/default-workflow:
|
|
post:
|
|
description: API for setting default workflow for client
|
|
parameters:
|
|
- description: Insert the Authorization
|
|
in: header
|
|
name: Authorization
|
|
required: true
|
|
type: string
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.SetDefaultWorkflowRequest'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Set Default Workflow
|
|
tags:
|
|
- ClientApprovalSettings
|
|
/client-approval-settings/disable:
|
|
post:
|
|
description: API for disabling approval system and auto-publish pending articles
|
|
parameters:
|
|
- description: Insert the Authorization
|
|
in: header
|
|
name: Authorization
|
|
required: true
|
|
type: string
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.DisableApprovalRequest'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Disable Approval System
|
|
tags:
|
|
- ClientApprovalSettings
|
|
/client-approval-settings/enable:
|
|
post:
|
|
description: API for enabling approval system with smooth transition
|
|
parameters:
|
|
- description: Insert the Authorization
|
|
in: header
|
|
name: Authorization
|
|
required: true
|
|
type: string
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.EnableApprovalRequest'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Enable Approval System
|
|
tags:
|
|
- ClientApprovalSettings
|
|
/client-approval-settings/exempt-categories/{action}/{category_id}:
|
|
post:
|
|
description: API for adding/removing categories from approval exemption
|
|
parameters:
|
|
- description: Insert the Authorization
|
|
in: header
|
|
name: Authorization
|
|
required: true
|
|
type: string
|
|
- description: 'Action: add or remove'
|
|
in: path
|
|
name: action
|
|
required: true
|
|
type: string
|
|
- description: Category ID
|
|
in: path
|
|
name: category_id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Manage Exempt Categories
|
|
tags:
|
|
- ClientApprovalSettings
|
|
/client-approval-settings/exempt-roles/{action}/{role_id}:
|
|
post:
|
|
description: API for adding/removing roles from approval exemption
|
|
parameters:
|
|
- description: Insert the Authorization
|
|
in: header
|
|
name: Authorization
|
|
required: true
|
|
type: string
|
|
- description: 'Action: add or remove'
|
|
in: path
|
|
name: action
|
|
required: true
|
|
type: string
|
|
- description: Role ID
|
|
in: path
|
|
name: role_id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Manage Exempt Roles
|
|
tags:
|
|
- ClientApprovalSettings
|
|
/client-approval-settings/exempt-users/{action}/{user_id}:
|
|
post:
|
|
description: API for adding/removing users from approval exemption
|
|
parameters:
|
|
- description: Insert the Authorization
|
|
in: header
|
|
name: Authorization
|
|
required: true
|
|
type: string
|
|
- description: 'Action: add or remove'
|
|
in: path
|
|
name: action
|
|
required: true
|
|
type: string
|
|
- description: User ID
|
|
in: path
|
|
name: user_id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Manage Exempt Users
|
|
tags:
|
|
- ClientApprovalSettings
|
|
/client-approval-settings/toggle:
|
|
post:
|
|
description: API for toggling approval requirement on/off
|
|
parameters:
|
|
- description: Insert the Authorization
|
|
in: header
|
|
name: Authorization
|
|
required: true
|
|
type: string
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.ToggleApprovalRequest'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Toggle Approval Requirement
|
|
tags:
|
|
- ClientApprovalSettings
|
|
/clients:
|
|
get:
|
|
description: API for getting all Clients with hierarchy filtering
|
|
parameters:
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- description: Filter by client name
|
|
in: query
|
|
name: name
|
|
type: string
|
|
- description: Filter by client type (parent_client, sub_client, standalone)
|
|
in: query
|
|
name: clientType
|
|
type: string
|
|
- description: Filter by parent client ID
|
|
in: query
|
|
name: parentClientId
|
|
type: string
|
|
- description: Include all descendants
|
|
in: query
|
|
name: includeSubClients
|
|
type: boolean
|
|
- description: Only clients with children
|
|
in: query
|
|
name: onlyParentClients
|
|
type: boolean
|
|
- description: Only standalone clients
|
|
in: query
|
|
name: onlyStandalone
|
|
type: boolean
|
|
- description: Only root level clients
|
|
in: query
|
|
name: onlyRootClients
|
|
type: boolean
|
|
- description: Filter by active status
|
|
in: query
|
|
name: isActive
|
|
type: boolean
|
|
- description: Filter by creator ID
|
|
in: query
|
|
name: createdById
|
|
type: string
|
|
- description: Page number
|
|
in: query
|
|
name: page
|
|
type: integer
|
|
- description: Items per page
|
|
in: query
|
|
name: limit
|
|
type: integer
|
|
- description: Sort field
|
|
in: query
|
|
name: sort
|
|
type: string
|
|
- description: Sort direction (asc, desc)
|
|
in: query
|
|
name: sortBy
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get all Clients
|
|
tags:
|
|
- Clients
|
|
post:
|
|
description: API for create Clients
|
|
parameters:
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.ClientsCreateRequest'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Create Clients
|
|
tags:
|
|
- Clients
|
|
/clients/{id}:
|
|
delete:
|
|
description: API for delete Clients
|
|
parameters:
|
|
- description: Clients ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: delete Clients
|
|
tags:
|
|
- Clients
|
|
get:
|
|
description: API for getting one Clients
|
|
parameters:
|
|
- description: Clients ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get one Clients
|
|
tags:
|
|
- Clients
|
|
put:
|
|
description: API for update Clients
|
|
parameters:
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.ClientsUpdateRequest'
|
|
- description: Clients ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: update Clients
|
|
tags:
|
|
- Clients
|
|
/clients/{id}/hierarchy:
|
|
get:
|
|
description: API for getting client tree structure
|
|
parameters:
|
|
- description: Client ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get client hierarchy
|
|
tags:
|
|
- Clients
|
|
/clients/{id}/move:
|
|
put:
|
|
description: API for moving a client to different parent
|
|
parameters:
|
|
- description: Client ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.MoveClientRequest'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Move client
|
|
tags:
|
|
- Clients
|
|
/clients/{id}/stats:
|
|
get:
|
|
description: API for getting client statistics
|
|
parameters:
|
|
- description: Client ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get client statistics
|
|
tags:
|
|
- Clients
|
|
/clients/{id}/sub-clients:
|
|
get:
|
|
description: API for getting direct children of a client
|
|
parameters:
|
|
- description: Parent Client ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get sub-clients
|
|
tags:
|
|
- Clients
|
|
post:
|
|
description: API for creating a client under a parent
|
|
parameters:
|
|
- description: Parent Client ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: string
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.ClientsCreateRequest'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Create sub-client
|
|
tags:
|
|
- Clients
|
|
/clients/bulk-sub-clients:
|
|
post:
|
|
description: API for creating multiple sub-clients at once
|
|
parameters:
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.BulkCreateSubClientsRequest'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Bulk create sub-clients
|
|
tags:
|
|
- Clients
|
|
/clients/with-user:
|
|
post:
|
|
description: API for creating a client and its admin user in a single request
|
|
(Public endpoint)
|
|
parameters:
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.ClientWithUserCreateRequest'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
summary: Create client with admin user
|
|
tags:
|
|
- Clients
|
|
/custom-static-pages:
|
|
get:
|
|
description: API for getting all CustomStaticPages
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
type: string
|
|
- in: query
|
|
name: description
|
|
type: string
|
|
- in: query
|
|
name: htmlBody
|
|
type: string
|
|
- in: query
|
|
name: slug
|
|
type: string
|
|
- in: query
|
|
name: title
|
|
type: string
|
|
- in: query
|
|
name: count
|
|
type: integer
|
|
- in: query
|
|
name: limit
|
|
type: integer
|
|
- in: query
|
|
name: nextPage
|
|
type: integer
|
|
- in: query
|
|
name: page
|
|
type: integer
|
|
- in: query
|
|
name: previousPage
|
|
type: integer
|
|
- in: query
|
|
name: sort
|
|
type: string
|
|
- in: query
|
|
name: sortBy
|
|
type: string
|
|
- in: query
|
|
name: totalPage
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get all CustomStaticPages
|
|
tags:
|
|
- CustomStaticPages
|
|
post:
|
|
description: API for create CustomStaticPages
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
type: string
|
|
- description: Insert the X-Csrf-Token
|
|
in: header
|
|
name: X-Csrf-Token
|
|
type: string
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.CustomStaticPagesCreateRequest'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Create CustomStaticPages
|
|
tags:
|
|
- CustomStaticPages
|
|
/custom-static-pages/{id}:
|
|
delete:
|
|
description: API for delete CustomStaticPages
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
type: string
|
|
- description: Insert the X-Csrf-Token
|
|
in: header
|
|
name: X-Csrf-Token
|
|
type: string
|
|
- description: CustomStaticPages ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: delete CustomStaticPages
|
|
tags:
|
|
- CustomStaticPages
|
|
get:
|
|
description: API for getting one CustomStaticPages
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
type: string
|
|
- description: CustomStaticPages ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get one CustomStaticPages
|
|
tags:
|
|
- CustomStaticPages
|
|
put:
|
|
description: API for update CustomStaticPages
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
type: string
|
|
- description: Insert the X-Csrf-Token
|
|
in: header
|
|
name: X-Csrf-Token
|
|
type: string
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.CustomStaticPagesUpdateRequest'
|
|
- description: CustomStaticPages ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: update CustomStaticPages
|
|
tags:
|
|
- CustomStaticPages
|
|
/custom-static-pages/slug/{slug}:
|
|
get:
|
|
description: API for getting one CustomStaticPages
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
type: string
|
|
- description: CustomStaticPages Slug
|
|
in: path
|
|
name: slug
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get one CustomStaticPages
|
|
tags:
|
|
- CustomStaticPages
|
|
/districts:
|
|
get:
|
|
description: API for getting all Districts
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"404":
|
|
description: Not Found
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"422":
|
|
description: Unprocessable Entity
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get all Districts
|
|
tags:
|
|
- Untags
|
|
post:
|
|
description: API for create Districts
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"404":
|
|
description: Not Found
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"422":
|
|
description: Unprocessable Entity
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
security:
|
|
- Bearer: []
|
|
summary: Create Districts
|
|
tags:
|
|
- Untags
|
|
/districts/{id}:
|
|
delete:
|
|
description: API for delete Districts
|
|
parameters:
|
|
- description: Districts ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"404":
|
|
description: Not Found
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"422":
|
|
description: Unprocessable Entity
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
security:
|
|
- Bearer: []
|
|
summary: Delete Districts
|
|
tags:
|
|
- Untags
|
|
get:
|
|
description: API for getting one Districts
|
|
parameters:
|
|
- description: Districts ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"404":
|
|
description: Not Found
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"422":
|
|
description: Unprocessable Entity
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get one Districts
|
|
tags:
|
|
- Untags
|
|
put:
|
|
description: API for update Districts
|
|
parameters:
|
|
- description: Districts ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"404":
|
|
description: Not Found
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"422":
|
|
description: Unprocessable Entity
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
security:
|
|
- Bearer: []
|
|
summary: Update Districts
|
|
tags:
|
|
- Untags
|
|
/feedbacks:
|
|
get:
|
|
description: API for getting all Feedbacks
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
type: string
|
|
- in: query
|
|
name: commentFromEmail
|
|
type: string
|
|
- in: query
|
|
name: commentFromName
|
|
type: string
|
|
- in: query
|
|
name: endDate
|
|
type: string
|
|
- in: query
|
|
name: message
|
|
type: string
|
|
- in: query
|
|
name: startDate
|
|
type: string
|
|
- in: query
|
|
name: statusId
|
|
type: integer
|
|
- in: query
|
|
name: count
|
|
type: integer
|
|
- in: query
|
|
name: limit
|
|
type: integer
|
|
- in: query
|
|
name: nextPage
|
|
type: integer
|
|
- in: query
|
|
name: page
|
|
type: integer
|
|
- in: query
|
|
name: previousPage
|
|
type: integer
|
|
- in: query
|
|
name: sort
|
|
type: string
|
|
- in: query
|
|
name: sortBy
|
|
type: string
|
|
- in: query
|
|
name: totalPage
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get all Feedbacks
|
|
tags:
|
|
- Feedbacks
|
|
post:
|
|
description: API for create Feedbacks
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
type: string
|
|
- description: Insert the X-Csrf-Token
|
|
in: header
|
|
name: X-Csrf-Token
|
|
type: string
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.FeedbacksCreateRequest'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Create Feedbacks
|
|
tags:
|
|
- Feedbacks
|
|
/feedbacks/{id}:
|
|
delete:
|
|
description: API for delete Feedbacks
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
type: string
|
|
- description: Insert the X-Csrf-Token
|
|
in: header
|
|
name: X-Csrf-Token
|
|
type: string
|
|
- description: Feedbacks ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: delete Feedbacks
|
|
tags:
|
|
- Feedbacks
|
|
get:
|
|
description: API for getting one Feedbacks
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
type: string
|
|
- description: Feedbacks ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get one Feedbacks
|
|
tags:
|
|
- Feedbacks
|
|
put:
|
|
description: API for update Feedbacks
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
type: string
|
|
- description: Insert the X-Csrf-Token
|
|
in: header
|
|
name: X-Csrf-Token
|
|
type: string
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.FeedbacksUpdateRequest'
|
|
- description: Feedbacks ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: update Feedbacks
|
|
tags:
|
|
- Feedbacks
|
|
/feedbacks/statistic/monthly:
|
|
get:
|
|
description: API for FeedbackMonthlyStats of Feedbacks
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
type: string
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- description: year
|
|
in: query
|
|
name: year
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: FeedbackMonthlyStats Feedbacks
|
|
tags:
|
|
- Feedbacks
|
|
/magazine-files:
|
|
get:
|
|
description: API for getting all MagazineFiles
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get all MagazineFiles
|
|
tags:
|
|
- Magazine Files
|
|
/magazine-files/{id}:
|
|
delete:
|
|
description: API for delete MagazineFiles
|
|
parameters:
|
|
- description: Insert the X-Csrf-Token
|
|
in: header
|
|
name: X-Csrf-Token
|
|
type: string
|
|
- description: MagazineFiles ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: delete MagazineFiles
|
|
tags:
|
|
- Magazine Files
|
|
get:
|
|
description: API for getting one MagazineFiles
|
|
parameters:
|
|
- description: MagazineFiles ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get one MagazineFiles
|
|
tags:
|
|
- Magazine Files
|
|
put:
|
|
description: API for update MagazineFiles
|
|
parameters:
|
|
- description: Insert the X-Csrf-Token
|
|
in: header
|
|
name: X-Csrf-Token
|
|
type: string
|
|
- description: MagazineFiles ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Update MagazineFiles
|
|
tags:
|
|
- Magazine Files
|
|
/magazine-files/{magazineId}:
|
|
post:
|
|
description: API for create MagazineFiles
|
|
parameters:
|
|
- description: Insert the X-Csrf-Token
|
|
in: header
|
|
name: X-Csrf-Token
|
|
type: string
|
|
- description: Upload file
|
|
in: formData
|
|
name: files
|
|
required: true
|
|
type: file
|
|
- description: Magazine file title
|
|
in: formData
|
|
name: title
|
|
required: true
|
|
type: string
|
|
- description: Magazine file description
|
|
in: formData
|
|
name: description
|
|
required: true
|
|
type: string
|
|
- description: Magazine ID
|
|
in: path
|
|
name: magazineId
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Create MagazineFiles
|
|
tags:
|
|
- Magazine Files
|
|
/magazine-files/viewer/{filename}:
|
|
get:
|
|
description: API for create MagazineFiles
|
|
parameters:
|
|
- description: Magazine File Name
|
|
in: path
|
|
name: filename
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Create MagazineFiles
|
|
tags:
|
|
- Magazine Files
|
|
/magazines:
|
|
get:
|
|
description: API for getting all Magazines
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
type: string
|
|
- in: query
|
|
name: createdById
|
|
type: integer
|
|
- in: query
|
|
name: description
|
|
type: string
|
|
- in: query
|
|
name: isPublish
|
|
type: boolean
|
|
- in: query
|
|
name: pageUrl
|
|
type: string
|
|
- in: query
|
|
name: statusId
|
|
type: integer
|
|
- in: query
|
|
name: thumbnailPath
|
|
type: string
|
|
- in: query
|
|
name: thumbnailUrl
|
|
type: string
|
|
- in: query
|
|
name: title
|
|
type: string
|
|
- in: query
|
|
name: count
|
|
type: integer
|
|
- in: query
|
|
name: limit
|
|
type: integer
|
|
- in: query
|
|
name: nextPage
|
|
type: integer
|
|
- in: query
|
|
name: page
|
|
type: integer
|
|
- in: query
|
|
name: previousPage
|
|
type: integer
|
|
- in: query
|
|
name: sort
|
|
type: string
|
|
- in: query
|
|
name: sortBy
|
|
type: string
|
|
- in: query
|
|
name: totalPage
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get all Magazines
|
|
tags:
|
|
- Magazines
|
|
post:
|
|
description: API for create Magazines
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
type: string
|
|
- description: Insert the X-Csrf-Token
|
|
in: header
|
|
name: X-Csrf-Token
|
|
type: string
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.MagazinesCreateRequest'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Create Magazines
|
|
tags:
|
|
- Magazines
|
|
/magazines/{id}:
|
|
delete:
|
|
description: API for delete Magazines
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
type: string
|
|
- description: Insert the X-Csrf-Token
|
|
in: header
|
|
name: X-Csrf-Token
|
|
type: string
|
|
- description: Magazines ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Delete Magazines
|
|
tags:
|
|
- Magazines
|
|
get:
|
|
description: API for getting one Magazines
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
type: string
|
|
- description: Magazines ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get one Magazines
|
|
tags:
|
|
- Magazines
|
|
put:
|
|
description: API for update Magazines
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
type: string
|
|
- description: Insert the X-Csrf-Token
|
|
in: header
|
|
name: X-Csrf-Token
|
|
type: string
|
|
- description: Magazines ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.MagazinesUpdateRequest'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Update Magazines
|
|
tags:
|
|
- Magazines
|
|
/magazines/thumbnail/{id}:
|
|
post:
|
|
description: API for Save Thumbnail of Magazines
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
type: string
|
|
- description: Insert the X-Csrf-Token
|
|
in: header
|
|
name: X-Csrf-Token
|
|
type: string
|
|
- description: Magazine ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
- description: Upload thumbnail
|
|
in: formData
|
|
name: files
|
|
required: true
|
|
type: file
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Save Thumbnail Magazines
|
|
tags:
|
|
- Magazines
|
|
/magazines/thumbnail/viewer/{thumbnailName}:
|
|
get:
|
|
description: API for View Thumbnail of Magazines
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
type: string
|
|
- description: Magazines Thumbnail Name
|
|
in: path
|
|
name: thumbnailName
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Viewer Magazines Thumbnail
|
|
tags:
|
|
- Magazines
|
|
/master-menus:
|
|
get:
|
|
description: API for getting all MasterMenus
|
|
parameters:
|
|
- in: query
|
|
name: description
|
|
type: string
|
|
- in: query
|
|
name: moduleId
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
type: string
|
|
- in: query
|
|
name: parentMenuId
|
|
type: integer
|
|
- in: query
|
|
name: statusId
|
|
type: integer
|
|
- in: query
|
|
name: count
|
|
type: integer
|
|
- in: query
|
|
name: limit
|
|
type: integer
|
|
- in: query
|
|
name: nextPage
|
|
type: integer
|
|
- in: query
|
|
name: page
|
|
type: integer
|
|
- in: query
|
|
name: previousPage
|
|
type: integer
|
|
- in: query
|
|
name: sort
|
|
type: string
|
|
- in: query
|
|
name: sortBy
|
|
type: string
|
|
- in: query
|
|
name: totalPage
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get all MasterMenus
|
|
tags:
|
|
- MasterMenus
|
|
post:
|
|
description: API for create MasterMenus
|
|
parameters:
|
|
- description: Insert the X-Csrf-Token
|
|
in: header
|
|
name: X-Csrf-Token
|
|
type: string
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.MasterMenusCreateRequest'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Create MasterMenus
|
|
tags:
|
|
- MasterMenus
|
|
/master-menus/{id}:
|
|
delete:
|
|
description: API for delete MasterMenus
|
|
parameters:
|
|
- description: Insert the X-Csrf-Token
|
|
in: header
|
|
name: X-Csrf-Token
|
|
type: string
|
|
- description: MasterMenus ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Delete MasterMenus
|
|
tags:
|
|
- MasterMenus
|
|
get:
|
|
description: API for getting one MasterMenus
|
|
parameters:
|
|
- description: MasterMenus ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get one MasterMenus
|
|
tags:
|
|
- MasterMenus
|
|
put:
|
|
description: API for update MasterMenus
|
|
parameters:
|
|
- description: Insert the X-Csrf-Token
|
|
in: header
|
|
name: X-Csrf-Token
|
|
type: string
|
|
- description: MasterMenus ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"404":
|
|
description: Not Found
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"422":
|
|
description: Unprocessable Entity
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
security:
|
|
- Bearer: []
|
|
summary: Update MasterMenus
|
|
tags:
|
|
- MasterMenus
|
|
/master-modules:
|
|
get:
|
|
description: API for getting all MasterModules
|
|
parameters:
|
|
- in: query
|
|
name: description
|
|
type: string
|
|
- in: query
|
|
name: name
|
|
type: string
|
|
- in: query
|
|
name: statusId
|
|
type: integer
|
|
- in: query
|
|
name: count
|
|
type: integer
|
|
- in: query
|
|
name: limit
|
|
type: integer
|
|
- in: query
|
|
name: nextPage
|
|
type: integer
|
|
- in: query
|
|
name: page
|
|
type: integer
|
|
- in: query
|
|
name: previousPage
|
|
type: integer
|
|
- in: query
|
|
name: sort
|
|
type: string
|
|
- in: query
|
|
name: sortBy
|
|
type: string
|
|
- in: query
|
|
name: totalPage
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get all MasterModules
|
|
tags:
|
|
- MasterModules
|
|
post:
|
|
description: API for create MasterModules
|
|
parameters:
|
|
- description: Insert the X-Csrf-Token
|
|
in: header
|
|
name: X-Csrf-Token
|
|
type: string
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.MasterModulesCreateRequest'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Create MasterModules
|
|
tags:
|
|
- MasterModules
|
|
/master-modules/{id}:
|
|
delete:
|
|
description: API for delete MasterModules
|
|
parameters:
|
|
- description: Insert the X-Csrf-Token
|
|
in: header
|
|
name: X-Csrf-Token
|
|
type: string
|
|
- description: MasterModules ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Delete MasterModules
|
|
tags:
|
|
- MasterModules
|
|
get:
|
|
description: API for getting one MasterModules
|
|
parameters:
|
|
- description: MasterModules ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get one MasterModules
|
|
tags:
|
|
- MasterModules
|
|
put:
|
|
description: API for update MasterModules
|
|
parameters:
|
|
- description: Insert the X-Csrf-Token
|
|
in: header
|
|
name: X-Csrf-Token
|
|
type: string
|
|
- description: MasterModules ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.MasterModulesUpdateRequest'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Update MasterModules
|
|
tags:
|
|
- MasterModules
|
|
/master-statuses:
|
|
get:
|
|
description: API for getting all MasterStatuses
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"404":
|
|
description: Not Found
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"422":
|
|
description: Unprocessable Entity
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get all MasterStatuses
|
|
tags:
|
|
- Untags
|
|
post:
|
|
description: API for create MasterStatuses
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"404":
|
|
description: Not Found
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"422":
|
|
description: Unprocessable Entity
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
security:
|
|
- Bearer: []
|
|
summary: Create MasterStatuses
|
|
tags:
|
|
- Untags
|
|
/master-statuses/{id}:
|
|
delete:
|
|
description: API for delete MasterStatuses
|
|
parameters:
|
|
- description: MasterStatuses ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"404":
|
|
description: Not Found
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"422":
|
|
description: Unprocessable Entity
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
security:
|
|
- Bearer: []
|
|
summary: Delete MasterStatuses
|
|
tags:
|
|
- Untags
|
|
get:
|
|
description: API for getting one MasterStatuses
|
|
parameters:
|
|
- description: MasterStatuses ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"404":
|
|
description: Not Found
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"422":
|
|
description: Unprocessable Entity
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get one MasterStatuses
|
|
tags:
|
|
- Untags
|
|
put:
|
|
description: API for update MasterStatuses
|
|
parameters:
|
|
- description: MasterStatuses ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"404":
|
|
description: Not Found
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"422":
|
|
description: Unprocessable Entity
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
security:
|
|
- Bearer: []
|
|
summary: Update MasterStatuses
|
|
tags:
|
|
- Untags
|
|
/provinces:
|
|
get:
|
|
description: API for getting all Provinces
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"404":
|
|
description: Not Found
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"422":
|
|
description: Unprocessable Entity
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get all Provinces
|
|
tags:
|
|
- Untags
|
|
post:
|
|
description: API for create Provinces
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"404":
|
|
description: Not Found
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"422":
|
|
description: Unprocessable Entity
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
security:
|
|
- Bearer: []
|
|
summary: Create Provinces
|
|
tags:
|
|
- Untags
|
|
/provinces/{id}:
|
|
delete:
|
|
description: API for delete Provinces
|
|
parameters:
|
|
- description: Provinces ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"404":
|
|
description: Not Found
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"422":
|
|
description: Unprocessable Entity
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
security:
|
|
- Bearer: []
|
|
summary: Delete Provinces
|
|
tags:
|
|
- Untags
|
|
get:
|
|
description: API for getting one Provinces
|
|
parameters:
|
|
- description: Provinces ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"404":
|
|
description: Not Found
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"422":
|
|
description: Unprocessable Entity
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get one Provinces
|
|
tags:
|
|
- Untags
|
|
put:
|
|
description: API for update Provinces
|
|
parameters:
|
|
- description: Provinces ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"404":
|
|
description: Not Found
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"422":
|
|
description: Unprocessable Entity
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
security:
|
|
- Bearer: []
|
|
summary: Update Provinces
|
|
tags:
|
|
- Untags
|
|
/schedules:
|
|
get:
|
|
description: API for getting all Schedules
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
required: true
|
|
type: string
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- in: query
|
|
name: createdById
|
|
type: integer
|
|
- in: query
|
|
name: description
|
|
type: string
|
|
- in: query
|
|
name: endDate
|
|
type: string
|
|
- in: query
|
|
name: isLiveStreaming
|
|
type: boolean
|
|
- in: query
|
|
name: location
|
|
type: string
|
|
- in: query
|
|
name: speakers
|
|
type: string
|
|
- in: query
|
|
name: startDate
|
|
type: string
|
|
- in: query
|
|
name: statusId
|
|
type: integer
|
|
- in: query
|
|
name: title
|
|
type: string
|
|
- in: query
|
|
name: typeId
|
|
type: integer
|
|
- in: query
|
|
name: count
|
|
type: integer
|
|
- in: query
|
|
name: limit
|
|
type: integer
|
|
- in: query
|
|
name: nextPage
|
|
type: integer
|
|
- in: query
|
|
name: page
|
|
type: integer
|
|
- in: query
|
|
name: previousPage
|
|
type: integer
|
|
- in: query
|
|
name: sort
|
|
type: string
|
|
- in: query
|
|
name: sortBy
|
|
type: string
|
|
- in: query
|
|
name: totalPage
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get all Schedules
|
|
tags:
|
|
- Schedules
|
|
post:
|
|
description: API for create Schedule
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
type: string
|
|
- description: Insert the X-Csrf-Token
|
|
in: header
|
|
name: X-Csrf-Token
|
|
type: string
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.SchedulesCreateRequest'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Create Schedule
|
|
tags:
|
|
- Schedules
|
|
/schedules/{id}:
|
|
delete:
|
|
description: API for delete Schedule
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
type: string
|
|
- description: Insert the X-Csrf-Token
|
|
in: header
|
|
name: X-Csrf-Token
|
|
type: string
|
|
- description: Schedule ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Delete Schedule
|
|
tags:
|
|
- Schedules
|
|
get:
|
|
description: API for getting one Schedule
|
|
parameters:
|
|
- description: Schedule ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get one Schedule
|
|
tags:
|
|
- Schedules
|
|
put:
|
|
description: API for update Schedule
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
type: string
|
|
- description: Insert the X-Csrf-Token
|
|
in: header
|
|
name: X-Csrf-Token
|
|
type: string
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.SchedulesUpdateRequest'
|
|
- description: Schedule ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Update Schedule
|
|
tags:
|
|
- Schedules
|
|
/subscription:
|
|
get:
|
|
description: API for getting all Subscription
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
type: string
|
|
- in: query
|
|
name: email
|
|
type: string
|
|
- in: query
|
|
name: count
|
|
type: integer
|
|
- in: query
|
|
name: limit
|
|
type: integer
|
|
- in: query
|
|
name: nextPage
|
|
type: integer
|
|
- in: query
|
|
name: page
|
|
type: integer
|
|
- in: query
|
|
name: previousPage
|
|
type: integer
|
|
- in: query
|
|
name: sort
|
|
type: string
|
|
- in: query
|
|
name: sortBy
|
|
type: string
|
|
- in: query
|
|
name: totalPage
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get all Subscription
|
|
tags:
|
|
- Subscription
|
|
post:
|
|
description: API for create Subscription
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
type: string
|
|
- description: Insert the X-Csrf-Token
|
|
in: header
|
|
name: X-Csrf-Token
|
|
type: string
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.SubscriptionCreateRequest'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Create Subscription
|
|
tags:
|
|
- Subscription
|
|
/subscription/{id}:
|
|
delete:
|
|
description: API for delete Subscription
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
type: string
|
|
- description: Insert the X-Csrf-Token
|
|
in: header
|
|
name: X-Csrf-Token
|
|
type: string
|
|
- description: Subscription ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: delete Subscription
|
|
tags:
|
|
- Subscription
|
|
get:
|
|
description: API for getting one Subscription
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
type: string
|
|
- description: Subscription ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get one Subscription
|
|
tags:
|
|
- Subscription
|
|
put:
|
|
description: API for update Subscription
|
|
parameters:
|
|
- description: Insert the X-Client-Key
|
|
in: header
|
|
name: X-Client-Key
|
|
type: string
|
|
- description: Insert the X-Csrf-Token
|
|
in: header
|
|
name: X-Csrf-Token
|
|
type: string
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.SubscriptionUpdateRequest'
|
|
- description: Subscription ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: update Subscription
|
|
tags:
|
|
- Subscription
|
|
/user-levels:
|
|
get:
|
|
description: API for getting all UserLevels
|
|
parameters:
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- in: query
|
|
name: levelNumber
|
|
type: integer
|
|
- in: query
|
|
name: name
|
|
type: string
|
|
- in: query
|
|
name: parentLevelId
|
|
type: integer
|
|
- in: query
|
|
name: provinceId
|
|
type: integer
|
|
- in: query
|
|
name: count
|
|
type: integer
|
|
- in: query
|
|
name: limit
|
|
type: integer
|
|
- in: query
|
|
name: nextPage
|
|
type: integer
|
|
- in: query
|
|
name: page
|
|
type: integer
|
|
- in: query
|
|
name: previousPage
|
|
type: integer
|
|
- in: query
|
|
name: sort
|
|
type: string
|
|
- in: query
|
|
name: sortBy
|
|
type: string
|
|
- in: query
|
|
name: totalPage
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get all UserLevels
|
|
tags:
|
|
- UserLevels
|
|
post:
|
|
description: API for create UserLevels
|
|
parameters:
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- description: Insert the X-Csrf-Token
|
|
in: header
|
|
name: X-Csrf-Token
|
|
type: string
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.UserLevelsCreateRequest'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Create UserLevels
|
|
tags:
|
|
- UserLevels
|
|
/user-levels/{id}:
|
|
delete:
|
|
description: API for delete UserLevels
|
|
parameters:
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- description: Insert the X-Csrf-Token
|
|
in: header
|
|
name: X-Csrf-Token
|
|
type: string
|
|
- description: UserLevels ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"404":
|
|
description: Not Found
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"422":
|
|
description: Unprocessable Entity
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
security:
|
|
- Bearer: []
|
|
summary: delete UserLevels
|
|
tags:
|
|
- UserLevels
|
|
get:
|
|
description: API for getting one UserLevels
|
|
parameters:
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- description: UserLevels ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get one UserLevels
|
|
tags:
|
|
- UserLevels
|
|
put:
|
|
description: API for update UserLevels
|
|
parameters:
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- description: Insert the X-Csrf-Token
|
|
in: header
|
|
name: X-Csrf-Token
|
|
type: string
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.UserLevelsUpdateRequest'
|
|
- description: UserLevels ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: update UserLevels
|
|
tags:
|
|
- UserLevels
|
|
/user-levels/alias/{alias}:
|
|
get:
|
|
description: API for getting one UserLevels
|
|
parameters:
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- description: UserLevels Alias
|
|
in: path
|
|
name: alias
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get one UserLevels
|
|
tags:
|
|
- UserLevels
|
|
/user-levels/enable-approval:
|
|
post:
|
|
description: API for Enable Approval of Article
|
|
parameters:
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- description: Insert the X-Csrf-Token
|
|
in: header
|
|
name: X-Csrf-Token
|
|
type: string
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.UserLevelsApprovalRequest'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: EnableApproval Articles
|
|
tags:
|
|
- UserLevels
|
|
/user-role-accesses:
|
|
get:
|
|
description: API for getting all UserRoleAccesses
|
|
parameters:
|
|
- in: query
|
|
name: isActive
|
|
required: true
|
|
type: boolean
|
|
- in: query
|
|
name: menuId
|
|
required: true
|
|
type: integer
|
|
- in: query
|
|
name: userRoleId
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get all UserRoleAccesses
|
|
tags:
|
|
- UserRoleAccesses
|
|
post:
|
|
description: API for create UserRoleAccesses
|
|
parameters:
|
|
- description: Insert the X-Csrf-Token
|
|
in: header
|
|
name: X-Csrf-Token
|
|
type: string
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.UserRoleAccessesCreateRequest'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Create UserRoleAccesses
|
|
tags:
|
|
- UserRoleAccesses
|
|
/user-role-accesses/{id}:
|
|
delete:
|
|
description: API for delete UserRoleAccesses
|
|
parameters:
|
|
- description: Insert the X-Csrf-Token
|
|
in: header
|
|
name: X-Csrf-Token
|
|
type: string
|
|
- description: UserRoleAccesses ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: delete UserRoleAccesses
|
|
tags:
|
|
- UserRoleAccesses
|
|
get:
|
|
description: API for getting one UserRoleAccesses
|
|
parameters:
|
|
- description: UserRoleAccesses ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get one UserRoleAccesses
|
|
tags:
|
|
- UserRoleAccesses
|
|
put:
|
|
description: API for update UserRoleAccesses
|
|
parameters:
|
|
- description: Insert the X-Csrf-Token
|
|
in: header
|
|
name: X-Csrf-Token
|
|
type: string
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.UserRoleAccessesUpdateRequest'
|
|
- description: UserRoleAccesses ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: update UserRoleAccesses
|
|
tags:
|
|
- UserRoleAccesses
|
|
/user-role-level-details:
|
|
get:
|
|
description: API for getting all UserRoleLevelDetails
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"404":
|
|
description: Not Found
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"422":
|
|
description: Unprocessable Entity
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get all UserRoleLevelDetails
|
|
tags:
|
|
- Task
|
|
post:
|
|
description: API for create UserRoleLevelDetails
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"404":
|
|
description: Not Found
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"422":
|
|
description: Unprocessable Entity
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
security:
|
|
- Bearer: []
|
|
summary: Create UserRoleLevelDetails
|
|
tags:
|
|
- Task
|
|
/user-role-level-details/{id}:
|
|
delete:
|
|
description: API for delete UserRoleLevelDetails
|
|
parameters:
|
|
- description: UserRoleLevelDetails ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"404":
|
|
description: Not Found
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"422":
|
|
description: Unprocessable Entity
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
security:
|
|
- Bearer: []
|
|
summary: delete UserRoleLevelDetails
|
|
tags:
|
|
- Task
|
|
get:
|
|
description: API for getting one UserRoleLevelDetails
|
|
parameters:
|
|
- description: UserRoleLevelDetails ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"404":
|
|
description: Not Found
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"422":
|
|
description: Unprocessable Entity
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get one UserRoleLevelDetails
|
|
tags:
|
|
- Task
|
|
put:
|
|
description: API for update UserRoleLevelDetails
|
|
parameters:
|
|
- description: UserRoleLevelDetails ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"404":
|
|
description: Not Found
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"422":
|
|
description: Unprocessable Entity
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
security:
|
|
- Bearer: []
|
|
summary: update UserRoleLevelDetails
|
|
tags:
|
|
- Task
|
|
/user-roles:
|
|
get:
|
|
description: API for getting all UserRoles
|
|
parameters:
|
|
- in: query
|
|
name: code
|
|
type: string
|
|
- in: query
|
|
name: description
|
|
type: string
|
|
- in: query
|
|
name: name
|
|
type: string
|
|
- in: query
|
|
name: statusId
|
|
type: integer
|
|
- in: query
|
|
name: userLevelId
|
|
type: integer
|
|
- in: query
|
|
name: count
|
|
type: integer
|
|
- in: query
|
|
name: limit
|
|
type: integer
|
|
- in: query
|
|
name: nextPage
|
|
type: integer
|
|
- in: query
|
|
name: page
|
|
type: integer
|
|
- in: query
|
|
name: previousPage
|
|
type: integer
|
|
- in: query
|
|
name: sort
|
|
type: string
|
|
- in: query
|
|
name: sortBy
|
|
type: string
|
|
- in: query
|
|
name: totalPage
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get all UserRoles
|
|
tags:
|
|
- UserRoles
|
|
post:
|
|
description: API for create UserRoles
|
|
parameters:
|
|
- description: Insert the X-Csrf-Token
|
|
in: header
|
|
name: X-Csrf-Token
|
|
type: string
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.UserRolesCreateRequest'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Create UserRoles
|
|
tags:
|
|
- UserRoles
|
|
/user-roles/{id}:
|
|
delete:
|
|
description: API for delete UserRoles
|
|
parameters:
|
|
- description: Insert the X-Csrf-Token
|
|
in: header
|
|
name: X-Csrf-Token
|
|
type: string
|
|
- description: UserRoles ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: delete UserRoles
|
|
tags:
|
|
- UserRoles
|
|
get:
|
|
description: API for getting one UserRoles
|
|
parameters:
|
|
- description: UserRoles ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get one UserRoles
|
|
tags:
|
|
- UserRoles
|
|
put:
|
|
description: API for update UserRoles
|
|
parameters:
|
|
- description: Insert the X-Csrf-Token
|
|
in: header
|
|
name: X-Csrf-Token
|
|
type: string
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.UserRolesUpdateRequest'
|
|
- description: UserRoles ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: update UserRoles
|
|
tags:
|
|
- UserRoles
|
|
/users:
|
|
get:
|
|
description: API for getting all Users
|
|
parameters:
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- in: query
|
|
name: count
|
|
type: integer
|
|
- in: query
|
|
name: limit
|
|
type: integer
|
|
- in: query
|
|
name: nextPage
|
|
type: integer
|
|
- in: query
|
|
name: page
|
|
type: integer
|
|
- in: query
|
|
name: previousPage
|
|
type: integer
|
|
- in: query
|
|
name: sort
|
|
type: string
|
|
- in: query
|
|
name: sortBy
|
|
type: string
|
|
- in: query
|
|
name: totalPage
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get all Users
|
|
tags:
|
|
- Users
|
|
post:
|
|
description: API for create Users
|
|
parameters:
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.UsersCreateRequest'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Create Users
|
|
tags:
|
|
- Users
|
|
/users/{id}:
|
|
delete:
|
|
description: API for delete Users
|
|
parameters:
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- description: Users ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: delete Users
|
|
tags:
|
|
- Users
|
|
put:
|
|
description: API for update Users
|
|
parameters:
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- description: Users ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.UsersUpdateRequest'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: update Users
|
|
tags:
|
|
- Users
|
|
/users/detail/{id}:
|
|
get:
|
|
description: API for getting one Users
|
|
parameters:
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- description: Users ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get one Users
|
|
tags:
|
|
- Users
|
|
/users/email-validation:
|
|
post:
|
|
description: API for Email Validation Users
|
|
parameters:
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.UserEmailValidationRequest'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: EmailValidation Users
|
|
tags:
|
|
- Users
|
|
/users/forgot-password:
|
|
post:
|
|
description: API for ForgotPassword Users
|
|
parameters:
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.UserForgotPassword'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: ForgotPassword Users
|
|
tags:
|
|
- Users
|
|
/users/info:
|
|
get:
|
|
description: API for ShowUserInfo
|
|
parameters:
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: ShowInfo Users
|
|
tags:
|
|
- Users
|
|
/users/login:
|
|
post:
|
|
description: API for Login Users
|
|
parameters:
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.UserLogin'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Login Users
|
|
tags:
|
|
- Users
|
|
/users/otp-request:
|
|
post:
|
|
description: API for OtpRequest Users
|
|
parameters:
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.UserOtpRequest'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: OtpRequest Users
|
|
tags:
|
|
- Users
|
|
/users/otp-validation:
|
|
post:
|
|
description: API for OtpValidation Users
|
|
parameters:
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.UserOtpValidation'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: OtpValidation Users
|
|
tags:
|
|
- Users
|
|
/users/pareto-login:
|
|
post:
|
|
description: API for ParetoLogin Users
|
|
parameters:
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.UserLogin'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: ParetoLogin Users
|
|
tags:
|
|
- Users
|
|
/users/reset-password:
|
|
post:
|
|
description: API for ResetPassword Users
|
|
parameters:
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.UserResetPassword'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: ResetPassword Users
|
|
tags:
|
|
- Users
|
|
/users/save-password:
|
|
post:
|
|
description: API for SavePassword Users
|
|
parameters:
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.UserSavePassword'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: SavePassword Users
|
|
tags:
|
|
- Users
|
|
/users/setup-email:
|
|
post:
|
|
description: API for Setup Email Users
|
|
parameters:
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- description: Required payload
|
|
in: body
|
|
name: payload
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/request.UserEmailValidationRequest'
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: SetupEmail Users
|
|
tags:
|
|
- Users
|
|
/users/username/{username}:
|
|
get:
|
|
description: API for getting one Users
|
|
parameters:
|
|
- default: Bearer <Add access token here>
|
|
description: Insert your access token
|
|
in: header
|
|
name: Authorization
|
|
type: string
|
|
- description: Username
|
|
in: path
|
|
name: username
|
|
required: true
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/response.Response'
|
|
"400":
|
|
description: Bad Request
|
|
schema:
|
|
$ref: '#/definitions/response.BadRequestError'
|
|
"401":
|
|
description: Unauthorized
|
|
schema:
|
|
$ref: '#/definitions/response.UnauthorizedError'
|
|
"500":
|
|
description: Internal Server Error
|
|
schema:
|
|
$ref: '#/definitions/response.InternalServerError'
|
|
security:
|
|
- Bearer: []
|
|
summary: Get one Users
|
|
tags:
|
|
- Users
|
|
swagger: "2.0"
|