mirrors/shlink
1
0
Fork 0
mirror of https://github.com/shlinkio/shlink.git synced 2025-02-17 07:49:54 +03:00
Code Issues Projects Releases Packages Wiki Activity

Tagged and summarized all endpoints in swagger docs

Browse source
This commit is contained in:
Alejandro Celaya 2016-10-23 00:07:31 +02:00
parent b225c03ef1
commit 8af9b0ee02
5 changed files with 26 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/swagger/paths/v1_authenticate.json
View file

@ -1,5 +1,9 @@
{
"post": {
"tags": [
"Authentication"
],
"summary": "Perform authentication",
"description": "Performs an authentication",
"parameters": [
{

8
docs/swagger/paths/v1_short-codes.json
View file

@ -1,5 +1,9 @@
{
"get": {
"tags": [
"ShortCodes"
],
"summary": "List short URLs",
"description": "Returns the list of short codes",
"parameters": [
{
@ -77,6 +81,10 @@
}
},
"post": {
"tags": [
"ShortCodes"
],
"summary": "Create short URL",
"description": "Creates a new short code",
"parameters": [
{

4
docs/swagger/paths/v1_short-codes_{shortCode}.json
View file

@ -1,5 +1,9 @@
{
"get": {
"tags": [
"ShortCodes"
],
"summary": "Parse short code",
"description": "Get the long URL behind a short code.",
"parameters": [
{

5
docs/swagger/paths/v1_short-codes_{shortCode}_tags.json
View file

@ -1,5 +1,10 @@
{
"put": {
"tags": [
"ShortCodes",
"Tags"
],
"summary": "Edit tags on short URL",
"description": "Edit the tags on provided short code.",
"parameters": [
{

5
docs/swagger/paths/v1_short-codes_{shortCode}_visits.json
View file

@ -1,5 +1,10 @@
{
"get": {
"tags": [
"ShortCodes",
"Visits"
],
"summary": "List visits for short URL",
"description": "Get the list of visits on provided short code.",
"parameters": [
{