Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
jami-plugins-store
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Iterations
Code
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Locked files
Deploy
Releases
Model registry
Analyze
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
savoirfairelinux
jami-plugins-store
Commits
01b9b791
Commit
01b9b791
authored
1 year ago
by
Charles-Francis Damedey
Committed by
Sébastien Blin
1 year ago
Browse files
Options
Downloads
Patches
Plain Diff
misc: add api documentation
GitLab:
#4
Change-Id: I5820981f64599b9abffef478da8496e27fe0f32a
parent
a63c6f97
No related branches found
No related tags found
No related merge requests found
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
src/controllers/plugins.controller.ts
+192
-18
192 additions, 18 deletions
src/controllers/plugins.controller.ts
with
192 additions
and
18 deletions
src/controllers/plugins.controller.ts
+
192
−
18
View file @
01b9b791
...
@@ -30,27 +30,52 @@ export class PluginsController {
...
@@ -30,27 +30,52 @@ export class PluginsController {
this
.
configureRouter
();
this
.
configureRouter
();
}
}
private
configureRouter
():
void
{
if
(
this
.
router
===
undefined
)
{
this
.
router
=
Router
();
}
/**
/**
* @swagger
* @swagger
* tags:
* name: Example
* description: Example API endpoints
* externalDocs:
* description: Find out more about Example
* url: http://example.com
*
*
* /plugins:
arch:
* /plugins:
* get:
* get:
* description: Returns the plugins for a given architecture
* summary: Get plugins for a given architecture
* tags:
* description: Returns the plugins for a given architecture.
* - Example
* tags: [Example, Time]
* - Time
* parameters:
* produces:
* - name: arch
* - application/json
* in: query
* description: The architecture for which plugins are requested.
* required: true
* schema:
* type: string
* responses:
* responses:
* 200:
* '200':
* description: Successful response with the plugins data.
* content:
* application/json:
* schema:
* schema:
* $ref: '#/definitions/Message'
* type: array
* items:
* type: object
* properties:
* name:
* type: string
* version:
* type: string
* author:
* type: string
* '400':
* description: Bad request - When the 'arch' parameter is missing.
* '500':
* description: Internal server error - Something went wrong on the server.
*/
*/
private
configureRouter
():
void
{
// GET /plugins
if
(
this
.
router
===
undefined
)
{
this
.
router
=
Router
();
}
// eslint-disable-next-line @typescript-eslint/no-misused-promises
// eslint-disable-next-line @typescript-eslint/no-misused-promises
this
.
router
.
get
(
'
/
'
,
async
(
req
:
Request
,
res
:
Response
)
=>
{
this
.
router
.
get
(
'
/
'
,
async
(
req
:
Request
,
res
:
Response
)
=>
{
try
{
try
{
...
@@ -66,6 +91,48 @@ export class PluginsController {
...
@@ -66,6 +91,48 @@ export class PluginsController {
}
}
});
});
/**
* @swagger
*
* /details/:id:
* get:
* summary: Get details of a plugin for a given ID and architecture
* description: Returns details of a plugin for a given ID and architecture.
* tags: [Example, Time]
* parameters:
* - name: id
* in: path
* description: The ID of the plugin.
* required: true
* schema:
* type: string
* - name: arch
* in: query
* description: The architecture for which the plugin details are requested.
* required: true
* schema:
* type: string
* responses:
* '200':
* description: Successful response with the plugin details.
* content:
* application/json:
* schema:
* type: object
* properties:
* name:
* type: string
* version:
* type: string
* author:
* type: string
* '400':
* description: Bad request - When the 'id' or 'arch' parameter is missing.
* '404':
* description: Not found - When the plugin with the specified ID is not found.
* '500':
* description: Internal server error - Something went wrong on the server.
*/
// GET /details/:id?arch=:arch
// GET /details/:id?arch=:arch
// eslint-disable-next-line @typescript-eslint/no-misused-promises
// eslint-disable-next-line @typescript-eslint/no-misused-promises
this
.
router
.
get
(
'
/details/:id
'
,
async
(
req
:
Request
,
res
:
Response
)
=>
{
this
.
router
.
get
(
'
/details/:id
'
,
async
(
req
:
Request
,
res
:
Response
)
=>
{
...
@@ -88,6 +155,44 @@ export class PluginsController {
...
@@ -88,6 +155,44 @@ export class PluginsController {
}
}
});
});
/**
* @swagger
*
* /download/{arch}/{id}:
* get:
* summary: Download a plugin file for a given ID and architecture
* description: Download a plugin file for a given ID and architecture.
* tags: [Example, Time]
* parameters:
* - name: id
* in: path
* description: The ID of the plugin to be downloaded.
* required: true
* schema:
* type: string
* - name: arch
* in: path
* description: The architecture for which the plugin is requested.
* required: true
* schema:
* type: string
* responses:
* '200':
* description: Successful response with the plugin file download.
* content:
* application/octet-stream:
* schema:
* type: string
* format: binary
* '400':
* description: Bad request - When the 'id' or 'arch' parameter is missing.
* '404':
* description: Not found - When the plugin file with the specified ID and architecture is not found.
* '500':
* description: Internal server error - Something went wrong on the server.
*
*/
// GET /download/:arch/:id
// GET /download/:arch/:id
// eslint-disable-next-line @typescript-eslint/no-misused-promises
// eslint-disable-next-line @typescript-eslint/no-misused-promises
this
.
router
.
get
(
this
.
router
.
get
(
...
@@ -123,7 +228,44 @@ export class PluginsController {
...
@@ -123,7 +228,44 @@ export class PluginsController {
}
}
);
);
// GET /icon/:id?arch=:arch
/**
* @swagger
*
* /icons/{id}:
* get:
* summary: Get the icon for a plugin with a given ID and architecture
* description: Returns the icon for a plugin with a given ID and architecture.
* tags: [Example, Time]
* parameters:
* - name: id
* in: path
* description: The ID of the plugin to get the icon for.
* required: true
* schema:
* type: string
* - name: arch
* in: query
* description: The architecture for which the plugin icon is requested.
* required: true
* schema:
* type: string
* responses:
* '200':
* description: Successful response with the plugin icon image.
* content:
* image/svg+xml:
* schema:
* type: string
* format: binary
* '400':
* description: Bad request - When the 'id' or 'arch' parameter is missing.
* '404':
* description: Not found - When the plugin icon with the specified ID and architecture is not found.
* '500':
* description: Internal server error - Something went wrong on the server.
*/
// GET /icons/:id?arch=:arch
// eslint-disable-next-line
// eslint-disable-next-line
this
.
router
.
get
(
'
/icons/:id
'
,
async
(
req
:
Request
,
res
:
Response
)
=>
{
this
.
router
.
get
(
'
/icons/:id
'
,
async
(
req
:
Request
,
res
:
Response
)
=>
{
try
{
try
{
...
@@ -146,6 +288,38 @@ export class PluginsController {
...
@@ -146,6 +288,38 @@ export class PluginsController {
}
}
});
});
/**
* @swagger
*
* /versions:
* get:
* summary: Get the versions of a plugin for a given architecture
* description: Returns the versions of a plugin for a given architecture.
* tags: [Example, Time]
* parameters:
* - name: arch
* in: query
* description: The architecture for which plugin versions are requested.
* required: true
* schema:
* type: string
* responses:
* '200':
* description: Successful response with the plugin versions.
* content:
* application/json:
* schema:
* type: array
* items:
* type: string
* '400':
* description: Bad request - When the 'arch' parameter is missing.
* '404':
* description: Not found - When no plugin versions are available for the specified architecture.
* '500':
* description: Internal server error - Something went wrong on the server.
*/
// GET /versions/:id?arch=:arch
// GET /versions/:id?arch=:arch
// eslint-disable-next-line @typescript-eslint/no-misused-promises
// eslint-disable-next-line @typescript-eslint/no-misused-promises
this
.
router
.
get
(
'
/versions/
'
,
async
(
req
:
Request
,
res
:
Response
)
=>
{
this
.
router
.
get
(
'
/versions/
'
,
async
(
req
:
Request
,
res
:
Response
)
=>
{
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment