1
0
mirror of https://github.com/flextype/flextype.git synced 2025-08-06 13:16:45 +02:00

feat(endpoints): set api version v1

This commit is contained in:
Awilum
2022-06-18 12:05:02 +03:00
parent fb5f1d2083
commit 4476e5e050
4 changed files with 30 additions and 30 deletions

View File

@@ -23,7 +23,7 @@ use function app;
/**
* Clear cache.
*
* endpoint: POST /api/v0/cache/clear
* endpoint: POST /api/v1/cache/clear
*
* Body:
* token - [REQUIRED] - Valid public token.
@@ -32,4 +32,4 @@ use function app;
* Returns:
* Empty body with HTTP status 204
*/
app()->post('/api/v0/cache/clear', [Cache::class, 'clear'])->setName('cache.clear');
app()->post('/api/v1/cache/clear', [Cache::class, 'clear'])->setName('cache.clear');

View File

@@ -23,7 +23,7 @@ use function app;
/**
* Fetch entry
*
* endpoint: GET /api/v0/entries
* endpoint: GET /api/v1/entries
*
* Query:
* id - [REQUIRED] - Unique identifier of the entry.
@@ -33,12 +33,12 @@ use function app;
* Returns:
* Entry object.
*/
app()->get('/api/v0/entries', [Entries::class, 'fetch'])->setName('entries.fetch');
app()->get('/api/v1/entries', [Entries::class, 'fetch'])->setName('entries.fetch');
/**
* Create entry
*
* endpoint: POST /api/v0/entries
* endpoint: POST /api/v1/entries
*
* Body:
* id - [REQUIRED] - Unique identifier of the entry.
@@ -49,12 +49,12 @@ app()->get('/api/v0/entries', [Entries::class, 'fetch'])->setName('entries.fetch
* Returns:
* Entry object with the entry that was just created.
*/
app()->post('/api/v0/entries', [Entries::class, 'create'])->setName('entries.create');
app()->post('/api/v1/entries', [Entries::class, 'create'])->setName('entries.create');
/**
* Update entry
*
* endpoint: PATCH /api/v0/entries
* endpoint: PATCH /api/v1/entries
*
* Body:
* id - [REQUIRED] - Unique identifier of the entry.
@@ -65,12 +65,12 @@ app()->post('/api/v0/entries', [Entries::class, 'create'])->setName('entries.cre
* Returns:
* Entry object for the entry that was just updated.
*/
app()->patch('/api/v0/entries', [Entries::class, 'update'])->setName('entries.update');
app()->patch('/api/v1/entries', [Entries::class, 'update'])->setName('entries.update');
/**
* Move entry
*
* endpoint: PUT /api/v0/entries
* endpoint: PUT /api/v1/entries
*
* Body:
* id - [REQUIRED] - Unique identifier of the entry.
@@ -81,12 +81,12 @@ app()->patch('/api/v0/entries', [Entries::class, 'update'])->setName('entries.up
* Returns:
* Entry object with the entry that was just moved.
*/
app()->put('/api/v0/entries', [Entries::class, 'move'])->setName('entries.move');
app()->put('/api/v1/entries', [Entries::class, 'move'])->setName('entries.move');
/**
* Copy entry
*
* endpoint: PUT /api/v0/entries/copy
* endpoint: PUT /api/v1/entries/copy
*
* Body:
* id - [REQUIRED] - Unique identifier of the entry.
@@ -97,12 +97,12 @@ app()->put('/api/v0/entries', [Entries::class, 'move'])->setName('entries.move')
* Returns:
* Entry object with the entry that was just copied.
*/
app()->put('/api/v0/entries/copy', [Entries::class, 'copy'])->setName('entries.copy');
app()->put('/api/v1/entries/copy', [Entries::class, 'copy'])->setName('entries.copy');
/**
* Delete entry
*
* endpoint: DELETE /api/v0/entries
* endpoint: DELETE /api/v1/entries
*
* Body:
* id - [REQUIRED] - Unique identifier of the entry.
@@ -112,4 +112,4 @@ app()->put('/api/v0/entries/copy', [Entries::class, 'copy'])->setName('entries.c
* Returns:
* Empty body with HTTP status 204
*/
app()->delete('/api/v0/entries', [Entries::class, 'delete'])->setName('entries.delete');
app()->delete('/api/v1/entries', [Entries::class, 'delete'])->setName('entries.delete');

View File

@@ -23,7 +23,7 @@ use function app;
/**
* Get registry item
*
* endpoint: GET /api/v0/registry
* endpoint: GET /api/v1/registry
*
* Query:
* id - [REQUIRED] - Unique identifier of the registry item.
@@ -33,4 +33,4 @@ use function app;
* Returns:
* Registry object.
*/
app()->get('/api/v0/registry', [Registry::class, 'get'])->setName('registry.get');
app()->get('/api/v1/registry', [Registry::class, 'get'])->setName('registry.get');

View File

@@ -23,7 +23,7 @@ use function app;
/**
* Generate token
*
* endpoint: POST /api/v0/tokens/generate
* endpoint: POST /api/v1/tokens/generate
*
* Body:
* token - [REQUIRED] - Valid public token.
@@ -32,12 +32,12 @@ use function app;
* Returns:
* Generated token object.
*/
app()->post('/api/v0/tokens/generate', [Tokens::class, 'generate'])->setName('tokens.generate');
app()->post('/api/v1/tokens/generate', [Tokens::class, 'generate'])->setName('tokens.generate');
/**
* Generate token hash
*
* endpoint: POST /api/v0/tokens/generate-hash
* endpoint: POST /api/v1/tokens/generate-hash
*
* Body:
* token - [REQUIRED] - Valid public token.
@@ -47,12 +47,12 @@ app()->post('/api/v0/tokens/generate', [Tokens::class, 'generate'])->setName('to
* Returns:
* Generated token hash object.
*/
app()->post('/api/v0/tokens/generate-hash', [Tokens::class, 'generateHash'])->setName('tokens.generate-hash');
app()->post('/api/v1/tokens/generate-hash', [Tokens::class, 'generateHash'])->setName('tokens.generate-hash');
/**
* Verify token hash
*
* endpoint: POST /api/v0/tokens/verify-hash
* endpoint: POST /api/v1/tokens/verify-hash
*
* Body:
* token - [REQUIRED] - Valid public token.
@@ -63,12 +63,12 @@ app()->post('/api/v0/tokens/generate-hash', [Tokens::class, 'generateHash'])->se
* Returns:
* Token verification object.
*/
app()->post('/api/v0/tokens/verify-hash', [Tokens::class, 'verifyHash'])->setName('tokens.verify-hash');
app()->post('/api/v1/tokens/verify-hash', [Tokens::class, 'verifyHash'])->setName('tokens.verify-hash');
/**
* Create token entry
*
* endpoint: POST /api/v0/tokens
* endpoint: POST /api/v1/tokens
*
* Body:
* token - [REQUIRED] - Valid public token.
@@ -78,12 +78,12 @@ app()->post('/api/v0/tokens/verify-hash', [Tokens::class, 'verifyHash'])->setNam
* Returns:
* Token entry object with the token entry that was just created.
*/
app()->post('/api/v0/tokens', [Tokens::class, 'create'])->setName('tokens.create');
app()->post('/api/v1/tokens', [Tokens::class, 'create'])->setName('tokens.create');
/**
* Update token entry
*
* endpoint: PATCH /api/v0/tokens
* endpoint: PATCH /api/v1/tokens
*
* Body:
* id - [REQUIRED] - Unique identifier of the token entry.
@@ -94,12 +94,12 @@ app()->post('/api/v0/tokens', [Tokens::class, 'create'])->setName('tokens.create
* Returns:
* Toeken entry object for the entry that was just updated.
*/
app()->patch('/api/v0/tokens', [Tokens::class, 'update'])->setName('tokens.update');
app()->patch('/api/v1/tokens', [Tokens::class, 'update'])->setName('tokens.update');
/**
* Delete token entry
*
* endpoint: DELETE /api/v0/tokens
* endpoint: DELETE /api/v1/tokens
*
* Body:
* id - [REQUIRED] - Unique identifier of the token entry.
@@ -109,12 +109,12 @@ app()->patch('/api/v0/tokens', [Tokens::class, 'update'])->setName('tokens.updat
* Returns:
* Empty body with HTTP status 204
*/
app()->delete('/api/v0/tokens', [Tokens::class, 'delete'])->setName('tokens.delete');
app()->delete('/api/v1/tokens', [Tokens::class, 'delete'])->setName('tokens.delete');
/**
* Fetch token entry
*
* endpoint: GET /api/v0/tokens
* endpoint: GET /api/v1/tokens
*
* Query:
* id - [REQUIRED] - Unique identifier of the token entry.
@@ -124,4 +124,4 @@ app()->delete('/api/v0/tokens', [Tokens::class, 'delete'])->setName('tokens.dele
* Returns:
* Entry object.
*/
app()->get('/api/v0/tokens', [Tokens::class, 'fetch'])->setName('tokens.fetch');
app()->get('/api/v1/tokens', [Tokens::class, 'fetch'])->setName('tokens.fetch');