Mirrors/shlink
1
0
Fork 0
mirror of https://github.com/shlinkio/shlink.git synced 2026-03-11 01:33:11 +08:00
Code Issues Packages Projects Releases Wiki Activity

Documented new meta param on swagger docs

Browse Source
This commit is contained in:
Alejandro Celaya
2019-07-08 18:42:53 +02:00
parent 46a27a9d0a
commit c7cfdffaf6
5 changed files with 60 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
docs/swagger/definitions/ShortUrl.json
View File

@@ -29,6 +29,9 @@
},
"description": "A list of tags applied to this short URL"
},
"meta": {
"$ref": "./ShortUrlMeta.json"
},
"originalUrl": {
"deprecated": true,
"type": "string",

21
docs/swagger/definitions/ShortUrlMeta.json Normal file
View File

@@ -0,0 +1,21 @@
{
"type": "object",
"required": ["validSince", "validUntil", "maxVisits"],
"properties": {
"validSince": {
"description": "The date (in ISO-8601 format) from which this short code will be valid",
"type": "string",
"nullable": true
},
"validUntil": {
"description": "The date (in ISO-8601 format) until which this short code will be valid",
"type": "string",
"nullable": true
},
"maxVisits": {
"description": "The maximum number of allowed visits for this short code",
"type": "number",
"nullable": true
}
}
}

28
docs/swagger/paths/v1_short-urls.json
View File

@@ -100,7 +100,12 @@
"tags": [
"games",
"tech"
]
],
"meta": {
"validSince": "2017-01-21T00:00:00+02:00",
"validUntil": null,
"maxVisits": 100
}
},
{
"shortCode": "12Kb3",
@@ -110,7 +115,12 @@
"visitsCount": 1029,
"tags": [
"shlink"
]
],
"meta": {
"validSince": null,
"validUntil": null,
"maxVisits": null
}
},
{
"shortCode": "123bA",
@@ -118,7 +128,12 @@
"longUrl": "https://www.google.com",
"dateCreated": "2015-10-01T20:34:16+02:00",
"visitsCount": 25,
"tags": []
"tags": [],
"meta": {
"validSince": "2017-01-21T00:00:00+02:00",
"validUntil": null,
"maxVisits": null
}
}
],
"pagination": {
@@ -227,7 +242,12 @@
"tags": [
"games",
"tech"
]
],
"meta": {
"validSince": "2017-01-21T00:00:00+02:00",
"validUntil": null,
"maxVisits": 500
}
}
}
},

7
docs/swagger/paths/v1_short-urls_shorten.json
View File

@@ -64,7 +64,12 @@
"tags": [
"games",
"tech"
]
],
"meta": {
"validSince": "2017-01-21T00:00:00+02:00",
"validUntil": null,
"maxVisits": 100
}
},
"text/plain": "https://doma.in/abc123"
}

7
docs/swagger/paths/v1_short-urls_{shortCode}.json
View File

@@ -44,7 +44,12 @@
"visitsCount": 1029,
"tags": [
"shlink"
]
],
"meta": {
"validSince": "2017-01-21T00:00:00+02:00",
"validUntil": null,
"maxVisits": 100
}
}
}
},