mirrors/shlink
1
0
Fork 0
mirror of https://github.com/shlinkio/shlink.git synced 2024-11-23 13:23:33 +03:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #1836 from acelaya-forks/feature/oas-3.1

Browse source 
Feature/oas 3.1
This commit is contained in:
Alejandro Celaya 2023-07-12 19:42:42 +02:00 committed by GitHub
commit 3ea83f5cc3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
10 changed files with 23 additions and 38 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
CHANGELOG.md
View file

@ -18,6 +18,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com), and this
For example, if you did not enable RabbitMQ real-time updates, instead of triggering a job that ends immediately, the job will not even be enqueued.
* [#1835](https://github.com/shlinkio/shlink/issues/1835) Docker image is now built only when a release is tagged, and new tags are included, for minor and major versions.
* [#1055](https://github.com/shlinkio/shlink/issues/1055) Update OAS definition to v3.1.
### Deprecated
* [#1783](https://github.com/shlinkio/shlink/issues/1783) Deprecated support for openswoole. RoadRunner is the best replacement, with the same capabilities, but much easier and convenient to install and manage.

2
composer.json
View file

@ -63,7 +63,7 @@
"symfony/string": "^6.2"
},
"require-dev": {
"cebe/php-openapi": "^1.7",
"devizzent/cebe-php-openapi": "^1.0.1",
"devster/ubench": "^2.1",
"infection/infection": "^0.27",
"openswoole/ide-helper": "~22.0.0",

9
docs/swagger/definitions/DeviceLongUrls.json
View file

@ -3,18 +3,15 @@
"properties": {
"android": {
"description": "The long URL to redirect to when the short URL is visited from a device running Android",
"type": "string",
"nullable": false
"type": ["string"]
},
"ios": {
"description": "The long URL to redirect to when the short URL is visited from a device running iOS",
"type": "string",
"nullable": false
"type": ["string"]
},
"desktop": {
"description": "The long URL to redirect to when the short URL is visited from a desktop browser",
"type": "string",
"nullable": false
"type": ["string"]
}
}
}

6
docs/swagger/definitions/DeviceLongUrlsEdit.json
View file

@ -5,13 +5,13 @@
}],
"properties": {
"android": {
"nullable": true
"type": ["null"]
},
"ios": {
"nullable": true
"type": ["null"]
},
"desktop": {
"nullable": true
"type": ["null"]
}
}
}

9
docs/swagger/definitions/NotFoundRedirects.json
View file

@ -2,18 +2,15 @@
"type": "object",
"properties": {
"baseUrlRedirect": {
"type": "string",
"nullable": true,
"type": ["string", "null"],
"description": "URL to redirect to when a user hits the domain's base URL"
},
"regular404Redirect": {
"type": "string",
"nullable": true,
"type": ["string", "null"],
"description": "URL to redirect to when a user hits a not found URL other than an invalid short URL"
},
"invalidShortUrlRedirect": {
"type": "string",
"nullable": true,
"type": ["string", "null"],
"description": "URL to redirect to when a user hits an invalid short URL"
}
}

3
docs/swagger/definitions/OrphanVisit.json
View file

@ -6,8 +6,7 @@
}],
"properties": {
"visitedUrl": {
"type": "string",
"nullable": true,
"type": ["string", "null"],
"description": "The originally visited URL that triggered the tracking of this visit"
},
"type": {

6
docs/swagger/definitions/ShortUrl.json
View file

@ -55,13 +55,11 @@
"$ref": "./ShortUrlMeta.json"
},
"domain": {
"type": "string",
"nullable": true,
"type": ["string", "null"],
"description": "The domain in which the short URL was created. Null if it belongs to default domain."
},
"title": {
"type": "string",
"nullable": true,
"type": ["string", "null"],
"description": "A descriptive title of the short URL."
},
"crawlable": {

14
docs/swagger/definitions/ShortUrlEdition.json
View file

@ -10,18 +10,15 @@
},
"validSince": {
"description": "The date (in ISO-8601 format) from which this short code will be valid",
"type": "string",
"nullable": true
"type": ["string", "null"]
},
"validUntil": {
"description": "The date (in ISO-8601 format) until which this short code will be valid",
"type": "string",
"nullable": true
"type": ["string", "null"]
},
"maxVisits": {
"description": "The maximum number of allowed visits for this short code",
"type": "number",
"nullable": true
"type": ["number", "null"]
},
"validateUrl": {
"deprecated": true,
@ -36,9 +33,8 @@
"description": "The list of tags to set to the short URL."
},
"title": {
"type": "string",
"description": "A descriptive title of the short URL.",
"nullable": true
"type": ["string", "null"],
"description": "A descriptive title of the short URL."
},
"crawlable": {
"type": "boolean",

9
docs/swagger/definitions/ShortUrlMeta.json
View file

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

2
docs/swagger/swagger.json
View file

@ -1,5 +1,5 @@
{
"openapi": "3.0.3",
"openapi": "3.1.0",
"info": {
"title": "Shlink",
"description": "Shlink, the self-hosted URL shortener",