Skip to content

Commit 701bfff

Browse files
committed
chore: Updated files for linter
1 parent 2cacb65 commit 701bfff

File tree

4 files changed

+39
-40
lines changed

4 files changed

+39
-40
lines changed

test/projects/apihub/APIHUB API.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1506,7 +1506,7 @@ paths:
15061506
- Export
15071507
summary: Export offline API documentation by selected file
15081508
description: |
1509-
Export of offline API documentation by selected file as a zip archive.
1509+
Export of offline API documentation by selected file as a zip archive.
15101510
Type of the documentation file is provided as input parameters:
15111511
- STATIC/INTERACTIVE - html document.
15121512
- PDF - pdf document.
@@ -1571,7 +1571,7 @@ paths:
15711571
- Export
15721572
summary: Export offline API documentation by whole version
15731573
description: |
1574-
Export of offline API documentation as a zip archive.
1574+
Export of offline API documentation as a zip archive.
15751575
Type of the documentation file is provided as input parameters:
15761576
- STATIC/INTERACTIVE - html document.
15771577
- PDF - pdf document.

test/projects/apihub/Public Registry API.yaml

Lines changed: 34 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -2019,7 +2019,7 @@ paths:
20192019
* new_version - publish_new_version.
20202020
* package_version - patch_version_meta, delete_version, publish_new_revision.
20212021
* package_management - create_package, delete_package, patch_package_meta.
2022-
* operations_group - create_manual_group, delete_manual_group,
2022+
* operations_group - create_manual_group, delete_manual_group,
20232023
update_operations_group_parameters
20242024
in: query
20252025
schema:
@@ -3534,7 +3534,7 @@ paths:
35343534
- name: checkRevisions
35353535
in: query
35363536
description: |
3537-
Flag, if to search in the previous versions revisions.
3537+
Flag, if to search in the previous versions revisions.
35383538
* if several revisions were found, return only the maximum found value.
35393539
* if false - return the last published revision.
35403540
schema:
@@ -3705,7 +3705,7 @@ paths:
37053705
- name: checkRevisions
37063706
in: query
37073707
description: |
3708-
Flag, if to search in the previous versions revisions.
3708+
Flag, if to search in the previous versions revisions.
37093709
* if several revisions were found, return only the maximum found value.
37103710
* if false - return the last published revision.
37113711
schema:
@@ -3815,7 +3815,7 @@ paths:
38153815
- name: version
38163816
in: path
38173817
description: |
3818-
Package version.
3818+
Package version.
38193819
The mask <version>@<revision> may be used for search in a specific revision.
38203820
required: true
38213821
schema:
@@ -3972,9 +3972,9 @@ paths:
39723972
- Admin
39733973
summary: Update package version
39743974
description: |
3975-
Update package version.
3975+
Update package version.
39763976
* If the parameter is not transmitted in request - its value stays unchanged.
3977-
* The empty parameter value in request sets the empty value in database.
3977+
* The empty parameter value in request sets the empty value in database.
39783978
* The array of labels will be fully replaced as-it-send, no JSON-Patch approach for arrays is applicable.
39793979
operationId: patchPackagesIdVersionsIdV2
39803980
security:
@@ -4140,7 +4140,7 @@ paths:
41404140
- name: version
41414141
in: path
41424142
description: |
4143-
Package version.
4143+
Package version.
41444144
The mask <version>@<revision> may be used for search in a specific revision.
41454145
required: true
41464146
schema:
@@ -4529,7 +4529,7 @@ paths:
45294529
- name: version
45304530
in: path
45314531
description: |
4532-
Package version.
4532+
Package version.
45334533
The mask <version>@<revision> may be used for search in a specific revision.
45344534
required: true
45354535
schema:
@@ -4758,7 +4758,7 @@ paths:
47584758
- name: version
47594759
in: path
47604760
description: |
4761-
Package version.
4761+
Package version.
47624762
The mask <version>@<revision> may be used for search in a specific revision.
47634763
required: true
47644764
schema:
@@ -5493,7 +5493,7 @@ paths:
54935493
example: QS.CQSS.CPQ.TMF
54945494
version:
54955495
description: |
5496-
Package version.
5496+
Package version.
54975497
The mask <version>@<revision> may be used for search in a specific revision.
54985498

54995499
If the @revision is not provided, the latest version's revision will be used.
@@ -5528,7 +5528,7 @@ paths:
55285528
example: QS.CQSS.CPQ.TMF
55295529
version:
55305530
description: |
5531-
Package version.
5531+
Package version.
55325532
The mask <version>@<revision> will be used for return in a specific revision.
55335533

55345534
If the @<revision> was not transmitted in the request - it won't be returned in response. Consider the version as the latest one.
@@ -5665,7 +5665,7 @@ paths:
56655665
example: QS.CQSS.CPQ.TMF
56665666
version:
56675667
description: |
5668-
Package version.
5668+
Package version.
56695669
The mask <version>@<revision> will be used for return in a specific revision.
56705670

56715671
If the @<revision> was not transmitted in the request - it won't be returned in response. Consider the version as the latest one.
@@ -5819,7 +5819,7 @@ paths:
58195819
default: false
58205820
- name: format
58215821
in: query
5822-
description: |
5822+
description: |
58235823
Format of the exported file.\
58245824
If buidType = reducedSourceSpecifications, then format can be yaml, json or html.\
58255825
If buidType = mergedspecification, then format can be yaml or json; html is not supported for this buildType.
@@ -5847,7 +5847,7 @@ paths:
58475847
example: QS.CQSS.CPQ.TMF
58485848
version:
58495849
description: |
5850-
Package version.
5850+
Package version.
58515851
The mask <version>@<revision> will be used for return in a specific revision.
58525852
If the @<revision> was not transmitted in the request - it won't be returned in response. Consider the version as the latest one.
58535853
type: string
@@ -6077,7 +6077,7 @@ paths:
60776077
- name: format
60786078
in: query
60796079
required: true
6080-
description: |
6080+
description: |
60816081
Format of the exported file.\
60826082
If buidType = reducedSourceSpecifications, then format can be yaml, json or html.\
60836083
If buidType = mergedspecification, then format can be yaml or json; html is not supported for this buildType.
@@ -6228,7 +6228,7 @@ paths:
62286228
- Export
62296229
summary: Export offline API documentation by selected file
62306230
description: |
6231-
Export of offline API documentation by selected file as a zip archive.
6231+
Export of offline API documentation by selected file as a zip archive.
62326232
Type of the documentation file is provided as input parameters:
62336233
- interactive - html document
62346234
- raw - yaml/json document.
@@ -6388,7 +6388,7 @@ paths:
63886388
- Export
63896389
summary: Export offline API documentation by selected versions
63906390
description: |
6391-
Export of offline API documentation by selected version (all files) as a zip archive.
6391+
Export of offline API documentation by selected version (all files) as a zip archive.
63926392
Type of the documentation file is provided as input parameters:
63936393
* interactive - html document.
63946394
operationId: getPackagesIdVersionsIdDoc
@@ -6467,7 +6467,7 @@ paths:
64676467
- Roles
64686468
summary: Create a new role
64696469
description: |
6470-
Create a new role with the set of available permissions for this role.
6470+
Create a new role with the set of available permissions for this role.
64716471

64726472
The role may be assigned to the user for the specific package.
64736473

@@ -6579,7 +6579,7 @@ paths:
65796579
- Roles
65806580
summary: Update role
65816581
description: |
6582-
Change role parameters.
6582+
Change role parameters.
65836583

65846584
If the parameter is not transmitted in the request, its value remains unchanged.
65856585

@@ -6644,7 +6644,7 @@ paths:
66446644
- Roles
66456645
summary: Delete role
66466646
description: |
6647-
Delete a role with its permissions.
6647+
Delete a role with its permissions.
66486648

66496649
When the role is deleted, all users with that role shall be removed from packages.
66506650

@@ -6687,7 +6687,7 @@ paths:
66876687
- Roles
66886688
summary: Update the roles order
66896689
description: |
6690-
Update the roles order.
6690+
Update the roles order.
66916691

66926692
The list of roles will be replaced, all existing roles are required in request (return an error otherwise).
66936693
operationId: postRolesChangeOrder
@@ -7613,7 +7613,7 @@ paths:
76137613
example: "Billing account"
76147614
packageIds:
76157615
description: |
7616-
List of Package Id(s).
7616+
List of Package Id(s).
76177617
* If user specified Workspace(s), then Workspace Id(s) must be transmitted.
76187618
* If user specified Workspace(s) and Group(s), then Group Id(s) must be transmitted.
76197619
* If user specified Workspace(s), Group(s) and Package(s) or Workspace(s) and Package(s), then Package Id(s) must be transmitted.
@@ -7816,7 +7816,7 @@ paths:
78167816
example: "Billing account"
78177817
packageIds:
78187818
description: |
7819-
List of Package Id(s).
7819+
List of Package Id(s).
78207820
* If user specified Workspace(s), then Workspace Id(s) must be transmitted.
78217821
* If user specified Workspace(s) and Group(s), then Group Id(s) must be transmitted.
78227822
* If user specified Workspace(s), Group(s) and Package(s) or Workspace(s) and Package(s), then Package Id(s) must be transmitted.
@@ -8024,7 +8024,7 @@ paths:
80248024
title: SearchResultPackage
80258025
description: |
80268026
Global search result for packages with kind = package; must be returned when searchLevel = package
8027-
* If search term matches the package id/name/description/service name, return the latest published version only.
8027+
* If search term matches the package id/name/description/service name, return the latest published version only.
80288028
* If search term matches the version name/label, return that version.
80298029
type: object
80308030
required:
@@ -8434,7 +8434,7 @@ paths:
84348434
summary: Create internal user
84358435
description: |
84368436
Creation of the internal user, not connected to LDAP or GitLab.
8437-
* If the userId already exists, return an error.
8437+
* If the userId already exists, return an error.
84388438
* One email may be connected to several users at one time, no unique constraint.
84398439
* The password will be stored in an encrypted form locally.
84408440
operationId: postUsers
@@ -9222,7 +9222,7 @@ paths:
92229222
- name: version
92239223
in: path
92249224
description: |
9225-
Package version.
9225+
Package version.
92269226
The mask <version>@<revision> may be used for search in a specific revision.
92279227
required: true
92289228
schema:
@@ -9340,7 +9340,7 @@ paths:
93409340
deprecatedInfo:
93419341
description: |
93429342
Additional information about deprecated operation:
9343-
* for REST API it is value of 'x-deprecated-meta' extension (value of extension must be string), which is defined for deprecated operation.
9343+
* for REST API it is value of 'x-deprecated-meta' extension (value of extension must be string), which is defined for deprecated operation.
93449344
* for GraphQL API it is value of 'reason' argument of @deprecated directive, which is defined for deprecated operation.
93459345
type: string
93469346
deprecatedItems:
@@ -10486,7 +10486,7 @@ paths:
1048610486
packageId:
1048710487
description: |
1048810488
ID of package.\
10489-
PackageId and version shall be specified in case of dashboard to identify source package.
10489+
PackageId and version shall be specified in case of dashboard to identify source package.
1049010490
If packageId and version are not specified, this will mean that the source of the operation is the current package version.
1049110491
type: string
1049210492
example: "QS.CloudQSS.CPQ.Q-TMF"
@@ -10748,7 +10748,7 @@ paths:
1074810748
packageId:
1074910749
description: |
1075010750
ID of package.\
10751-
PackageId and version shall be specified in case of dashboard to identify source package.
10751+
PackageId and version shall be specified in case of dashboard to identify source package.
1075210752
If packageId and version are not specified, this will mean that the source of the operation is the current package version.
1075310753
type: string
1075410754
example: "QS.CloudQSS.CPQ.Q-TMF"
@@ -10876,7 +10876,7 @@ paths:
1087610876
packageId:
1087710877
description: |
1087810878
ID of package.\
10879-
PackageId and version shall be specified in case of dashboard to identify source package.
10879+
PackageId and version shall be specified in case of dashboard to identify source package.
1088010880
If packageId and version are not specified, this will mean that the source of the operation is the current package version.
1088110881
type: string
1088210882
example: "QS.CloudQSS.CPQ.Q-TMF"
@@ -11138,7 +11138,7 @@ paths:
1113811138
description: |
1113911139
Get list of documents in a version. The result depend on the package.kind:
1114011140
* For package.kind: package - return the list of version documents.
11141-
* For package.kind: dashboard - return the list of all referenced dashboards and their referenced packages in recursion.
11141+
* For package.kind: dashboard - return the list of all referenced dashboards and their referenced packages in recursion.
1114211142
The returned list will contain only leaves - referenced packages of the lowest level with their published documents.
1114311143
operationId: getPackagesIdVersionsIdDocuments
1114411144
security:
@@ -13227,7 +13227,7 @@ components:
1322713227
deprecatedInfo:
1322813228
description: |
1322913229
Additional information about single deprecated item:
13230-
* for REST API it is value of 'x-deprecated-meta' extension (value of extension must be string), which is defined for deprecated item.
13230+
* for REST API it is value of 'x-deprecated-meta' extension (value of extension must be string), which is defined for deprecated item.
1323113231
* for GraphQL API it is value of 'reason' argument of @deprecated directive.
1323213232
type: string
1323313233
tolerantHash:
@@ -13369,7 +13369,7 @@ components:
1336913369
type: boolean
1337013370
restGroupingPrefix:
1337113371
description: |
13372-
Regular expression used as criteria for grouping operations.
13372+
Regular expression used as criteria for grouping operations.
1337313373
Groups for the package version are calculated during publication of this version.
1337413374
type: string
1337513375
example: "/api/v1/{group}/"
@@ -14107,7 +14107,7 @@ components:
1410714107
title: SearchResultPackage
1410814108
description: |
1410914109
Global search result for packages with kind = package; must be returned when searchLevel = package
14110-
* If search term matches the package id/name/description/service name, return the latest published version only.
14110+
* If search term matches the package id/name/description/service name, return the latest published version only.
1411114111
* If search term matches the version name/label, return that version.
1411214112
type: object
1411314113
required:

test/projects/apihub/docs/API-HUB_09.03.22.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ openapi: 3.1.0
22
info:
33
title: APIHUB BE API contract
44
description: >
5-
The API contract for APIHUB UI and APIDOC UI.
5+
The API contract for APIHUB UI and APIDOC UI.
66
77
You can find more information about the project at [DOC
88
page](url: https://qubership.org/APIHUB).
@@ -1503,7 +1503,7 @@ paths:
15031503
- Export
15041504
summary: Export offline API documentation by selected file
15051505
description: |
1506-
Export of offline API documentation by selected file as a zip archive.
1506+
Export of offline API documentation by selected file as a zip archive.
15071507
Type of the documentation file is provided as input parameters:
15081508
- STATIC/INTERACTIVE - html document.
15091509
- PDF - pdf document.
@@ -1568,7 +1568,7 @@ paths:
15681568
- Export
15691569
summary: Export offline API documentation by whole version
15701570
description: |
1571-
Export of offline API documentation as a zip archive.
1571+
Export of offline API documentation as a zip archive.
15721572
Type of the documentation file is provided as input parameters:
15731573
- STATIC/INTERACTIVE - html document.
15741574
- PDF - pdf document.

test/projects/bugs/delete-unused-components.yaml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,4 +64,3 @@ components:
6464
description: usedHeader
6565
unusedHeader:
6666
description: unusedHeader
67-

0 commit comments

Comments
 (0)