mirrors/shlink
1
0
Fork 0
mirror of https://github.com/shlinkio/shlink.git synced 2025-03-14 04:00:57 +03:00
Code Issues Projects Releases Packages Wiki Activity

Updated API docs to reference the use of application/problem+json

Browse source
This commit is contained in:
Alejandro Celaya 2019-11-28 19:37:22 +01:00
parent 5055ddf995
commit 60d3c09da5
13 changed files with 94 additions and 93 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
docs/swagger/definitions/Error.json
View file

@ -1,13 +1,32 @@
{
"type": "object",
"required": ["type", "title", "detail", "status"],
"properties": {
"code": {
"type": {
"type": "string",
"description": "A machine unique code"
},
"title": {
"type": "string",
"description": "A unique title"
},
"detail": {
"type": "string",
"description": "A human-friendly error description"
},
"status": {
"type": "number",
"description": "HTTP response status code"
},
"code": {
"type": "string",
"description": "**[Deprecated] Use type instead. Not returned for v2 of the REST API** A machine unique code",
"deprecated": true
},
"message": {
"type": "string",
"description": "A human-friendly error message"
"description": "**[Deprecated] Use detail instead. Not returned for v2 of the REST API** A human-friendly error message",
"deprecated": true
}
}
}

6
docs/swagger/definitions/InvalidShortUrlMeta.json Normal file
View file

@ -0,0 +1,6 @@
{
"type": "object",
"properties": {
}
}

31
docs/swagger/paths/v1_short-urls.json
View file

@ -150,7 +150,7 @@
"500": {
"description": "Unexpected error.",
"content": {
"application/json": {
"application/problem+json": {
"schema": {
"$ref": "../definitions/Error.json"
}
@ -256,11 +256,32 @@
}
},
"400": {
"description": "The long URL was not provided or is invalid.",
"description": "Some of provided data is invalid. Check extra fields to know exactly what.",
"content": {
"application/json": {
"application/problem+json": {
"schema": {
"$ref": "../definitions/Error.json"
"type": "object",
"allOf": [
{
"$ref": "./Error.json"
},
{
"type": "object",
"properties": {
"invalidElements": {
"$ref": "./InvalidShortUrlMeta.json"
},
"url": {
"type": "string",
"description": "A URL that could not be verified, if the error type is INVALID_URL"
},
"customSlug": {
"type": "string",
"description": "Provided custom slug when the error type is INVALID_SLUG"
}
}
}
]
}
}
}
@ -268,7 +289,7 @@
"500": {
"description": "Unexpected error.",
"content": {
"application/json": {
"application/problem+json": {
"schema": {
"$ref": "../definitions/Error.json"
}

15
docs/swagger/paths/v1_short-urls_shorten.json
View file

@ -77,7 +77,7 @@
"400": {
"description": "The long URL was not provided or is invalid.",
"content": {
"application/json": {
"application/problem+json": {
"schema": {
"$ref": "../definitions/Error.json"
}
@ -89,9 +89,12 @@
}
},
"examples": {
"application/json": {
"error": "INVALID_URL",
"message": "Provided URL foo is invalid. Try with a different one."
"application/problem+json": {
"title": "Invalid URL",
"type": "INVALID_URL",
"detail": "Provided URL foo is invalid. Try with a different one.",
"status": 400,
"url": "https://invalid-url.com"
},
"text/plain": "INVALID_URL"
}
@ -99,7 +102,7 @@
"500": {
"description": "Unexpected error.",
"content": {
"application/json": {
"application/problem+json": {
"schema": {
"$ref": "../definitions/Error.json"
}
@ -111,7 +114,7 @@
}
},
"examples": {
"application/json": {
"application/problem+json": {
"error": "INTERNAL_SERVER_ERROR",
"message": "Unexpected error occurred"
},

42
docs/swagger/paths/v1_short-urls_{shortCode}.json
View file

@ -62,20 +62,10 @@
}
}
},
"400": {
"description": "Provided shortCode does not match the character set currently used by the app to generate short codes.",
"content": {
"application/json": {
"schema": {
"$ref": "../definitions/Error.json"
}
}
}
},
"404": {
"description": "No URL was found for provided short code.",
"content": {
"application/json": {
"application/problem+json": {
"schema": {
"$ref": "../definitions/Error.json"
}
@ -85,7 +75,7 @@
"500": {
"description": "Unexpected error.",
"content": {
"application/json": {
"application/problem+json": {
"schema": {
"$ref": "../definitions/Error.json"
}
@ -153,7 +143,7 @@
"400": {
"description": "Provided meta arguments are invalid.",
"content": {
"application/json": {
"application/problem+json": {
"schema": {
"$ref": "../definitions/Error.json"
}
@ -163,7 +153,7 @@
"404": {
"description": "No short URL was found for provided short code.",
"content": {
"application/json": {
"application/problem+json": {
"schema": {
"$ref": "../definitions/Error.json"
}
@ -173,7 +163,7 @@
"500": {
"description": "Unexpected error.",
"content": {
"application/json": {
"application/problem+json": {
"schema": {
"$ref": "../definitions/Error.json"
}
@ -242,7 +232,7 @@
"400": {
"description": "Provided meta arguments are invalid.",
"content": {
"application/json": {
"application/problem+json": {
"schema": {
"$ref": "../definitions/Error.json"
}
@ -252,7 +242,7 @@
"404": {
"description": "No short URL was found for provided short code.",
"content": {
"application/json": {
"application/problem+json": {
"schema": {
"$ref": "../definitions/Error.json"
}
@ -262,7 +252,7 @@
"500": {
"description": "Unexpected error.",
"content": {
"application/json": {
"application/problem+json": {
"schema": {
"$ref": "../definitions/Error.json"
}
@ -302,26 +292,28 @@
"204": {
"description": "The short URL has been properly deleted."
},
"400": {
"422": {
"description": "The visits threshold in shlink does not allow this short URL to be deleted.",
"content": {
"application/json": {
"application/problem+json": {
"schema": {
"$ref": "../definitions/Error.json"
}
}
},
"examples": {
"application/json": {
"error": "INVALID_SHORTCODE_DELETION",
"message": "It is not possible to delete URL with short code \"abc123\" because it has reached more than \"15\" visits."
"application/problem+json": {
"title": "Cannot delete short URL",
"type": "INVALID_SHORTCODE_DELETION",
"detail": "It is not possible to delete URL with short code \"abc123\" because it has reached more than \"15\" visits.",
"status": 422
}
}
},
"404": {
"description": "No short URL was found for provided short code.",
"content": {
"application/json": {
"application/problem+json": {
"schema": {
"$ref": "../definitions/Error.json"
}
@ -331,7 +323,7 @@
"500": {
"description": "Unexpected error.",
"content": {
"application/json": {
"application/problem+json": {
"schema": {
"$ref": "../definitions/Error.json"
}

2
docs/swagger/paths/v1_short-urls_{shortCode}_tags.json
View file

@ -78,7 +78,7 @@
"400": {
"description": "The request body does not contain a \"tags\" param with array type.",
"content": {
"application/json": {
"application/problem+json": {
"schema": {
"$ref": "../definitions/Error.json"
}

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

@ -132,7 +132,7 @@
"404": {
"description": "The short code does not belong to any short URL.",
"content": {
"application/json": {
"application/problem+json": {
"schema": {
"$ref": "../definitions/Error.json"
}
@ -142,7 +142,7 @@
"500": {
"description": "Unexpected error.",
"content": {
"application/json": {
"application/problem+json": {
"schema": {
"$ref": "../definitions/Error.json"
}

12
docs/swagger/paths/v1_tags.json
View file

@ -53,7 +53,7 @@
"500": {
"description": "Unexpected error.",
"content": {
"application/json": {
"application/problem+json": {
"schema": {
"$ref": "../definitions/Error.json"
}
@ -140,7 +140,7 @@
"500": {
"description": "Unexpected error.",
"content": {
"application/json": {
"application/problem+json": {
"schema": {
"$ref": "../definitions/Error.json"
}
@ -197,7 +197,7 @@
"400": {
"description": "You have not provided either the oldName or the newName params.",
"content": {
"application/json": {
"application/problem+json": {
"schema": {
"$ref": "../definitions/Error.json"
}
@ -207,7 +207,7 @@
"404": {
"description": "There's no tag found with the name provided in oldName param.",
"content": {
"application/json": {
"application/problem+json": {
"schema": {
"$ref": "../definitions/Error.json"
}
@ -217,7 +217,7 @@
"500": {
"description": "Unexpected error.",
"content": {
"application/json": {
"application/problem+json": {
"schema": {
"$ref": "../definitions/Error.json"
}
@ -263,7 +263,7 @@
"500": {
"description": "Unexpected error.",
"content": {
"application/json": {
"application/problem+json": {
"schema": {
"$ref": "../definitions/Error.json"
}

10
docs/swagger/paths/{shortCode}.json
View file

@ -20,16 +20,6 @@
"responses": {
"302": {
"description": "Visit properly tracked and redirected"
},
"500": {
"description": "Unexpected error.",
"content": {
"application/json": {
"schema": {
"$ref": "../definitions/Error.json"
}
}
}
}
}
}

10
docs/swagger/paths/{shortCode}_preview.json
View file

@ -29,16 +29,6 @@
}
}
}
},
"500": {
"description": "Unexpected error.",
"content": {
"application/json": {
"schema": {
"$ref": "../definitions/Error.json"
}
}
}
}
}
}

10
docs/swagger/paths/{shortCode}_qr-code.json
View file

@ -40,16 +40,6 @@
}
}
}
},
"500": {
"description": "Unexpected error.",
"content": {
"application/json": {
"schema": {
"$ref": "../definitions/Error.json"
}
}
}
}
}
}

10
docs/swagger/paths/{shortCode}_track.json
View file

@ -28,16 +28,6 @@
}
}
}
},
"500": {
"description": "Unexpected error.",
"content": {
"application/json": {
"schema": {
"$ref": "../definitions/Error.json"
}
}
}
}
}
}

12
docs/swagger/swagger.json
View file

@ -71,24 +71,24 @@
],
"paths": {
"/rest/v1/short-urls": {
"/rest/v2/short-urls": {
"$ref": "paths/v1_short-urls.json"
},
"/rest/v1/short-urls/shorten": {
"/rest/v2/short-urls/shorten": {
"$ref": "paths/v1_short-urls_shorten.json"
},
"/rest/v1/short-urls/{shortCode}": {
"/rest/v2/short-urls/{shortCode}": {
"$ref": "paths/v1_short-urls_{shortCode}.json"
},
"/rest/v1/short-urls/{shortCode}/tags": {
"/rest/v2/short-urls/{shortCode}/tags": {
"$ref": "paths/v1_short-urls_{shortCode}_tags.json"
},
"/rest/v1/tags": {
"/rest/v2/tags": {
"$ref": "paths/v1_tags.json"
},
"/rest/v1/short-urls/{shortCode}/visits": {
"/rest/v2/short-urls/{shortCode}/visits": {
"$ref": "paths/v1_short-urls_{shortCode}_visits.json"
},