Merge pull request from acelaya-forks/feature/openapi-names

Use the openapi terminology over swagger
This commit is contained in:
Alejandro Celaya 2024-12-06 11:40:15 +01:00 committed by GitHub
commit 5d12b1d952
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 21 additions and 40 deletions

View File

@ -28,7 +28,7 @@ jobs:
strategy: strategy:
matrix: matrix:
php-version: ['8.3'] php-version: ['8.3']
command: ['cs', 'stan', 'swagger:validate'] command: ['cs', 'stan', 'openapi:validate']
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v4
- uses: './.github/actions/ci-setup' - uses: './.github/actions/ci-setup'

View File

@ -1,4 +1,4 @@
name: Publish swagger spec name: Publish openapi spec
on: on:
push: push:
@ -20,10 +20,10 @@ jobs:
- uses: './.github/actions/ci-setup' - uses: './.github/actions/ci-setup'
with: with:
php-version: ${{ matrix.php-version }} php-version: ${{ matrix.php-version }}
extensions-cache-key: publish-swagger-spec-extensions-${{ matrix.php-version }} extensions-cache-key: publish-openapi-spec-extensions-${{ matrix.php-version }}
- run: composer swagger:inline - run: composer openapi:inline
- run: mkdir ${{ steps.determine_version.outputs.version }} - run: mkdir ${{ steps.determine_version.outputs.version }}
- run: mv docs/swagger/swagger-inlined.json ${{ steps.determine_version.outputs.version }}/open-api-spec.json - run: mv docs/swagger/openapi-inlined.json ${{ steps.determine_version.outputs.version }}/open-api-spec.json
- name: Publish spec - name: Publish spec
uses: JamesIves/github-pages-deploy-action@v4 uses: JamesIves/github-pages-deploy-action@v4
with: with:

3
.gitignore vendored
View File

@ -10,7 +10,6 @@ data/database.sqlite
data/shlink-tests.db data/shlink-tests.db
data/GeoLite2-City.* data/GeoLite2-City.*
data/infra/matomo data/infra/matomo
docs/swagger-ui*
docs/mercure.html docs/mercure.html
.phpunit.result.cache .phpunit.result.cache
docs/swagger/swagger-inlined.json docs/swagger/openapi-inlined.json

View File

@ -61,7 +61,7 @@
"symfony/string": "^7.1" "symfony/string": "^7.1"
}, },
"require-dev": { "require-dev": {
"devizzent/cebe-php-openapi": "^1.0.1", "devizzent/cebe-php-openapi": "^1.1.1",
"devster/ubench": "^2.1", "devster/ubench": "^2.1",
"phpstan/phpstan": "^2.0", "phpstan/phpstan": "^2.0",
"phpstan/phpstan-doctrine": "^2.0", "phpstan/phpstan-doctrine": "^2.0",
@ -108,7 +108,7 @@
}, },
"scripts": { "scripts": {
"ci": [ "ci": [
"@parallel cs stan swagger:validate test:unit:ci test:db:sqlite:ci test:db:postgres test:db:mysql test:db:maria test:db:ms", "@parallel cs stan openapi:validate test:unit:ci test:db:sqlite:ci test:db:postgres test:db:mysql test:db:maria test:db:ms",
"@parallel test:api:ci test:cli:ci" "@parallel test:api:ci test:cli:ci"
], ],
"cs": "phpcs -s", "cs": "phpcs -s",
@ -154,36 +154,18 @@
"@test:cli", "@test:cli",
"phpcov merge build/coverage-cli --html build/coverage-cli/coverage-html && rm build/coverage-cli/*.cov" "phpcov merge build/coverage-cli --html build/coverage-cli/coverage-html && rm build/coverage-cli/*.cov"
], ],
"swagger:validate": "@php -d error_reporting=\"E_ALL & ~E_DEPRECATED & ~E_USER_DEPRECATED\" vendor/bin/php-openapi validate docs/swagger/swagger.json", "openapi:validate": "@php -d error_reporting=\"E_ALL & ~E_DEPRECATED & ~E_USER_DEPRECATED\" vendor/bin/php-openapi validate docs/swagger/swagger.json",
"swagger:inline": "@php -d error_reporting=\"E_ALL & ~E_DEPRECATED & ~E_USER_DEPRECATED\" vendor/bin/php-openapi inline docs/swagger/swagger.json docs/swagger/swagger-inlined.json", "openapi:inline": "@php -d error_reporting=\"E_ALL & ~E_DEPRECATED & ~E_USER_DEPRECATED\" vendor/bin/php-openapi inline docs/swagger/swagger.json docs/swagger/openapi-inlined.json",
"swagger:validate": [
"echo \"This command is deprecated. Use openapi:validate instead\"",
"@openapi:validate"
],
"swagger:inline": [
"echo \"This command is deprecated. Use openapi:inline instead\"",
"@openapi:inline"
],
"clean:dev": "rm -f data/database.sqlite && rm -f config/params/generated_config.php" "clean:dev": "rm -f data/database.sqlite && rm -f config/params/generated_config.php"
}, },
"scripts-descriptions": {
"ci": "<fg=blue;options=bold>Alias for \"cs\", \"stan\", \"swagger:validate\" and \"test:ci\"</>",
"cs": "<fg=blue;options=bold>Checks coding styles</>",
"cs:fix": "<fg=blue;options=bold>Fixes coding styles, when possible</>",
"stan": "<fg=blue;options=bold>Inspects code with phpstan</>",
"test": "<fg=blue;options=bold>Runs all test suites</>",
"test:unit": "<fg=blue;options=bold>Runs unit test suites</>",
"test:unit:ci": "<fg=blue;options=bold>Runs unit test suites, generating all needed reports and logs for CI envs</>",
"test:unit:pretty": "<fg=blue;options=bold>Runs unit test suites and generates an HTML code coverage report</>",
"test:db": "<fg=blue;options=bold>Runs database test suites on a SQLite, MySQL, MariaDB, PostgreSQL and MsSQL</>",
"test:db:sqlite": "<fg=blue;options=bold>Runs database test suites on a SQLite database</>",
"test:db:sqlite:ci": "<fg=blue;options=bold>Runs database test suites on a SQLite database, generating all needed reports and logs for CI envs</>",
"test:db:mysql": "<fg=blue;options=bold>Runs database test suites on a MySQL database</>",
"test:db:maria": "<fg=blue;options=bold>Runs database test suites on a MariaDB database</>",
"test:db:postgres": "<fg=blue;options=bold>Runs database test suites on a PostgreSQL database</>",
"test:db:ms": "<fg=blue;options=bold>Runs database test suites on a Microsoft SQL Server database</>",
"test:api": "<fg=blue;options=bold>Runs API test suites</>",
"test:api:ci": "<fg=blue;options=bold>Runs API test suites, and generates code coverage for CI</>",
"test:api:pretty": "<fg=blue;options=bold>Runs API test suites, and generates code coverage in HTML format</>",
"test:cli": "<fg=blue;options=bold>Runs CLI test suites</>",
"test:cli:ci": "<fg=blue;options=bold>Runs CLI test suites, and generates code coverage for CI</>",
"test:cli:pretty": "<fg=blue;options=bold>Runs CLI test suites, and generates code coverage in HTML format</>",
"swagger:validate": "<fg=blue;options=bold>Validates the swagger docs, making sure they fulfil the spec</>",
"swagger:inline": "<fg=blue;options=bold>Inlines swagger docs in a single file</>",
"clean:dev": "<fg=blue;options=bold>Deletes artifacts which are gitignored and could affect dev env</>"
},
"config": { "config": {
"sort-packages": true, "sort-packages": true,
"platform-check": false, "platform-check": false,

View File

@ -64,12 +64,12 @@ class GeolocationDbUpdater implements GeolocationDbUpdaterInterface
private function downloadIfNeeded(callable|null $beforeDownload, callable|null $handleProgress): GeolocationResult private function downloadIfNeeded(callable|null $beforeDownload, callable|null $handleProgress): GeolocationResult
{ {
if (! $this->dbUpdater->databaseFileExists()) { if (! $this->dbUpdater->databaseFileExists()) {
return $this->downloadNewDb(false, $beforeDownload, $handleProgress); return $this->downloadNewDb($beforeDownload, $handleProgress, olderDbExists: false);
} }
$meta = ($this->geoLiteDbReaderFactory)()->metadata(); $meta = ($this->geoLiteDbReaderFactory)()->metadata();
if ($this->buildIsTooOld($meta)) { if ($this->buildIsTooOld($meta)) {
return $this->downloadNewDb(true, $beforeDownload, $handleProgress); return $this->downloadNewDb($beforeDownload, $handleProgress, olderDbExists: true);
} }
return GeolocationResult::DB_IS_UP_TO_DATE; return GeolocationResult::DB_IS_UP_TO_DATE;
@ -106,9 +106,9 @@ class GeolocationDbUpdater implements GeolocationDbUpdaterInterface
* @throws GeolocationDbUpdateFailedException * @throws GeolocationDbUpdateFailedException
*/ */
private function downloadNewDb( private function downloadNewDb(
bool $olderDbExists,
callable|null $beforeDownload, callable|null $beforeDownload,
callable|null $handleProgress, callable|null $handleProgress,
bool $olderDbExists,
): GeolocationResult { ): GeolocationResult {
if ($beforeDownload !== null) { if ($beforeDownload !== null) {
$beforeDownload($olderDbExists); $beforeDownload($olderDbExists);