Skip to content

Ot199 89 documentando endpoints #130

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Exequiel65 wants to merge 5 commits into
base: development
Choose a base branch
from
Open

Ot199 89 documentando endpoints #130

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
fdb4b46
add endpoints activity, users and auth documentation
Exequiel65 Jun 14, 2022
8f168b5
add documentation endpoints comments, contacts and members
Exequiel65 Jun 14, 2022
b4ba980
add documentation endpoint for news, organization
Exequiel65 Jun 14, 2022
283925d
add slides and testimonial Documentation documentation
Exequiel65 Jun 14, 2022
847ebf1
change activity controller documentation
Exequiel65 Jun 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion controllers/activityController.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ const httpStatus = require("../helpers/httpStatus");
const { Activity } = require("../models");

class ActivityController {

static async getActivities(req, res) {
try {
const getAllAct = await Activity.findAll({
Expand Down
278 changes: 278 additions & 0 deletions documentation/activityDocumentation.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,278 @@
/**
* @swagger
* components:
* schemas:
* Activities:
* type: object
* required:
* - name
* properties:
* id:
* type: string
* description: The auto-generated id of the Activity
* name:
* type: string
* description: Activity Name
* content:
* type: string
* description: Activity Content
* image:
* type: string
* description: image url
* example:
* id: 1
* name: Support group
* content: Something about that
* image: some-url
* Errors:
* type: object
* required:
* - statusCode
* - message
* properties:
* statusCode:
* type: number
* description: Http Status Code
* message:
* type: string
* description: Message return to the User
* example:
* statusCode: 500
* message: Something went wrong, the server was unable to complete your request
*
*/

/**
* @swagger
* tags:
* name: Activities
* description: CRUD Routes of Activities, only available for Admin
*/

/**
* @swagger
* /activities/all:
* get:
* summary: Returns the list of all activities
* tags: [Activities]
* security:
* responses:
* 200:
* description: OK
* content:
* application/json:
* schema:
* type: array
* items:
* $ref: '#/components/schemas/Activities'
* 500:
* description: Internal Server Error
* content:
* application/json:
* schema:
* type: object
* items:
* $ref: '#/components/schemas/Errors'
*/

/**
* @swagger
* /activities/{name}:
* get:
* summary: Obtain the activities by Name
* tags: [Activities]
* security:
* - bearerAuth: []
* parameters:
* - in: path
* name: name
* schema:
* type: string
* required: true
* description: The activity name
* responses:
* 200:
* description: ok
* content:
* application/json:
* schema:
* type: object
* 401:
* description: Unauthorized
* content:
* application/json:
* schema:
* type: object
* items:
* $ref: '#/components/schemas/Errors'
* 500:
* description: Internal Server Error
* content:
* application/json:
* schema:
* type: object
* items:
* $ref: '#/components/schemas/Errors'
*/

/**
* @swagger
* /activities:
* post:
* summary: Create a new activity
* tags: [Activities]
* security:
* - bearerAuth: []
* requestBody:
* required: true
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Activities'
* responses:
* 200:
* description: The Activity was successfully created
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Activities'
* 400:
* description: Bad Request
* content:
* application/json:
* schema:
* type: object
* items:
* $ref: '#/components/schemas/Errors'
* 401:
* description: Unauthorized
* content:
* application/json:
* schema:
* type: object
* items:
* $ref: '#/components/schemas/Errors'
* 500:
* description: Internal Server Error
* content:
* application/json:
* schema:
* type: object
* items:
* $ref: '#/components/schemas/Errors'
*/

/**
* @swagger
* /activities/{id}:
* put:
* summary: Update the activity by the id
* tags: [Activities]
* security:
* - bearerAuth: []
* parameters:
* - in: path
* name: id
* schema:
* type: number
* required: true
* description: The activity id
* requestBody:
* required: true
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Activities'
* responses:
* 200:
* description: The activity was updated
* content:
* application/json:
* schema:
* type: object
* 404:
* description: The activity was not found
* content:
* application/json:
* schema:
* type: object
* items:
* $ref: '#/components/schemas/Errors'
* 400:
* description: Bad Request
* content:
* application/json:
* schema:
* type: object
* items:
* $ref: '#/components/schemas/Errors'
* 401:
* description: Unauthorized
* content:
* application/json:
* schema:
* type: object
* items:
* $ref: '#/components/schemas/Errors'
* 500:
* description: Internal Server Error
* content:
* application/json:
* schema:
* type: object
* items:
* $ref: '#/components/schemas/Errors'
*/

/**
* @swagger
* /activities/{name}:
* delete:
* summary: Remove the activity by Name
* tags: [Activities]
* security:
* - bearerAuth: []
* parameters:
* - in: path
* name: name
* schema:
* type: string
* required: true
* description: The activity id
*
* responses:
* 200:
* description: The activity was deleted
* 404:
* description: The activity was not found
* content:
* application/json:
* schema:
* type: object
* items:
* $ref: '#/components/schemas/Errors'
* 400:
* description: Bad Request
* content:
* application/json:
* schema:
* type: object
* items:
* $ref: '#/components/schemas/Errors'
* 401:
* description: Unauthorized
* content:
* application/json:
* schema:
* type: object
* items:
* $ref: '#/components/schemas/Errors'
* 500:
* description: Internal Server Error
* content:
* application/json:
* schema:
* type: object
* items:
* $ref: '#/components/schemas/Errors'
*/
Loading