diff --git a/.github/super-linter.env b/.github/super-linter.env index cc056e5..cb368ef 100644 --- a/.github/super-linter.env +++ b/.github/super-linter.env @@ -39,3 +39,7 @@ VALIDATE_TYPESCRIPT_STANDARD=false # Skip OPENAPI check by CHECKOV for this repo as it contains invalid OAS 3.0 specs for testing purposes VALIDATE_CHECKOV=false +VALIDATE_OPENAPI=false + +# Skip checking of specially broken specifications +FILTER_REGEX_EXCLUDE=test/projects/broken/.* diff --git a/.github/workflows/delete-dist-tag.yaml b/.github/workflows/delete-dist-tag.yaml index d188bf0..da05cce 100644 --- a/.github/workflows/delete-dist-tag.yaml +++ b/.github/workflows/delete-dist-tag.yaml @@ -5,4 +5,4 @@ on: jobs: delete-dist-tag: - uses: netcracker/qubership-apihub-ci/.github/workflows/delete-dist-tag.yaml@main \ No newline at end of file + uses: netcracker/qubership-apihub-ci/.github/workflows/delete-dist-tag.yaml@main diff --git a/test/merge/openapi/paths-from-specs/1.yaml b/test/merge/openapi/paths-from-specs/1.yaml index 0694a3e..55f8c85 100644 --- a/test/merge/openapi/paths-from-specs/1.yaml +++ b/test/merge/openapi/paths-from-specs/1.yaml @@ -13,4 +13,4 @@ paths: responses: '200': description: OK - content: { } \ No newline at end of file + content: {} diff --git a/test/merge/openapi/paths-from-specs/2.yaml b/test/merge/openapi/paths-from-specs/2.yaml index ab4b2f7..114f27d 100644 --- a/test/merge/openapi/paths-from-specs/2.yaml +++ b/test/merge/openapi/paths-from-specs/2.yaml @@ -13,4 +13,4 @@ paths: responses: '200': description: OK - content: { } \ No newline at end of file + content: {} diff --git a/test/merge/openapi/paths-from-specs/result.yaml b/test/merge/openapi/paths-from-specs/result.yaml index 3a26bf5..d7080fe 100644 --- a/test/merge/openapi/paths-from-specs/result.yaml +++ b/test/merge/openapi/paths-from-specs/result.yaml @@ -13,7 +13,7 @@ paths: responses: '200': description: OK - content: { } + content: {} /path2: post: parameters: @@ -24,4 +24,4 @@ paths: responses: '200': description: OK - content: { } \ No newline at end of file + content: {} diff --git a/test/merge/openapi/security-from-specs/1.yaml b/test/merge/openapi/security-from-specs/1.yaml index b568ea0..d2231a7 100644 --- a/test/merge/openapi/security-from-specs/1.yaml +++ b/test/merge/openapi/security-from-specs/1.yaml @@ -3,4 +3,4 @@ info: title: test version: 0.1.0 security: - - oAuthSample: [ ] + - oAuthSample: [] diff --git a/test/merge/openapi/security-from-specs/2.yaml b/test/merge/openapi/security-from-specs/2.yaml index b568ea0..d2231a7 100644 --- a/test/merge/openapi/security-from-specs/2.yaml +++ b/test/merge/openapi/security-from-specs/2.yaml @@ -3,4 +3,4 @@ info: title: test version: 0.1.0 security: - - oAuthSample: [ ] + - oAuthSample: [] diff --git a/test/merge/openapi/security-from-specs/result.yaml b/test/merge/openapi/security-from-specs/result.yaml index ed06864..d2231a7 100644 --- a/test/merge/openapi/security-from-specs/result.yaml +++ b/test/merge/openapi/security-from-specs/result.yaml @@ -3,4 +3,4 @@ info: title: test version: 0.1.0 security: - - oAuthSample: [ ] \ No newline at end of file + - oAuthSample: [] diff --git a/test/merge/openapi/security-from-template/1.yaml b/test/merge/openapi/security-from-template/1.yaml index b568ea0..d2231a7 100644 --- a/test/merge/openapi/security-from-template/1.yaml +++ b/test/merge/openapi/security-from-template/1.yaml @@ -3,4 +3,4 @@ info: title: test version: 0.1.0 security: - - oAuthSample: [ ] + - oAuthSample: [] diff --git a/test/merge/openapi/security-from-template/result.yaml b/test/merge/openapi/security-from-template/result.yaml index dba12b7..79c6b8a 100644 --- a/test/merge/openapi/security-from-template/result.yaml +++ b/test/merge/openapi/security-from-template/result.yaml @@ -3,5 +3,5 @@ info: title: test version: 0.1.0 security: - - ApiKeyAuth1: [ ] - - ApiKeyAuth2: [ ] \ No newline at end of file + - ApiKeyAuth1: [] + - ApiKeyAuth2: [] diff --git a/test/merge/openapi/security-from-template/template.yaml b/test/merge/openapi/security-from-template/template.yaml index f26cbd7..79c6b8a 100644 --- a/test/merge/openapi/security-from-template/template.yaml +++ b/test/merge/openapi/security-from-template/template.yaml @@ -3,5 +3,5 @@ info: title: test version: 0.1.0 security: - - ApiKeyAuth1: [ ] - - ApiKeyAuth2: [ ] + - ApiKeyAuth1: [] + - ApiKeyAuth2: [] diff --git a/test/merge/openapi/should-merge-with-empty-template/1.yaml b/test/merge/openapi/should-merge-with-empty-template/1.yaml index 0fb268f..9c54b24 100644 --- a/test/merge/openapi/should-merge-with-empty-template/1.yaml +++ b/test/merge/openapi/should-merge-with-empty-template/1.yaml @@ -16,7 +16,7 @@ paths: responses: '200': description: OK - content: { } + content: {} components: schemas: TestSchema: @@ -26,7 +26,7 @@ components: responses: '200': description: OK - content: { } + content: {} parameters: x-request-id: name: x-request-id @@ -59,10 +59,10 @@ components: userId: '$response.body#/id' description: description security: - - oAuthSample: [ ] + - oAuthSample: [] tags: - name: tag1 description: desc1 externalDocs: description: External Docs - url: https://example.com \ No newline at end of file + url: https://example.com diff --git a/test/merge/openapi/should-merge-with-empty-template/result.yaml b/test/merge/openapi/should-merge-with-empty-template/result.yaml index a21d1ef..af62c71 100644 --- a/test/merge/openapi/should-merge-with-empty-template/result.yaml +++ b/test/merge/openapi/should-merge-with-empty-template/result.yaml @@ -16,7 +16,7 @@ paths: responses: '200': description: OK - content: { } + content: {} components: schemas: TestSchema: @@ -26,7 +26,7 @@ components: responses: '200': description: OK - content: { } + content: {} parameters: x-request-id: name: x-request-id @@ -59,7 +59,7 @@ components: userId: '$response.body#/id' description: description security: - - oAuthSample: [ ] + - oAuthSample: [] externalDocs: description: External Docs - url: https://example.com \ No newline at end of file + url: https://example.com diff --git a/test/merge/openapi/should-remove-unused-tags/1.yaml b/test/merge/openapi/should-remove-unused-tags/1.yaml index 444f04d..3524391 100644 --- a/test/merge/openapi/should-remove-unused-tags/1.yaml +++ b/test/merge/openapi/should-remove-unused-tags/1.yaml @@ -13,7 +13,7 @@ paths: description: OK content: application/json: - schema: { } + schema: {} /api/v1/pets/test/{id}: get: tags: @@ -24,7 +24,7 @@ paths: description: OK content: application/json: - schema: { } + schema: {} /api/v1/cars/test/test/{id}: get: tags: @@ -35,7 +35,7 @@ paths: description: OK content: application/json: - schema: { } + schema: {} tags: - name: Test Tag 1 description: desc1 diff --git a/test/merge/openapi/should-remove-unused-tags/result.yaml b/test/merge/openapi/should-remove-unused-tags/result.yaml index 2e43800..080e902 100644 --- a/test/merge/openapi/should-remove-unused-tags/result.yaml +++ b/test/merge/openapi/should-remove-unused-tags/result.yaml @@ -13,7 +13,7 @@ paths: description: OK content: application/json: - schema: { } + schema: {} /api/v1/pets/test/{id}: get: tags: @@ -24,7 +24,7 @@ paths: description: OK content: application/json: - schema: { } + schema: {} /api/v1/cars/test/test/{id}: get: tags: @@ -35,7 +35,7 @@ paths: description: OK content: application/json: - schema: { } + schema: {} tags: - name: Test Tag 1 description: desc1 diff --git a/test/merge/openapi/should-throw-on-different-components-responses/1.yaml b/test/merge/openapi/should-throw-on-different-components-responses/1.yaml index 99e86d5..7366544 100644 --- a/test/merge/openapi/should-throw-on-different-components-responses/1.yaml +++ b/test/merge/openapi/should-throw-on-different-components-responses/1.yaml @@ -24,17 +24,17 @@ paths: description: Pet object that needs to be added to the store content: application/json: - schema: { } + schema: {} required: true responses: '200': description: Pet updated content: application/json: - schema: { } + schema: {} headers: x-request-id: schema: type: string format: uuid - example: '325d31a4-700c-11ea-bc55-0242ac130003' \ No newline at end of file + example: '325d31a4-700c-11ea-bc55-0242ac130003' diff --git a/test/merge/openapi/should-throw-on-different-components-responses/2.yaml b/test/merge/openapi/should-throw-on-different-components-responses/2.yaml index ee3a4c2..ce7c97d 100644 --- a/test/merge/openapi/should-throw-on-different-components-responses/2.yaml +++ b/test/merge/openapi/should-throw-on-different-components-responses/2.yaml @@ -24,17 +24,17 @@ paths: description: Pet object that needs to be added to the store content: application/json: - schema: { } + schema: {} required: true responses: '200': description: Pet was updated content: application/json: - schema: { } + schema: {} headers: x-request-id: schema: type: string format: uuid - example: '325d31a4-700c-11ea-bc55-0242ac130003' \ No newline at end of file + example: '325d31a4-700c-11ea-bc55-0242ac130003' diff --git a/test/merge/openapi/should-throw-on-different-methods/1.yaml b/test/merge/openapi/should-throw-on-different-methods/1.yaml index 0694a3e..55f8c85 100644 --- a/test/merge/openapi/should-throw-on-different-methods/1.yaml +++ b/test/merge/openapi/should-throw-on-different-methods/1.yaml @@ -13,4 +13,4 @@ paths: responses: '200': description: OK - content: { } \ No newline at end of file + content: {} diff --git a/test/merge/openapi/should-throw-on-different-methods/2.yaml b/test/merge/openapi/should-throw-on-different-methods/2.yaml index f6b4442..49ba919 100644 --- a/test/merge/openapi/should-throw-on-different-methods/2.yaml +++ b/test/merge/openapi/should-throw-on-different-methods/2.yaml @@ -13,4 +13,4 @@ paths: responses: '200': description: OK - content: { } \ No newline at end of file + content: {} diff --git a/test/merge/openapi/should-throw-on-different-security/1.yaml b/test/merge/openapi/should-throw-on-different-security/1.yaml index b568ea0..d2231a7 100644 --- a/test/merge/openapi/should-throw-on-different-security/1.yaml +++ b/test/merge/openapi/should-throw-on-different-security/1.yaml @@ -3,4 +3,4 @@ info: title: test version: 0.1.0 security: - - oAuthSample: [ ] + - oAuthSample: [] diff --git a/test/merge/openapi/should-throw-on-different-security/2.yaml b/test/merge/openapi/should-throw-on-different-security/2.yaml index f26cbd7..79c6b8a 100644 --- a/test/merge/openapi/should-throw-on-different-security/2.yaml +++ b/test/merge/openapi/should-throw-on-different-security/2.yaml @@ -3,5 +3,5 @@ info: title: test version: 0.1.0 security: - - ApiKeyAuth1: [ ] - - ApiKeyAuth2: [ ] + - ApiKeyAuth1: [] + - ApiKeyAuth2: [] diff --git a/test/projects/agent/PublicRegistry API(4).yaml b/test/projects/agent/PublicRegistry API(4).yaml index 6eb392d..26f10aa 100644 --- a/test/projects/agent/PublicRegistry API(4).yaml +++ b/test/projects/agent/PublicRegistry API(4).yaml @@ -103,7 +103,7 @@ paths: description: | Starts the SAML authentication process in APIHUB. - In case of successful authentication, the request will be redirected to the **redirectUri** and + In case of successful authentication, the request will be redirected to the **redirectUri** and the response will contain cookie with access token for future API calls. All subsequent APIHUB calls must use this token in a **BearerAuth** authentication. operationId: postAuthSAML @@ -2019,7 +2019,7 @@ paths: * new_version - publish_new_version. * package_version - patch_version_meta, delete_version, publish_new_revision. * package_management - create_package, delete_package, patch_package_meta. - * operations_group - create_manual_group, delete_manual_group, + * operations_group - create_manual_group, delete_manual_group, update_operations_group_parameters in: query schema: @@ -3095,7 +3095,7 @@ paths: summary: Publish package version via upload description: | Publish package version via upload. Possible options: - * **Client-side building** - client application marks, that the validation and build of the final specification will be outside the APIHUB backend. + * **Client-side building** - client application marks, that the validation and build of the final specification will be outside the APIHUB backend. The final specifications will be stored using the POST /packages/{packageId}/publish/{publishId}/status API. The 202 response and the publish process Id will be returned in success. In case of the client session close, the build will be continued on the server-sde. @@ -3126,9 +3126,9 @@ paths: in: query required: false description: "In case when resolved refs list contains multiple versions of the same package: - + - if resolveConflicts=false - status 400 (Bad request). Conflicts should be resolved manually. - + - if resolveConflicts=true - conflicts will be resolved automatically, some refs will be marked as excluded" schema: type: boolean @@ -3534,7 +3534,7 @@ paths: - name: checkRevisions in: query description: | - Flag, if to search in the previous versions revisions. + Flag, if to search in the previous versions revisions. * if several revisions were found, return only the maximum found value. * if false - return the last published revision. schema: @@ -3705,7 +3705,7 @@ paths: - name: checkRevisions in: query description: | - Flag, if to search in the previous versions revisions. + Flag, if to search in the previous versions revisions. * if several revisions were found, return only the maximum found value. * if false - return the last published revision. schema: @@ -3815,7 +3815,7 @@ paths: - name: version in: path description: | - Package version. + Package version. The mask @ may be used for search in a specific revision. required: true schema: @@ -3972,9 +3972,9 @@ paths: - Admin summary: Update package version description: | - Update package version. + Update package version. * If the parameter is not transmitted in request - its value stays unchanged. - * The empty parameter value in request sets the empty value in database. + * The empty parameter value in request sets the empty value in database. * The array of labels will be fully replaced as-it-send, no JSON-Patch approach for arrays is applicable. operationId: patchPackagesIdVersionsIdV2 security: @@ -4140,7 +4140,7 @@ paths: - name: version in: path description: | - Package version. + Package version. The mask @ may be used for search in a specific revision. required: true schema: @@ -4529,7 +4529,7 @@ paths: - name: version in: path description: | - Package version. + Package version. The mask @ may be used for search in a specific revision. required: true schema: @@ -4758,7 +4758,7 @@ paths: - name: version in: path description: | - Package version. + Package version. The mask @ may be used for search in a specific revision. required: true schema: @@ -5146,8 +5146,8 @@ paths: description: Export API changes to xlsx file operationId: getPackageIdVersionIdChangesExport security: - - BearerAuth: [ ] - - api-key: [ ] + - BearerAuth: [] + - api-key: [] responses: "200": description: Success @@ -5189,7 +5189,7 @@ paths: application/json: schema: $ref: "#/components/schemas/ErrorResponse" - examples: { } + examples: {} "404": description: Not found content: @@ -5493,9 +5493,9 @@ paths: example: QS.CQSS.CPQ.TMF version: description: | - Package version. + Package version. The mask @ may be used for search in a specific revision. - + If the @revision is not provided, the latest version's revision will be used. type: string example: "2022.3@3" @@ -5507,7 +5507,7 @@ paths: description: | Name of the previous published version to compare with. The mask @ may be used for search in a specific revision. - + If the @revision is not provided, the latest version's revision will be used. type: string example: "2022.2@4" @@ -5528,9 +5528,9 @@ paths: example: QS.CQSS.CPQ.TMF version: description: | - Package version. + Package version. The mask @ will be used for return in a specific revision. - + If the @ was not transmitted in the request - it won't be returned in response. Consider the version as the latest one. type: string example: "2022.3@3" @@ -5542,7 +5542,7 @@ paths: description: | Name of the previous published version. The mask @ will be used for return a specific revision. - + If the @ was not transmitted in the request - it won't be returned in response. Consider the version as the latest one. type: string example: "2022.2@4" @@ -5665,9 +5665,9 @@ paths: example: QS.CQSS.CPQ.TMF version: description: | - Package version. + Package version. The mask @ will be used for return in a specific revision. - + If the @ was not transmitted in the request - it won't be returned in response. Consider the version as the latest one. type: string example: "2022.3@3" @@ -5819,7 +5819,7 @@ paths: default: false - name: format in: query - description: | + description: | Format of the exported file.\ If buidType = reducedSourceSpecifications, then format can be yaml, json or html.\ If buidType = mergedspecification, then format can be yaml or json; html is not supported for this buildType. @@ -5847,7 +5847,7 @@ paths: example: QS.CQSS.CPQ.TMF version: description: | - Package version. + Package version. The mask @ will be used for return in a specific revision. If the @ was not transmitted in the request - it won't be returned in response. Consider the version as the latest one. type: string @@ -6022,7 +6022,7 @@ paths: application/json: schema: $ref: "#/components/schemas/ErrorResponse" - examples: { } + examples: {} "500": description: Internal Server Error content: @@ -6077,7 +6077,7 @@ paths: - name: format in: query required: true - description: | + description: | Format of the exported file.\ If buidType = reducedSourceSpecifications, then format can be yaml, json or html.\ If buidType = mergedspecification, then format can be yaml or json; html is not supported for this buildType. @@ -6145,7 +6145,7 @@ paths: application/json: schema: $ref: "#/components/schemas/ErrorResponse" - examples: { } + examples: {} "500": description: Internal Server Error content: @@ -6228,7 +6228,7 @@ paths: - Export summary: Export offline API documentation by selected file description: | - Export of offline API documentation by selected file as a zip archive. + Export of offline API documentation by selected file as a zip archive. Type of the documentation file is provided as input parameters: - interactive - html document - raw - yaml/json document. @@ -6318,8 +6318,8 @@ paths: Export sources of package version as a zip archive and build configuration that was used for this version. operationId: getPackageVersionSourcesWithBuildConfig security: - - BearerAuth: [ ] - - api-key: [ ] + - BearerAuth: [] + - api-key: [] responses: "200": description: Success @@ -6349,14 +6349,14 @@ paths: application/json: schema: $ref: "#/components/schemas/ErrorResponse" - examples: { } + examples: {} "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" - examples: { } + examples: {} "404": description: Not found content: @@ -6388,7 +6388,7 @@ paths: - Export summary: Export offline API documentation by selected versions description: | - Export of offline API documentation by selected version (all files) as a zip archive. + Export of offline API documentation by selected version (all files) as a zip archive. Type of the documentation file is provided as input parameters: * interactive - html document. operationId: getPackagesIdVersionsIdDoc @@ -6467,7 +6467,7 @@ paths: - Roles summary: Create a new role description: | - Create a new role with the set of available permissions for this role. + Create a new role with the set of available permissions for this role. The role may be assigned to the user for the specific package. @@ -6579,7 +6579,7 @@ paths: - Roles summary: Update role description: | - Change role parameters. + Change role parameters. If the parameter is not transmitted in the request, its value remains unchanged. @@ -6644,7 +6644,7 @@ paths: - Roles summary: Delete role description: | - Delete a role with its permissions. + Delete a role with its permissions. When the role is deleted, all users with that role shall be removed from packages. @@ -6687,7 +6687,7 @@ paths: - Roles summary: Update the roles order description: | - Update the roles order. + Update the roles order. The list of roles will be replaced, all existing roles are required in request (return an error otherwise). operationId: postRolesChangeOrder @@ -7613,7 +7613,7 @@ paths: example: "Billing account" packageIds: description: | - List of Package Id(s). + List of Package Id(s). * If user specified Workspace(s), then Workspace Id(s) must be transmitted. * If user specified Workspace(s) and Group(s), then Group Id(s) must be transmitted. * 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: example: "Billing account" packageIds: description: | - List of Package Id(s). + List of Package Id(s). * If user specified Workspace(s), then Workspace Id(s) must be transmitted. * If user specified Workspace(s) and Group(s), then Group Id(s) must be transmitted. * 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: title: SearchResultPackage description: | Global search result for packages with kind = package; must be returned when searchLevel = package - * If search term matches the package id/name/description/service name, return the latest published version only. + * If search term matches the package id/name/description/service name, return the latest published version only. * If search term matches the version name/label, return that version. type: object required: @@ -8434,7 +8434,7 @@ paths: summary: Create internal user description: | Creation of the internal user, not connected to LDAP or GitLab. - * If the userId already exists, return an error. + * If the userId already exists, return an error. * One email may be connected to several users at one time, no unique constraint. * The password will be stored in an encrypted form locally. operationId: postUsers @@ -8569,7 +8569,7 @@ paths: type: string example: user1221 security: - - BearerAuth: [ ] + - BearerAuth: [] responses: "200": description: Success @@ -8577,21 +8577,21 @@ paths: application/json: schema: $ref: "#/components/schemas/User" - examples: { } + examples: {} "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" - examples: { } + examples: {} "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" - examples: { } + examples: {} "404": description: Not found content: @@ -8711,7 +8711,7 @@ paths: Flag, filtering the operations without tags at all. In response will be returned the list of operations, on what the tag is not filled in. - + This attribute has a higher priority than the **tag**. In case, then **emptyTag: true**, it will override the **tag** filter. schema: type: boolean @@ -8891,7 +8891,7 @@ paths: Flag, filtering the operations without tags at all. In response will be returned the list of operations, on what the tag is not filled in. - + This attribute has a higher priority than the **tag**. In case, then **emptyTag: true**, it will override the **tag** filter. schema: type: boolean @@ -9070,7 +9070,7 @@ paths: Get summary of deprecated operations in the version operationId: getPackageIdVersionDeprecatedSummaryV3 security: - - BearerAuth: [ ] + - BearerAuth: [] parameters: - $ref: "#/components/parameters/packageId" - $ref: "#/components/parameters/version" @@ -9199,8 +9199,8 @@ paths: List of deprecated operations in the current version operationId: getPackagesIdVersionsIdApiTypeDeprecations security: - - BearerAuth: [ ] - - api-key: [ ] + - BearerAuth: [] + - api-key: [] parameters: - $ref: "#/components/parameters/apiType" - $ref: "#/components/parameters/packageId" @@ -9222,7 +9222,7 @@ paths: - name: version in: path description: | - Package version. + Package version. The mask @ may be used for search in a specific revision. required: true schema: @@ -9340,7 +9340,7 @@ paths: deprecatedInfo: description: | Additional information about deprecated operation: - * for REST API it is value of 'x-deprecated-meta' extension (value of extension must be string), which is defined for deprecated operation. + * for REST API it is value of 'x-deprecated-meta' extension (value of extension must be string), which is defined for deprecated operation. * for GraphQL API it is value of 'reason' argument of @deprecated directive, which is defined for deprecated operation. type: string deprecatedItems: @@ -9420,8 +9420,8 @@ paths: Deprecated item is entity that is deprecated inside of API operation. For example for REST API it can be parameter or schema, for GraphQL API - field or enum value. operationId: getPackagesIdVersionsApiTypeOperationsIddeprecatedItems security: - - BearerAuth: [ ] - - api-key: [ ] + - BearerAuth: [] + - api-key: [] parameters: - $ref: "#/components/parameters/apiType" - $ref: "#/components/parameters/packageId" @@ -9481,8 +9481,8 @@ paths: Get list of operations that have the same model operationId: getPackagesIdVersionsApiTypeOperationsIdModelsModelName security: - - BearerAuth: [ ] - - api-key: [ ] + - BearerAuth: [] + - api-key: [] parameters: - $ref: "#/components/parameters/apiType" - $ref: "#/components/parameters/packageId" @@ -9556,8 +9556,8 @@ paths: Export operations of specific API type. operationId: getPackagesIdVersionsIdApiTypeOperationsExport security: - - BearerAuth: [ ] - - api-key: [ ] + - BearerAuth: [] + - api-key: [] parameters: - $ref: "#/components/parameters/apiType" - $ref: "#/components/parameters/packageId" @@ -9670,7 +9670,7 @@ paths: application/json: schema: $ref: "#/components/schemas/ErrorResponse" - examples: { } + examples: {} "500": description: Internal Server Error content: @@ -9689,8 +9689,8 @@ paths: Export operations of specific API type. operationId: getPackagesIdVersionsIdApiTypeOperationsExport security: - - BearerAuth: [ ] - - api-key: [ ] + - BearerAuth: [] + - api-key: [] parameters: - $ref: "#/components/parameters/apiType" - $ref: "#/components/parameters/packageId" @@ -9801,7 +9801,7 @@ paths: application/json: schema: $ref: "#/components/schemas/ErrorResponse" - examples: { } + examples: {} "500": description: Internal Server Error content: @@ -10294,7 +10294,7 @@ paths: Flag, filtering the operations without tags at all. In response will be returned the list of operations, on what the tag is not filled in. - + This attribute has a higher priority than the **tag**. In case, then **emptyTag: true**, it will override the **tag** filter. schema: type: boolean @@ -10486,7 +10486,7 @@ paths: packageId: description: | ID of package.\ - PackageId and version shall be specified in case of dashboard to identify source package. + PackageId and version shall be specified in case of dashboard to identify source package. If packageId and version are not specified, this will mean that the source of the operation is the current package version. type: string example: "QS.CloudQSS.CPQ.Q-TMF" @@ -10748,7 +10748,7 @@ paths: packageId: description: | ID of package.\ - PackageId and version shall be specified in case of dashboard to identify source package. + PackageId and version shall be specified in case of dashboard to identify source package. If packageId and version are not specified, this will mean that the source of the operation is the current package version. type: string example: "QS.CloudQSS.CPQ.Q-TMF" @@ -10876,7 +10876,7 @@ paths: packageId: description: | ID of package.\ - PackageId and version shall be specified in case of dashboard to identify source package. + PackageId and version shall be specified in case of dashboard to identify source package. If packageId and version are not specified, this will mean that the source of the operation is the current package version. type: string example: "QS.CloudQSS.CPQ.Q-TMF" @@ -11138,7 +11138,7 @@ paths: description: | Get list of documents in a version. The result depend on the package.kind: * For package.kind: package - return the list of version documents. - * For package.kind: dashboard - return the list of all referenced dashboards and their referenced packages in recursion. + * For package.kind: dashboard - return the list of all referenced dashboards and their referenced packages in recursion. The returned list will contain only leaves - referenced packages of the lowest level with their published documents. operationId: getPackagesIdVersionsIdDocuments security: @@ -12176,8 +12176,8 @@ paths: Get the list of version revisions. operationId: getPackagesIdVersionsIdRevisions security: - - BearerAuth: [ ] - - api-key: [ ] + - BearerAuth: [] + - api-key: [] parameters: - $ref: "#/components/parameters/packageId" - $ref: "#/components/parameters/version" @@ -12263,7 +12263,7 @@ paths: description: Namespace of Agent's publication. type: string example: cloudQSS-release2 - examples: { } + examples: {} "301": description: Moved Permanently headers: @@ -12290,14 +12290,14 @@ paths: application/json: schema: $ref: "#/components/schemas/ErrorResponse" - examples: { } + examples: {} "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" - examples: { } + examples: {} "404": description: Not found content: @@ -12325,8 +12325,8 @@ paths: Get the list of version revisions. operationId: getPackagesIdVersionsIdRevisionsV3 security: - - BearerAuth: [ ] - - api-key: [ ] + - BearerAuth: [] + - api-key: [] parameters: - $ref: "#/components/parameters/packageId" - $ref: "#/components/parameters/version" @@ -12350,7 +12350,7 @@ paths: type: array items: $ref: "#/components/schemas/PackageVersionRevision" - examples: { } + examples: {} "301": description: Moved Permanently headers: @@ -12377,7 +12377,7 @@ paths: application/json: schema: $ref: "#/components/schemas/ErrorResponse" - examples: { } + examples: {} "404": description: Not found content: @@ -12406,8 +12406,8 @@ paths: description: Recursively delete all expired versions in 'Draft' status under group or workspace operationId: deleteExpiredVersionsRecursively security: - - BearerAuth: [ ] - - api-key: [ ] + - BearerAuth: [] + - api-key: [] requestBody: description: Recursive delete parameters content: @@ -12621,7 +12621,7 @@ paths: summary: Create personal private package for the user description: | Any user is able to create one personal private workspace (*no permissions required*) - + PackageId for this workspace could be set via user creation endpoint (only for new users) or generated automatically when user first logs in to apihub operationId: postUsersIdAvailablePackagePromoteStatuses security: @@ -12686,9 +12686,9 @@ paths: summary: Get list of available package publish statuses for the user. description: | By collection of packages, **get** the available statuses for publish into for the particular user. - + Statuses list depends on the current user access rights for the particular package. - + The response is a **mapped list** of statuses to the packageIds. operationId: getUsersIdAvailablePackagePromoteStatuses security: @@ -12715,7 +12715,7 @@ paths: type: array items: type: string - example: ["QS.CloudQSS.CPQ.Q-TMF","QS.CloudQSS.CPQ.QE-SRV"] + example: ["QS.CloudQSS.CPQ.Q-TMF", "QS.CloudQSS.CPQ.QE-SRV"] required: true responses: "200": @@ -12766,7 +12766,7 @@ paths: description: Allows to send any request to any address. operationId: getAgentsIdNamespacesIdServicesProxy security: - - { } + - {} tags: - TryIt parameters: @@ -13227,7 +13227,7 @@ components: deprecatedInfo: description: | Additional information about single deprecated item: - * for REST API it is value of 'x-deprecated-meta' extension (value of extension must be string), which is defined for deprecated item. + * for REST API it is value of 'x-deprecated-meta' extension (value of extension must be string), which is defined for deprecated item. * for GraphQL API it is value of 'reason' argument of @deprecated directive. type: string tolerantHash: @@ -13369,7 +13369,7 @@ components: type: boolean restGroupingPrefix: description: | - Regular expression used as criteria for grouping operations. + Regular expression used as criteria for grouping operations. Groups for the package version are calculated during publication of this version. type: string example: "/api/v1/{group}/" @@ -14107,7 +14107,7 @@ components: title: SearchResultPackage description: | Global search result for packages with kind = package; must be returned when searchLevel = package - * If search term matches the package id/name/description/service name, return the latest published version only. + * If search term matches the package id/name/description/service name, return the latest published version only. * If search term matches the version name/label, return that version. type: object required: @@ -14614,7 +14614,7 @@ components: BuildResultV2: description: | Result of build operation in ZIP archive. - * The archive contains folders with sources, builded JSON documents and JSON operation files. + * The archive contains folders with sources, builded JSON documents and JSON operation files. * In addition, several config files are provided. he structure of these files is described below. title: BuildResult type: object @@ -14653,7 +14653,7 @@ components: description: | Type of the build process. Available options are: - **build** - Standard build process. + **build** - Standard build process. Consist of contract and operations build and validation, calculation of the changelog, creation of the final version of the published contracts. **changelog** - Only the changelog calculation, no API contracts version will be created. @@ -15099,7 +15099,7 @@ components: BuildResult: description: | Result of build operation in ZIP archive. - * The archive contains folders with sources, builded JSON documents and JSON operation files. + * The archive contains folders with sources, builded JSON documents and JSON operation files. * In addition, several config files are provided. he structure of these files is described below. title: BuildResult type: object @@ -15449,7 +15449,7 @@ components: deprecatedInfo: description: | Additional information about deprecated operation: - * for REST API it is value of 'x-deprecated-meta' extension (value of extension must be string), which is defined for deprecated operation. + * for REST API it is value of 'x-deprecated-meta' extension (value of extension must be string), which is defined for deprecated operation. * for GraphQL API it is value of 'reason' argument of @deprecated directive, which is defined for deprecated operation. type: string deprecatedInPreviousVersions: @@ -15516,9 +15516,9 @@ components: type: array items: anyOf: - - type: string - - type: integer - example: [["components/schemas/Cat/minProperties", "components/schemas/Dog/minProperties"],["/quoteManagement/v5/quote"]] + - type: string + - type: integer + example: [["components/schemas/Cat/minProperties", "components/schemas/Dog/minProperties"], ["/quoteManagement/v5/quote"]] currentValueHash: type: string description: | @@ -15537,9 +15537,9 @@ components: type: array items: anyOf: - - type: string - - type: integer - example: [["components/schemas/Cat/minProperties", "components/schemas/Dog/minProperties"],["/quoteManagement/v5/quote"]] + - type: string + - type: integer + example: [["components/schemas/Cat/minProperties", "components/schemas/Dog/minProperties"], ["/quoteManagement/v5/quote"]] previousValueHash: type: string description: | @@ -15558,9 +15558,9 @@ components: type: array items: anyOf: - - type: string - - type: integer - example: [["components/schemas/Cat/minProperties", "components/schemas/Dog/minProperties"],["/quoteManagement/v5/quote"]] + - type: string + - type: integer + example: [["components/schemas/Cat/minProperties", "components/schemas/Dog/minProperties"], ["/quoteManagement/v5/quote"]] previousDeclarationJsonPaths: description: | (below, a document is not considered to be an original document, but a document with one specific operation)\ @@ -15570,9 +15570,9 @@ components: type: array items: anyOf: - - type: string - - type: integer - example: [["components/schemas/Cat/minProperties", "components/schemas/Dog/minProperties"],["/quoteManagement/v5/quote"]] + - type: string + - type: integer + example: [["components/schemas/Cat/minProperties", "components/schemas/Dog/minProperties"], ["/quoteManagement/v5/quote"]] previousValueHash: type: string description: | @@ -15596,9 +15596,9 @@ components: type: array items: anyOf: - - type: string - - type: integer - example: [["components/schemas/Cat/minProperties", "components/schemas/Dog/minProperties"],["/quoteManagement/v5/quote"]] + - type: string + - type: integer + example: [["components/schemas/Cat/minProperties", "components/schemas/Dog/minProperties"], ["/quoteManagement/v5/quote"]] previousDeclarationJsonPaths: description: | (below, a document is not considered to be an original document, but a document with one specific operation)\ @@ -15608,9 +15608,9 @@ components: type: array items: anyOf: - - type: string - - type: integer - example: [["components/schemas/Cat/minProperties", "components/schemas/Dog/minProperties"],["/quoteManagement/v5/quote"]] + - type: string + - type: integer + example: [["components/schemas/Cat/minProperties", "components/schemas/Dog/minProperties"], ["/quoteManagement/v5/quote"]] previousKey: type: string description: Previous key (name) of the renamed entity. @@ -15620,7 +15620,7 @@ components: BuildConfig: type: object description: | - Configuration of the source files. + Configuration of the source files. Content can not be empty, files or refs are **required**. required: - version @@ -15638,8 +15638,8 @@ components: example: "2022.2" default: "" previousVersionPackageId: - description: | - Required in case of snapshot when publishing version should be compared to different package. + description: | + Required in case of snapshot when publishing version should be compared to different package. Do not set anything if the package sould be compared to itself. Value equals to packageId is forbidden. type: string example: "QS.CloudOSS.PL.MC" @@ -15738,9 +15738,9 @@ components: description: File name. example: "qitmf-v5.11.json" publish: - description: | - Flag, publish the source file or not. - Required for case with external refs when specification is separated into multiple files. + description: | + Flag, publish the source file or not. + Required for case with external refs when specification is separated into multiple files. After dereference in scope of build process the source files(parts) are no longer required. So it's possible to skip publish of such files. type: boolean default: true @@ -15918,7 +15918,7 @@ components: example: template123.json BuildTypes: type: string - description: | + description: | Type of the build process. Available options are:\ **build** - Standard build process to publish new version. Consist of contract and operations build and validation, calculation of the changelog, creation of the final version of the published contracts.\ **changelog** - Only the changelog calculation, no API contracts version will be created. The ```files``` and ```refs``` objects are not required in this case.\ @@ -16077,4 +16077,4 @@ components: BasicAuth: type: http description: Login/password authentication. - scheme: basic \ No newline at end of file + scheme: basic diff --git a/test/projects/api-kinds/Petstore.yaml b/test/projects/api-kinds/Petstore.yaml index 18a022b..bae1a17 100644 --- a/test/projects/api-kinds/Petstore.yaml +++ b/test/projects/api-kinds/Petstore.yaml @@ -2,7 +2,7 @@ openapi: 3.0.3 info: title: Swagger Petstore - OpenAPI 3.0 description: >- - This is a sample Pet Store Server based on the OpenAPI 3.0 specification. + This is a sample Pet Store Server based on the OpenAPI 3.0 specification. You can find out more about Swagger at [https://swagger.io](https://swagger.io). In the third iteration @@ -847,4 +847,4 @@ components: type: string format: uuid example: 123 - required: true \ No newline at end of file + required: true diff --git a/test/projects/api-kinds/Petstorev2.yaml b/test/projects/api-kinds/Petstorev2.yaml index b021f06..f3ea9cb 100644 --- a/test/projects/api-kinds/Petstorev2.yaml +++ b/test/projects/api-kinds/Petstorev2.yaml @@ -2,7 +2,7 @@ openapi: 3.0.3 info: title: Swagger Petstore - OpenAPI 3.0 description: >- - This is a sample Pet Store Server based on the OpenAPI 3.0 specification. + This is a sample Pet Store Server based on the OpenAPI 3.0 specification. You can find out more about Swagger at [https://swagger.io](https://swagger.io). In the third iteration @@ -798,4 +798,4 @@ components: type: string format: uuid example: 123 - required: true \ No newline at end of file + required: true diff --git a/test/projects/api-kinds/Petstorev3.yaml b/test/projects/api-kinds/Petstorev3.yaml index c9d6aa6..d3f4268 100644 --- a/test/projects/api-kinds/Petstorev3.yaml +++ b/test/projects/api-kinds/Petstorev3.yaml @@ -2,7 +2,7 @@ openapi: 3.0.3 info: title: Swagger Petstore - OpenAPI 3.0 description: >- - This is a sample Pet Store Server based on the OpenAPI 3.0 specification. + This is a sample Pet Store Server based on the OpenAPI 3.0 specification. You can find out more about Swagger at [https://swagger.io](https://swagger.io). In the third iteration @@ -837,4 +837,4 @@ components: type: string format: uuid example: 123 - required: true \ No newline at end of file + required: true diff --git a/test/projects/apihub/APIHUB API.yaml b/test/projects/apihub/APIHUB API.yaml index a0309ec..d824714 100644 --- a/test/projects/apihub/APIHUB API.yaml +++ b/test/projects/apihub/APIHUB API.yaml @@ -2,7 +2,7 @@ openapi: 3.1.0 info: title: APIHUB BE API contract description: > - The API contract for APIHUB UI and APIDOC UI. + The API contract for APIHUB UI and APIDOC UI. You can find more information about the project at [DOC page](url: https://qubership.org/APIHUB). @@ -1506,7 +1506,7 @@ paths: - Export summary: Export offline API documentation by selected file description: | - Export of offline API documentation by selected file as a zip archive. + Export of offline API documentation by selected file as a zip archive. Type of the documentation file is provided as input parameters: - STATIC/INTERACTIVE - html document. - PDF - pdf document. @@ -1571,7 +1571,7 @@ paths: - Export summary: Export offline API documentation by whole version description: | - Export of offline API documentation as a zip archive. + Export of offline API documentation as a zip archive. Type of the documentation file is provided as input parameters: - STATIC/INTERACTIVE - html document. - PDF - pdf document. @@ -3027,4 +3027,4 @@ components: $ref: "#/components/schemas/ErrorResponse" security: - BearerAuth: [] - - api-key: [] \ No newline at end of file + - api-key: [] diff --git a/test/projects/apihub/OpenApi 3.1.yaml b/test/projects/apihub/OpenApi 3.1.yaml index 10d9d7a..38e0d79 100644 --- a/test/projects/apihub/OpenApi 3.1.yaml +++ b/test/projects/apihub/OpenApi 3.1.yaml @@ -939,4 +939,4 @@ definitions: map-of-strings: type: object additionalProperties: - type: string \ No newline at end of file + type: string diff --git a/test/projects/apihub/Public Registry API.yaml b/test/projects/apihub/Public Registry API.yaml index 6eb392d..26f10aa 100644 --- a/test/projects/apihub/Public Registry API.yaml +++ b/test/projects/apihub/Public Registry API.yaml @@ -103,7 +103,7 @@ paths: description: | Starts the SAML authentication process in APIHUB. - In case of successful authentication, the request will be redirected to the **redirectUri** and + In case of successful authentication, the request will be redirected to the **redirectUri** and the response will contain cookie with access token for future API calls. All subsequent APIHUB calls must use this token in a **BearerAuth** authentication. operationId: postAuthSAML @@ -2019,7 +2019,7 @@ paths: * new_version - publish_new_version. * package_version - patch_version_meta, delete_version, publish_new_revision. * package_management - create_package, delete_package, patch_package_meta. - * operations_group - create_manual_group, delete_manual_group, + * operations_group - create_manual_group, delete_manual_group, update_operations_group_parameters in: query schema: @@ -3095,7 +3095,7 @@ paths: summary: Publish package version via upload description: | Publish package version via upload. Possible options: - * **Client-side building** - client application marks, that the validation and build of the final specification will be outside the APIHUB backend. + * **Client-side building** - client application marks, that the validation and build of the final specification will be outside the APIHUB backend. The final specifications will be stored using the POST /packages/{packageId}/publish/{publishId}/status API. The 202 response and the publish process Id will be returned in success. In case of the client session close, the build will be continued on the server-sde. @@ -3126,9 +3126,9 @@ paths: in: query required: false description: "In case when resolved refs list contains multiple versions of the same package: - + - if resolveConflicts=false - status 400 (Bad request). Conflicts should be resolved manually. - + - if resolveConflicts=true - conflicts will be resolved automatically, some refs will be marked as excluded" schema: type: boolean @@ -3534,7 +3534,7 @@ paths: - name: checkRevisions in: query description: | - Flag, if to search in the previous versions revisions. + Flag, if to search in the previous versions revisions. * if several revisions were found, return only the maximum found value. * if false - return the last published revision. schema: @@ -3705,7 +3705,7 @@ paths: - name: checkRevisions in: query description: | - Flag, if to search in the previous versions revisions. + Flag, if to search in the previous versions revisions. * if several revisions were found, return only the maximum found value. * if false - return the last published revision. schema: @@ -3815,7 +3815,7 @@ paths: - name: version in: path description: | - Package version. + Package version. The mask @ may be used for search in a specific revision. required: true schema: @@ -3972,9 +3972,9 @@ paths: - Admin summary: Update package version description: | - Update package version. + Update package version. * If the parameter is not transmitted in request - its value stays unchanged. - * The empty parameter value in request sets the empty value in database. + * The empty parameter value in request sets the empty value in database. * The array of labels will be fully replaced as-it-send, no JSON-Patch approach for arrays is applicable. operationId: patchPackagesIdVersionsIdV2 security: @@ -4140,7 +4140,7 @@ paths: - name: version in: path description: | - Package version. + Package version. The mask @ may be used for search in a specific revision. required: true schema: @@ -4529,7 +4529,7 @@ paths: - name: version in: path description: | - Package version. + Package version. The mask @ may be used for search in a specific revision. required: true schema: @@ -4758,7 +4758,7 @@ paths: - name: version in: path description: | - Package version. + Package version. The mask @ may be used for search in a specific revision. required: true schema: @@ -5146,8 +5146,8 @@ paths: description: Export API changes to xlsx file operationId: getPackageIdVersionIdChangesExport security: - - BearerAuth: [ ] - - api-key: [ ] + - BearerAuth: [] + - api-key: [] responses: "200": description: Success @@ -5189,7 +5189,7 @@ paths: application/json: schema: $ref: "#/components/schemas/ErrorResponse" - examples: { } + examples: {} "404": description: Not found content: @@ -5493,9 +5493,9 @@ paths: example: QS.CQSS.CPQ.TMF version: description: | - Package version. + Package version. The mask @ may be used for search in a specific revision. - + If the @revision is not provided, the latest version's revision will be used. type: string example: "2022.3@3" @@ -5507,7 +5507,7 @@ paths: description: | Name of the previous published version to compare with. The mask @ may be used for search in a specific revision. - + If the @revision is not provided, the latest version's revision will be used. type: string example: "2022.2@4" @@ -5528,9 +5528,9 @@ paths: example: QS.CQSS.CPQ.TMF version: description: | - Package version. + Package version. The mask @ will be used for return in a specific revision. - + If the @ was not transmitted in the request - it won't be returned in response. Consider the version as the latest one. type: string example: "2022.3@3" @@ -5542,7 +5542,7 @@ paths: description: | Name of the previous published version. The mask @ will be used for return a specific revision. - + If the @ was not transmitted in the request - it won't be returned in response. Consider the version as the latest one. type: string example: "2022.2@4" @@ -5665,9 +5665,9 @@ paths: example: QS.CQSS.CPQ.TMF version: description: | - Package version. + Package version. The mask @ will be used for return in a specific revision. - + If the @ was not transmitted in the request - it won't be returned in response. Consider the version as the latest one. type: string example: "2022.3@3" @@ -5819,7 +5819,7 @@ paths: default: false - name: format in: query - description: | + description: | Format of the exported file.\ If buidType = reducedSourceSpecifications, then format can be yaml, json or html.\ If buidType = mergedspecification, then format can be yaml or json; html is not supported for this buildType. @@ -5847,7 +5847,7 @@ paths: example: QS.CQSS.CPQ.TMF version: description: | - Package version. + Package version. The mask @ will be used for return in a specific revision. If the @ was not transmitted in the request - it won't be returned in response. Consider the version as the latest one. type: string @@ -6022,7 +6022,7 @@ paths: application/json: schema: $ref: "#/components/schemas/ErrorResponse" - examples: { } + examples: {} "500": description: Internal Server Error content: @@ -6077,7 +6077,7 @@ paths: - name: format in: query required: true - description: | + description: | Format of the exported file.\ If buidType = reducedSourceSpecifications, then format can be yaml, json or html.\ If buidType = mergedspecification, then format can be yaml or json; html is not supported for this buildType. @@ -6145,7 +6145,7 @@ paths: application/json: schema: $ref: "#/components/schemas/ErrorResponse" - examples: { } + examples: {} "500": description: Internal Server Error content: @@ -6228,7 +6228,7 @@ paths: - Export summary: Export offline API documentation by selected file description: | - Export of offline API documentation by selected file as a zip archive. + Export of offline API documentation by selected file as a zip archive. Type of the documentation file is provided as input parameters: - interactive - html document - raw - yaml/json document. @@ -6318,8 +6318,8 @@ paths: Export sources of package version as a zip archive and build configuration that was used for this version. operationId: getPackageVersionSourcesWithBuildConfig security: - - BearerAuth: [ ] - - api-key: [ ] + - BearerAuth: [] + - api-key: [] responses: "200": description: Success @@ -6349,14 +6349,14 @@ paths: application/json: schema: $ref: "#/components/schemas/ErrorResponse" - examples: { } + examples: {} "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" - examples: { } + examples: {} "404": description: Not found content: @@ -6388,7 +6388,7 @@ paths: - Export summary: Export offline API documentation by selected versions description: | - Export of offline API documentation by selected version (all files) as a zip archive. + Export of offline API documentation by selected version (all files) as a zip archive. Type of the documentation file is provided as input parameters: * interactive - html document. operationId: getPackagesIdVersionsIdDoc @@ -6467,7 +6467,7 @@ paths: - Roles summary: Create a new role description: | - Create a new role with the set of available permissions for this role. + Create a new role with the set of available permissions for this role. The role may be assigned to the user for the specific package. @@ -6579,7 +6579,7 @@ paths: - Roles summary: Update role description: | - Change role parameters. + Change role parameters. If the parameter is not transmitted in the request, its value remains unchanged. @@ -6644,7 +6644,7 @@ paths: - Roles summary: Delete role description: | - Delete a role with its permissions. + Delete a role with its permissions. When the role is deleted, all users with that role shall be removed from packages. @@ -6687,7 +6687,7 @@ paths: - Roles summary: Update the roles order description: | - Update the roles order. + Update the roles order. The list of roles will be replaced, all existing roles are required in request (return an error otherwise). operationId: postRolesChangeOrder @@ -7613,7 +7613,7 @@ paths: example: "Billing account" packageIds: description: | - List of Package Id(s). + List of Package Id(s). * If user specified Workspace(s), then Workspace Id(s) must be transmitted. * If user specified Workspace(s) and Group(s), then Group Id(s) must be transmitted. * 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: example: "Billing account" packageIds: description: | - List of Package Id(s). + List of Package Id(s). * If user specified Workspace(s), then Workspace Id(s) must be transmitted. * If user specified Workspace(s) and Group(s), then Group Id(s) must be transmitted. * 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: title: SearchResultPackage description: | Global search result for packages with kind = package; must be returned when searchLevel = package - * If search term matches the package id/name/description/service name, return the latest published version only. + * If search term matches the package id/name/description/service name, return the latest published version only. * If search term matches the version name/label, return that version. type: object required: @@ -8434,7 +8434,7 @@ paths: summary: Create internal user description: | Creation of the internal user, not connected to LDAP or GitLab. - * If the userId already exists, return an error. + * If the userId already exists, return an error. * One email may be connected to several users at one time, no unique constraint. * The password will be stored in an encrypted form locally. operationId: postUsers @@ -8569,7 +8569,7 @@ paths: type: string example: user1221 security: - - BearerAuth: [ ] + - BearerAuth: [] responses: "200": description: Success @@ -8577,21 +8577,21 @@ paths: application/json: schema: $ref: "#/components/schemas/User" - examples: { } + examples: {} "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" - examples: { } + examples: {} "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" - examples: { } + examples: {} "404": description: Not found content: @@ -8711,7 +8711,7 @@ paths: Flag, filtering the operations without tags at all. In response will be returned the list of operations, on what the tag is not filled in. - + This attribute has a higher priority than the **tag**. In case, then **emptyTag: true**, it will override the **tag** filter. schema: type: boolean @@ -8891,7 +8891,7 @@ paths: Flag, filtering the operations without tags at all. In response will be returned the list of operations, on what the tag is not filled in. - + This attribute has a higher priority than the **tag**. In case, then **emptyTag: true**, it will override the **tag** filter. schema: type: boolean @@ -9070,7 +9070,7 @@ paths: Get summary of deprecated operations in the version operationId: getPackageIdVersionDeprecatedSummaryV3 security: - - BearerAuth: [ ] + - BearerAuth: [] parameters: - $ref: "#/components/parameters/packageId" - $ref: "#/components/parameters/version" @@ -9199,8 +9199,8 @@ paths: List of deprecated operations in the current version operationId: getPackagesIdVersionsIdApiTypeDeprecations security: - - BearerAuth: [ ] - - api-key: [ ] + - BearerAuth: [] + - api-key: [] parameters: - $ref: "#/components/parameters/apiType" - $ref: "#/components/parameters/packageId" @@ -9222,7 +9222,7 @@ paths: - name: version in: path description: | - Package version. + Package version. The mask @ may be used for search in a specific revision. required: true schema: @@ -9340,7 +9340,7 @@ paths: deprecatedInfo: description: | Additional information about deprecated operation: - * for REST API it is value of 'x-deprecated-meta' extension (value of extension must be string), which is defined for deprecated operation. + * for REST API it is value of 'x-deprecated-meta' extension (value of extension must be string), which is defined for deprecated operation. * for GraphQL API it is value of 'reason' argument of @deprecated directive, which is defined for deprecated operation. type: string deprecatedItems: @@ -9420,8 +9420,8 @@ paths: Deprecated item is entity that is deprecated inside of API operation. For example for REST API it can be parameter or schema, for GraphQL API - field or enum value. operationId: getPackagesIdVersionsApiTypeOperationsIddeprecatedItems security: - - BearerAuth: [ ] - - api-key: [ ] + - BearerAuth: [] + - api-key: [] parameters: - $ref: "#/components/parameters/apiType" - $ref: "#/components/parameters/packageId" @@ -9481,8 +9481,8 @@ paths: Get list of operations that have the same model operationId: getPackagesIdVersionsApiTypeOperationsIdModelsModelName security: - - BearerAuth: [ ] - - api-key: [ ] + - BearerAuth: [] + - api-key: [] parameters: - $ref: "#/components/parameters/apiType" - $ref: "#/components/parameters/packageId" @@ -9556,8 +9556,8 @@ paths: Export operations of specific API type. operationId: getPackagesIdVersionsIdApiTypeOperationsExport security: - - BearerAuth: [ ] - - api-key: [ ] + - BearerAuth: [] + - api-key: [] parameters: - $ref: "#/components/parameters/apiType" - $ref: "#/components/parameters/packageId" @@ -9670,7 +9670,7 @@ paths: application/json: schema: $ref: "#/components/schemas/ErrorResponse" - examples: { } + examples: {} "500": description: Internal Server Error content: @@ -9689,8 +9689,8 @@ paths: Export operations of specific API type. operationId: getPackagesIdVersionsIdApiTypeOperationsExport security: - - BearerAuth: [ ] - - api-key: [ ] + - BearerAuth: [] + - api-key: [] parameters: - $ref: "#/components/parameters/apiType" - $ref: "#/components/parameters/packageId" @@ -9801,7 +9801,7 @@ paths: application/json: schema: $ref: "#/components/schemas/ErrorResponse" - examples: { } + examples: {} "500": description: Internal Server Error content: @@ -10294,7 +10294,7 @@ paths: Flag, filtering the operations without tags at all. In response will be returned the list of operations, on what the tag is not filled in. - + This attribute has a higher priority than the **tag**. In case, then **emptyTag: true**, it will override the **tag** filter. schema: type: boolean @@ -10486,7 +10486,7 @@ paths: packageId: description: | ID of package.\ - PackageId and version shall be specified in case of dashboard to identify source package. + PackageId and version shall be specified in case of dashboard to identify source package. If packageId and version are not specified, this will mean that the source of the operation is the current package version. type: string example: "QS.CloudQSS.CPQ.Q-TMF" @@ -10748,7 +10748,7 @@ paths: packageId: description: | ID of package.\ - PackageId and version shall be specified in case of dashboard to identify source package. + PackageId and version shall be specified in case of dashboard to identify source package. If packageId and version are not specified, this will mean that the source of the operation is the current package version. type: string example: "QS.CloudQSS.CPQ.Q-TMF" @@ -10876,7 +10876,7 @@ paths: packageId: description: | ID of package.\ - PackageId and version shall be specified in case of dashboard to identify source package. + PackageId and version shall be specified in case of dashboard to identify source package. If packageId and version are not specified, this will mean that the source of the operation is the current package version. type: string example: "QS.CloudQSS.CPQ.Q-TMF" @@ -11138,7 +11138,7 @@ paths: description: | Get list of documents in a version. The result depend on the package.kind: * For package.kind: package - return the list of version documents. - * For package.kind: dashboard - return the list of all referenced dashboards and their referenced packages in recursion. + * For package.kind: dashboard - return the list of all referenced dashboards and their referenced packages in recursion. The returned list will contain only leaves - referenced packages of the lowest level with their published documents. operationId: getPackagesIdVersionsIdDocuments security: @@ -12176,8 +12176,8 @@ paths: Get the list of version revisions. operationId: getPackagesIdVersionsIdRevisions security: - - BearerAuth: [ ] - - api-key: [ ] + - BearerAuth: [] + - api-key: [] parameters: - $ref: "#/components/parameters/packageId" - $ref: "#/components/parameters/version" @@ -12263,7 +12263,7 @@ paths: description: Namespace of Agent's publication. type: string example: cloudQSS-release2 - examples: { } + examples: {} "301": description: Moved Permanently headers: @@ -12290,14 +12290,14 @@ paths: application/json: schema: $ref: "#/components/schemas/ErrorResponse" - examples: { } + examples: {} "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" - examples: { } + examples: {} "404": description: Not found content: @@ -12325,8 +12325,8 @@ paths: Get the list of version revisions. operationId: getPackagesIdVersionsIdRevisionsV3 security: - - BearerAuth: [ ] - - api-key: [ ] + - BearerAuth: [] + - api-key: [] parameters: - $ref: "#/components/parameters/packageId" - $ref: "#/components/parameters/version" @@ -12350,7 +12350,7 @@ paths: type: array items: $ref: "#/components/schemas/PackageVersionRevision" - examples: { } + examples: {} "301": description: Moved Permanently headers: @@ -12377,7 +12377,7 @@ paths: application/json: schema: $ref: "#/components/schemas/ErrorResponse" - examples: { } + examples: {} "404": description: Not found content: @@ -12406,8 +12406,8 @@ paths: description: Recursively delete all expired versions in 'Draft' status under group or workspace operationId: deleteExpiredVersionsRecursively security: - - BearerAuth: [ ] - - api-key: [ ] + - BearerAuth: [] + - api-key: [] requestBody: description: Recursive delete parameters content: @@ -12621,7 +12621,7 @@ paths: summary: Create personal private package for the user description: | Any user is able to create one personal private workspace (*no permissions required*) - + PackageId for this workspace could be set via user creation endpoint (only for new users) or generated automatically when user first logs in to apihub operationId: postUsersIdAvailablePackagePromoteStatuses security: @@ -12686,9 +12686,9 @@ paths: summary: Get list of available package publish statuses for the user. description: | By collection of packages, **get** the available statuses for publish into for the particular user. - + Statuses list depends on the current user access rights for the particular package. - + The response is a **mapped list** of statuses to the packageIds. operationId: getUsersIdAvailablePackagePromoteStatuses security: @@ -12715,7 +12715,7 @@ paths: type: array items: type: string - example: ["QS.CloudQSS.CPQ.Q-TMF","QS.CloudQSS.CPQ.QE-SRV"] + example: ["QS.CloudQSS.CPQ.Q-TMF", "QS.CloudQSS.CPQ.QE-SRV"] required: true responses: "200": @@ -12766,7 +12766,7 @@ paths: description: Allows to send any request to any address. operationId: getAgentsIdNamespacesIdServicesProxy security: - - { } + - {} tags: - TryIt parameters: @@ -13227,7 +13227,7 @@ components: deprecatedInfo: description: | Additional information about single deprecated item: - * for REST API it is value of 'x-deprecated-meta' extension (value of extension must be string), which is defined for deprecated item. + * for REST API it is value of 'x-deprecated-meta' extension (value of extension must be string), which is defined for deprecated item. * for GraphQL API it is value of 'reason' argument of @deprecated directive. type: string tolerantHash: @@ -13369,7 +13369,7 @@ components: type: boolean restGroupingPrefix: description: | - Regular expression used as criteria for grouping operations. + Regular expression used as criteria for grouping operations. Groups for the package version are calculated during publication of this version. type: string example: "/api/v1/{group}/" @@ -14107,7 +14107,7 @@ components: title: SearchResultPackage description: | Global search result for packages with kind = package; must be returned when searchLevel = package - * If search term matches the package id/name/description/service name, return the latest published version only. + * If search term matches the package id/name/description/service name, return the latest published version only. * If search term matches the version name/label, return that version. type: object required: @@ -14614,7 +14614,7 @@ components: BuildResultV2: description: | Result of build operation in ZIP archive. - * The archive contains folders with sources, builded JSON documents and JSON operation files. + * The archive contains folders with sources, builded JSON documents and JSON operation files. * In addition, several config files are provided. he structure of these files is described below. title: BuildResult type: object @@ -14653,7 +14653,7 @@ components: description: | Type of the build process. Available options are: - **build** - Standard build process. + **build** - Standard build process. Consist of contract and operations build and validation, calculation of the changelog, creation of the final version of the published contracts. **changelog** - Only the changelog calculation, no API contracts version will be created. @@ -15099,7 +15099,7 @@ components: BuildResult: description: | Result of build operation in ZIP archive. - * The archive contains folders with sources, builded JSON documents and JSON operation files. + * The archive contains folders with sources, builded JSON documents and JSON operation files. * In addition, several config files are provided. he structure of these files is described below. title: BuildResult type: object @@ -15449,7 +15449,7 @@ components: deprecatedInfo: description: | Additional information about deprecated operation: - * for REST API it is value of 'x-deprecated-meta' extension (value of extension must be string), which is defined for deprecated operation. + * for REST API it is value of 'x-deprecated-meta' extension (value of extension must be string), which is defined for deprecated operation. * for GraphQL API it is value of 'reason' argument of @deprecated directive, which is defined for deprecated operation. type: string deprecatedInPreviousVersions: @@ -15516,9 +15516,9 @@ components: type: array items: anyOf: - - type: string - - type: integer - example: [["components/schemas/Cat/minProperties", "components/schemas/Dog/minProperties"],["/quoteManagement/v5/quote"]] + - type: string + - type: integer + example: [["components/schemas/Cat/minProperties", "components/schemas/Dog/minProperties"], ["/quoteManagement/v5/quote"]] currentValueHash: type: string description: | @@ -15537,9 +15537,9 @@ components: type: array items: anyOf: - - type: string - - type: integer - example: [["components/schemas/Cat/minProperties", "components/schemas/Dog/minProperties"],["/quoteManagement/v5/quote"]] + - type: string + - type: integer + example: [["components/schemas/Cat/minProperties", "components/schemas/Dog/minProperties"], ["/quoteManagement/v5/quote"]] previousValueHash: type: string description: | @@ -15558,9 +15558,9 @@ components: type: array items: anyOf: - - type: string - - type: integer - example: [["components/schemas/Cat/minProperties", "components/schemas/Dog/minProperties"],["/quoteManagement/v5/quote"]] + - type: string + - type: integer + example: [["components/schemas/Cat/minProperties", "components/schemas/Dog/minProperties"], ["/quoteManagement/v5/quote"]] previousDeclarationJsonPaths: description: | (below, a document is not considered to be an original document, but a document with one specific operation)\ @@ -15570,9 +15570,9 @@ components: type: array items: anyOf: - - type: string - - type: integer - example: [["components/schemas/Cat/minProperties", "components/schemas/Dog/minProperties"],["/quoteManagement/v5/quote"]] + - type: string + - type: integer + example: [["components/schemas/Cat/minProperties", "components/schemas/Dog/minProperties"], ["/quoteManagement/v5/quote"]] previousValueHash: type: string description: | @@ -15596,9 +15596,9 @@ components: type: array items: anyOf: - - type: string - - type: integer - example: [["components/schemas/Cat/minProperties", "components/schemas/Dog/minProperties"],["/quoteManagement/v5/quote"]] + - type: string + - type: integer + example: [["components/schemas/Cat/minProperties", "components/schemas/Dog/minProperties"], ["/quoteManagement/v5/quote"]] previousDeclarationJsonPaths: description: | (below, a document is not considered to be an original document, but a document with one specific operation)\ @@ -15608,9 +15608,9 @@ components: type: array items: anyOf: - - type: string - - type: integer - example: [["components/schemas/Cat/minProperties", "components/schemas/Dog/minProperties"],["/quoteManagement/v5/quote"]] + - type: string + - type: integer + example: [["components/schemas/Cat/minProperties", "components/schemas/Dog/minProperties"], ["/quoteManagement/v5/quote"]] previousKey: type: string description: Previous key (name) of the renamed entity. @@ -15620,7 +15620,7 @@ components: BuildConfig: type: object description: | - Configuration of the source files. + Configuration of the source files. Content can not be empty, files or refs are **required**. required: - version @@ -15638,8 +15638,8 @@ components: example: "2022.2" default: "" previousVersionPackageId: - description: | - Required in case of snapshot when publishing version should be compared to different package. + description: | + Required in case of snapshot when publishing version should be compared to different package. Do not set anything if the package sould be compared to itself. Value equals to packageId is forbidden. type: string example: "QS.CloudOSS.PL.MC" @@ -15738,9 +15738,9 @@ components: description: File name. example: "qitmf-v5.11.json" publish: - description: | - Flag, publish the source file or not. - Required for case with external refs when specification is separated into multiple files. + description: | + Flag, publish the source file or not. + Required for case with external refs when specification is separated into multiple files. After dereference in scope of build process the source files(parts) are no longer required. So it's possible to skip publish of such files. type: boolean default: true @@ -15918,7 +15918,7 @@ components: example: template123.json BuildTypes: type: string - description: | + description: | Type of the build process. Available options are:\ **build** - Standard build process to publish new version. Consist of contract and operations build and validation, calculation of the changelog, creation of the final version of the published contracts.\ **changelog** - Only the changelog calculation, no API contracts version will be created. The ```files``` and ```refs``` objects are not required in this case.\ @@ -16077,4 +16077,4 @@ components: BasicAuth: type: http description: Login/password authentication. - scheme: basic \ No newline at end of file + scheme: basic diff --git a/test/projects/apihub/Swagger 2.0.yaml b/test/projects/apihub/Swagger 2.0.yaml index f0d299f..a3cda55 100644 --- a/test/projects/apihub/Swagger 2.0.yaml +++ b/test/projects/apihub/Swagger 2.0.yaml @@ -702,7 +702,7 @@ definitions: anyOf: - $ref: '#/definitions/schema' - type: boolean - default: { } + default: {} type: anyOf: - $ref: '#/definitions/Schema_SimpleTypes' @@ -718,7 +718,7 @@ definitions: minItems: 1 items: $ref: '#/definitions/schema' - default: { } + default: {} allOf: type: array minItems: 1 @@ -728,7 +728,7 @@ definitions: type: object additionalProperties: $ref: '#/definitions/schema' - default: { } + default: {} discriminator: type: string readOnly: @@ -738,7 +738,7 @@ definitions: $ref: '#/definitions/xml' externalDocs: $ref: '#/definitions/externalDocs' - example: { } + example: {} additionalProperties: false fileSchema: type: object @@ -768,7 +768,7 @@ definitions: default: false externalDocs: $ref: '#/definitions/externalDocs' - example: { } + example: {} additionalProperties: false primitivesItems: type: object @@ -1070,7 +1070,7 @@ definitions: type: string description: type: string - default: { } + default: {} multipleOf: type: number minimum: 0 diff --git a/test/projects/apihub/docs/API-HUB_09.03.22.yaml b/test/projects/apihub/docs/API-HUB_09.03.22.yaml index 59b4681..ce899e9 100644 --- a/test/projects/apihub/docs/API-HUB_09.03.22.yaml +++ b/test/projects/apihub/docs/API-HUB_09.03.22.yaml @@ -2,7 +2,7 @@ openapi: 3.1.0 info: title: APIHUB BE API contract description: > - The API contract for APIHUB UI and APIDOC UI. + The API contract for APIHUB UI and APIDOC UI. You can find more information about the project at [DOC page](url: https://qubership.org/APIHUB). @@ -1503,7 +1503,7 @@ paths: - Export summary: Export offline API documentation by selected file description: | - Export of offline API documentation by selected file as a zip archive. + Export of offline API documentation by selected file as a zip archive. Type of the documentation file is provided as input parameters: - STATIC/INTERACTIVE - html document. - PDF - pdf document. @@ -1568,7 +1568,7 @@ paths: - Export summary: Export offline API documentation by whole version description: | - Export of offline API documentation as a zip archive. + Export of offline API documentation as a zip archive. Type of the documentation file is provided as input parameters: - STATIC/INTERACTIVE - html document. - PDF - pdf document. @@ -3024,4 +3024,4 @@ components: $ref: "#/components/schemas/ErrorResponse" security: - BearerAuth: [] - - api-key: [] \ No newline at end of file + - api-key: [] diff --git a/test/projects/broken/OpenApi 3.0-2.yaml b/test/projects/broken/OpenApi 3.0-2.yaml index 105b80d..abc40a1 100644 --- a/test/projects/broken/OpenApi 3.0-2.yaml +++ b/test/projects/broken/OpenApi 3.0-2.yaml @@ -35,7 +35,7 @@ properties: components: $ref: '#/definitions/Components' patternProperties: - ^x-: { } + ^x-: {} additionalProperties: false definitions: Reference: @@ -66,7 +66,7 @@ definitions: version: type: string patternProperties: - ^x-: { } + ^x-: {} additionalProperties: false Contact: type: object @@ -80,7 +80,7 @@ definitions: type: string format: email patternProperties: - ^x-: { } + ^x-: {} additionalProperties: false License: type: object @@ -93,7 +93,7 @@ definitions: type: string format: uri-reference patternProperties: - ^x-: { } + ^x-: {} additionalProperties: false Server: type: object @@ -109,7 +109,7 @@ definitions: additionalProperties: $ref: '#/definitions/ServerVariable' patternProperties: - ^x-: { } + ^x-: {} additionalProperties: false ServerVariable: type: object @@ -125,7 +125,7 @@ definitions: description: type: string patternProperties: - ^x-: { } + ^x-: {} additionalProperties: false Components: type: object @@ -203,7 +203,7 @@ definitions: - $ref: '#/definitions/Reference' - $ref: '#/definitions/Callback' patternProperties: - ^x-: { } + ^x-: {} additionalProperties: false Schema: type: object @@ -259,7 +259,7 @@ definitions: uniqueItems: true enum: type: array - items: { } + items: {} minItems: 1 uniqueItems: false type: @@ -313,7 +313,7 @@ definitions: type: string format: type: string - default: { } + default: {} nullable: type: boolean default: false @@ -325,7 +325,7 @@ definitions: writeOnly: type: boolean default: false - example: { } + example: {} externalDocs: $ref: '#/definitions/ExternalDocumentation' deprecated: @@ -334,7 +334,7 @@ definitions: xml: $ref: '#/definitions/XML' patternProperties: - ^x-: { } + ^x-: {} additionalProperties: false Discriminator: type: object @@ -364,7 +364,7 @@ definitions: type: boolean default: false patternProperties: - ^x-: { } + ^x-: {} additionalProperties: false Response: type: object @@ -390,7 +390,7 @@ definitions: - $ref: '#/definitions/Link' - $ref: '#/definitions/Reference' patternProperties: - ^x-: { } + ^x-: {} additionalProperties: false MediaType: type: object @@ -399,7 +399,7 @@ definitions: oneOf: - $ref: '#/definitions/Schema' - $ref: '#/definitions/Reference' - example: { } + example: {} examples: type: object additionalProperties: @@ -411,7 +411,7 @@ definitions: additionalProperties: $ref: '#/definitions/Encoding' patternProperties: - ^x-: { } + ^x-: {} additionalProperties: false allOf: - $ref: '#/definitions/ExampleXORExamples' @@ -422,12 +422,12 @@ definitions: type: string description: type: string - value: { } + value: {} externalValue: type: string format: uri-reference patternProperties: - ^x-: { } + ^x-: {} additionalProperties: false Header: type: object @@ -463,7 +463,7 @@ definitions: $ref: '#/definitions/MediaType' minProperties: 1 maxProperties: 1 - example: { } + example: {} examples: type: object additionalProperties: @@ -471,7 +471,7 @@ definitions: - $ref: '#/definitions/Example' - $ref: '#/definitions/Reference' patternProperties: - ^x-: { } + ^x-: {} additionalProperties: false allOf: - $ref: '#/definitions/ExampleXORExamples' @@ -481,7 +481,7 @@ definitions: patternProperties: ^\/: $ref: '#/definitions/PathItem' - ^x-: { } + ^x-: {} additionalProperties: false PathItem: type: object @@ -506,7 +506,7 @@ definitions: patternProperties: ^(get|put|post|delete|options|head|patch|trace)$: $ref: '#/definitions/Operation' - ^x-: { } + ^x-: {} additionalProperties: false Operation: type: object @@ -556,7 +556,7 @@ definitions: items: $ref: '#/definitions/Server' patternProperties: - ^x-: { } + ^x-: {} additionalProperties: false Responses: type: object @@ -574,7 +574,7 @@ definitions: oneOf: - $ref: '#/definitions/Response' - $ref: '#/definitions/Reference' - ^x-: { } + ^x-: {} minProperties: 1 additionalProperties: false SecurityRequirement: @@ -595,7 +595,7 @@ definitions: externalDocs: $ref: '#/definitions/ExternalDocumentation' patternProperties: - ^x-: { } + ^x-: {} additionalProperties: false ExternalDocumentation: type: object @@ -608,7 +608,7 @@ definitions: type: string format: uri-reference patternProperties: - ^x-: { } + ^x-: {} additionalProperties: false ExampleXORExamples: description: Example and examples are mutually exclusive @@ -679,7 +679,7 @@ definitions: $ref: '#/definitions/MediaType' minProperties: 1 maxProperties: 1 - example: { } + example: {} examples: type: object additionalProperties: @@ -687,7 +687,7 @@ definitions: - $ref: '#/definitions/Example' - $ref: '#/definitions/Reference' patternProperties: - ^x-: { } + ^x-: {} additionalProperties: false required: - name @@ -760,7 +760,7 @@ definitions: type: boolean default: false patternProperties: - ^x-: { } + ^x-: {} additionalProperties: false SecurityScheme: oneOf: @@ -790,7 +790,7 @@ definitions: description: type: string patternProperties: - ^x-: { } + ^x-: {} additionalProperties: false HTTPSecurityScheme: type: object @@ -809,7 +809,7 @@ definitions: enum: - http patternProperties: - ^x-: { } + ^x-: {} additionalProperties: false oneOf: - description: Bearer @@ -853,7 +853,7 @@ definitions: description: type: string patternProperties: - ^x-: { } + ^x-: {} additionalProperties: false OpenIdConnectSecurityScheme: type: object @@ -871,7 +871,7 @@ definitions: description: type: string patternProperties: - ^x-: { } + ^x-: {} additionalProperties: false OAuthFlows: type: object @@ -885,7 +885,7 @@ definitions: authorizationCode: $ref: '#/definitions/AuthorizationCodeOAuthFlow' patternProperties: - ^x-: { } + ^x-: {} additionalProperties: false ImplicitOAuthFlow: type: object @@ -904,7 +904,7 @@ definitions: additionalProperties: type: string patternProperties: - ^x-: { } + ^x-: {} additionalProperties: false PasswordOAuthFlow: type: object @@ -923,7 +923,7 @@ definitions: additionalProperties: type: string patternProperties: - ^x-: { } + ^x-: {} additionalProperties: false ClientCredentialsFlow: type: object @@ -942,7 +942,7 @@ definitions: additionalProperties: type: string patternProperties: - ^x-: { } + ^x-: {} additionalProperties: false AuthorizationCodeOAuthFlow: type: object @@ -965,7 +965,7 @@ definitions: additionalProperties: type: string patternProperties: - ^x-: { } + ^x-: {} additionalProperties: false Link: type: object @@ -977,14 +977,14 @@ definitions: format: uri-reference parameters: type: object - additionalProperties: { } - requestBody: { } + additionalProperties: {} + requestBody: {} description: type: string server: $ref: '#/definitions/Server' patternProperties: - ^x-: { } + ^x-: {} additionalProperties: false not: description: Operation Id and Operation Ref are mutually exclusive @@ -996,7 +996,7 @@ definitions: additionalProperties: $ref: '#/definitions/PathItem' patternProperties: - ^x-: { } + ^x-: {} Encoding: type: object properties: diff --git a/test/projects/broken/OpenApi 3.0.yaml b/test/projects/broken/OpenApi 3.0.yaml index d09a7b5..3343ec0 100644 --- a/test/projects/broken/OpenApi 3.0.yaml +++ b/test/projects/broken/OpenApi 3.0.yaml @@ -33,7 +33,7 @@ properties: components: $ref: '#/definitions/Components' patternProperties: - ^x-: { } + ^x-: {} additionalProperties: false definitions: Reference: @@ -64,7 +64,7 @@ definitions: version: type: string patternProperties: - ^x-: { } + ^x-: {} additionalProperties: false Contact: type: object @@ -78,7 +78,7 @@ definitions: type: string format: email patternProperties: - ^x-: { } + ^x-: {} additionalProperties: false License: type: object @@ -91,7 +91,7 @@ definitions: type: string format: uri-reference patternProperties: - ^x-: { } + ^x-: {} additionalProperties: false Server: type: object @@ -107,7 +107,7 @@ definitions: additionalProperties: $ref: '#/definitions/ServerVariable' patternProperties: - ^x-: { } + ^x-: {} additionalProperties: false ServerVariable: type: object @@ -123,7 +123,7 @@ definitions: description: type: string patternProperties: - ^x-: { } + ^x-: {} additionalProperties: false Components: type: object @@ -201,7 +201,7 @@ definitions: - $ref: '#/definitions/Reference' - $ref: '#/definitions/Callback' patternProperties: - ^x-: { } + ^x-: {} additionalProperties: false Schema: type: object @@ -257,7 +257,7 @@ definitions: uniqueItems: true enum: type: array - items: { } + items: {} minItems: 1 uniqueItems: false type: @@ -311,7 +311,7 @@ definitions: type: string format: type: string - default: { } + default: {} nullable: type: boolean default: false @@ -323,7 +323,7 @@ definitions: writeOnly: type: boolean default: false - example: { } + example: {} externalDocs: $ref: '#/definitions/ExternalDocumentation' deprecated: @@ -332,7 +332,7 @@ definitions: xml: $ref: '#/definitions/XML' patternProperties: - ^x-: { } + ^x-: {} additionalProperties: false Discriminator: type: object @@ -362,7 +362,7 @@ definitions: type: boolean default: false patternProperties: - ^x-: { } + ^x-: {} additionalProperties: false Response: type: object @@ -388,7 +388,7 @@ definitions: - $ref: '#/definitions/Link' - $ref: '#/definitions/Reference' patternProperties: - ^x-: { } + ^x-: {} additionalProperties: false MediaType: type: object @@ -397,7 +397,7 @@ definitions: oneOf: - $ref: '#/definitions/Schema' - $ref: '#/definitions/Reference' - example: { } + example: {} examples: type: object additionalProperties: @@ -409,7 +409,7 @@ definitions: additionalProperties: $ref: '#/definitions/Encoding' patternProperties: - ^x-: { } + ^x-: {} additionalProperties: false allOf: - $ref: '#/definitions/ExampleXORExamples' @@ -420,12 +420,12 @@ definitions: type: string description: type: string - value: { } + value: {} externalValue: type: string format: uri-reference patternProperties: - ^x-: { } + ^x-: {} additionalProperties: false Header: type: object @@ -461,7 +461,7 @@ definitions: $ref: '#/definitions/MediaType' minProperties: 1 maxProperties: 1 - example: { } + example: {} examples: type: object additionalProperties: @@ -469,7 +469,7 @@ definitions: - $ref: '#/definitions/Example' - $ref: '#/definitions/Reference' patternProperties: - ^x-: { } + ^x-: {} additionalProperties: false allOf: - $ref: '#/definitions/ExampleXORExamples' @@ -479,7 +479,7 @@ definitions: patternProperties: ^\/: $ref: '#/definitions/PathItem' - ^x-: { } + ^x-: {} additionalProperties: false PathItem: type: object @@ -504,7 +504,7 @@ definitions: patternProperties: ^(get|put|post|delete|options|head|patch|trace)$: $ref: '#/definitions/Operation' - ^x-: { } + ^x-: {} additionalProperties: false Operation: type: object @@ -554,7 +554,7 @@ definitions: items: $ref: '#/definitions/Server' patternProperties: - ^x-: { } + ^x-: {} additionalProperties: false Responses: type: object @@ -572,7 +572,7 @@ definitions: oneOf: - $ref: '#/definitions/Response' - $ref: '#/definitions/Reference' - ^x-: { } + ^x-: {} minProperties: 1 additionalProperties: false SecurityRequirement: @@ -593,7 +593,7 @@ definitions: externalDocs: $ref: '#/definitions/ExternalDocumentation' patternProperties: - ^x-: { } + ^x-: {} additionalProperties: false ExternalDocumentation: type: object @@ -606,7 +606,7 @@ definitions: type: string format: uri-reference patternProperties: - ^x-: { } + ^x-: {} additionalProperties: false ExampleXORExamples: description: Example and examples are mutually exclusive @@ -677,7 +677,7 @@ definitions: $ref: '#/definitions/MediaType' minProperties: 1 maxProperties: 1 - example: { } + example: {} examples: type: object additionalProperties: @@ -685,7 +685,7 @@ definitions: - $ref: '#/definitions/Example' - $ref: '#/definitions/Reference' patternProperties: - ^x-: { } + ^x-: {} additionalProperties: false required: - name @@ -758,7 +758,7 @@ definitions: type: boolean default: false patternProperties: - ^x-: { } + ^x-: {} additionalProperties: false SecurityScheme: oneOf: @@ -788,7 +788,7 @@ definitions: description: type: string patternProperties: - ^x-: { } + ^x-: {} additionalProperties: false HTTPSecurityScheme: type: object @@ -807,7 +807,7 @@ definitions: enum: - http patternProperties: - ^x-: { } + ^x-: {} additionalProperties: false oneOf: - description: Bearer @@ -851,7 +851,7 @@ definitions: description: type: string patternProperties: - ^x-: { } + ^x-: {} additionalProperties: false OpenIdConnectSecurityScheme: type: object @@ -869,7 +869,7 @@ definitions: description: type: string patternProperties: - ^x-: { } + ^x-: {} additionalProperties: false OAuthFlows: type: object @@ -883,7 +883,7 @@ definitions: authorizationCode: $ref: '#/definitions/AuthorizationCodeOAuthFlow' patternProperties: - ^x-: { } + ^x-: {} additionalProperties: false ImplicitOAuthFlow: type: object @@ -902,7 +902,7 @@ definitions: additionalProperties: type: string patternProperties: - ^x-: { } + ^x-: {} additionalProperties: false PasswordOAuthFlow: type: object @@ -921,7 +921,7 @@ definitions: additionalProperties: type: string patternProperties: - ^x-: { } + ^x-: {} additionalProperties: false ClientCredentialsFlow: type: object @@ -940,7 +940,7 @@ definitions: additionalProperties: type: string patternProperties: - ^x-: { } + ^x-: {} additionalProperties: false AuthorizationCodeOAuthFlow: type: object @@ -963,7 +963,7 @@ definitions: additionalProperties: type: string patternProperties: - ^x-: { } + ^x-: {} additionalProperties: false Link: type: object @@ -975,14 +975,14 @@ definitions: format: uri-reference parameters: type: object - additionalProperties: { } - requestBody: { } + additionalProperties: {} + requestBody: {} description: type: string server: $ref: '#/definitions/Server' patternProperties: - ^x-: { } + ^x-: {} additionalProperties: false not: description: Operation Id and Operation Ref are mutually exclusive @@ -994,7 +994,7 @@ definitions: additionalProperties: $ref: '#/definitions/PathItem' patternProperties: - ^x-: { } + ^x-: {} Encoding: type: object properties: diff --git a/test/projects/broken/Swagger 2.0.yaml b/test/projects/broken/Swagger 2.0.yaml index 57ebcae..ea8fda8 100644 --- a/test/projects/broken/Swagger 2.0.yaml +++ b/test/projects/broken/Swagger 2.0.yaml @@ -702,7 +702,7 @@ definitions: anyOf: - $ref: '#/definitions/schema' - type: boolean - default: { } + default: {} type: anyOf: - $ref: '#/definitions/Schema_SimpleTypes' @@ -718,7 +718,7 @@ definitions: minItems: 1 items: $ref: '#/definitions/schema' - default: { } + default: {} allOf: type: array minItems: 1 @@ -728,7 +728,7 @@ definitions: type: object additionalProperties: $ref: '#/definitions/schema' - default: { } + default: {} discriminator: type: string readOnly: @@ -738,7 +738,7 @@ definitions: $ref: '#/definitions/xml' externalDocs: $ref: '#/definitions/externalDocs' - example: { } + example: {} additionalProperties: false fileSchema: type: object @@ -768,7 +768,7 @@ definitions: default: false externalDocs: $ref: '#/definitions/externalDocs' - example: { } + example: {} additionalProperties: false primitivesItems: type: object @@ -1070,7 +1070,7 @@ definitions: type: string description: type: string - default: { } + default: {} multipleOf: type: number minimum: 0 diff --git a/test/projects/bugs/OpenApi 3.1.yaml b/test/projects/bugs/OpenApi 3.1.yaml index abcc516..7e87000 100644 --- a/test/projects/bugs/OpenApi 3.1.yaml +++ b/test/projects/bugs/OpenApi 3.1.yaml @@ -939,4 +939,4 @@ definitions: map-of-strings: type: object additionalProperties: - type: string \ No newline at end of file + type: string diff --git a/test/projects/bugs/PetStore-v2 (2023.1).yaml b/test/projects/bugs/PetStore-v2 (2023.1).yaml index d5598c8..3a13247 100644 --- a/test/projects/bugs/PetStore-v2 (2023.1).yaml +++ b/test/projects/bugs/PetStore-v2 (2023.1).yaml @@ -3,7 +3,7 @@ info: title: Swagger Petstore - OpenAPI 3.0 x-api-kind: no-BWC description: >- - This is a sample Pet Store Server based on the OpenAPI 3.0 specification. + This is a sample Pet Store Server based on the OpenAPI 3.0 specification. You can find out more about Swagger at [https://swagger.io](https://swagger.io). In the third iteration diff --git a/test/projects/bugs/PetStore-v2 (2023.2).yaml b/test/projects/bugs/PetStore-v2 (2023.2).yaml index d9233b1..390904f 100644 --- a/test/projects/bugs/PetStore-v2 (2023.2).yaml +++ b/test/projects/bugs/PetStore-v2 (2023.2).yaml @@ -2,7 +2,7 @@ openapi: 3.0.3 info: title: Swagger Petstore - OpenAPI 3.0 description: >- - This is a sample Pet Store Server based on the OpenAPI 3.0 specification. + This is a sample Pet Store Server based on the OpenAPI 3.0 specification. You can find out more about Swagger at [https://swagger.io](https://swagger.io). In the third iteration diff --git a/test/projects/bugs/delete-unused-components.yaml b/test/projects/bugs/delete-unused-components.yaml index b8a130f..a677f48 100644 --- a/test/projects/bugs/delete-unused-components.yaml +++ b/test/projects/bugs/delete-unused-components.yaml @@ -1,4 +1,8 @@ openapi: "3.0.0" +info: + title: Sample API + description: API specification example + version: 1.0.0 paths: /path1: parameters: @@ -60,4 +64,3 @@ components: description: usedHeader unusedHeader: description: unusedHeader - \ No newline at end of file diff --git a/test/projects/bugs/ref-in-invalid-spec.yaml b/test/projects/bugs/ref-in-invalid-spec.yaml index 8f7fd79..962be07 100644 --- a/test/projects/bugs/ref-in-invalid-spec.yaml +++ b/test/projects/bugs/ref-in-invalid-spec.yaml @@ -1,4 +1,8 @@ openapi: "3.0.0" +info: + title: Sample API + description: API specification example + version: 1.0.0 paths: /path1: get: diff --git a/test/projects/bugs/ref-to-nested-schema.yaml b/test/projects/bugs/ref-to-nested-schema.yaml index c1186a8..1048a98 100644 --- a/test/projects/bugs/ref-to-nested-schema.yaml +++ b/test/projects/bugs/ref-to-nested-schema.yaml @@ -1,4 +1,8 @@ openapi: "3.0.0" +info: + title: Sample API + description: API specification example + version: 1.0.0 paths: /path1: get: diff --git a/test/projects/bugs/schemas-with-the-same-name.yaml b/test/projects/bugs/schemas-with-the-same-name.yaml index 91d5830..e596bdf 100644 --- a/test/projects/bugs/schemas-with-the-same-name.yaml +++ b/test/projects/bugs/schemas-with-the-same-name.yaml @@ -1,4 +1,8 @@ openapi: "3.0.0" +info: + title: Sample API + description: API specification example + version: 1.0.0 paths: /path1: get: diff --git a/test/projects/bugs/search-scope-v1.yaml b/test/projects/bugs/search-scope-v1.yaml index 9c6179a..ea233aa 100644 --- a/test/projects/bugs/search-scope-v1.yaml +++ b/test/projects/bugs/search-scope-v1.yaml @@ -18,7 +18,7 @@ paths: prop1: type: object description: prop1 description - prop2: + prop2: $ref: '#/components/schemas/componentProp2' components: schemas: diff --git a/test/projects/bugs/search-scope-v2.yaml b/test/projects/bugs/search-scope-v2.yaml index fcee723..56531f7 100644 --- a/test/projects/bugs/search-scope-v2.yaml +++ b/test/projects/bugs/search-scope-v2.yaml @@ -1,4 +1,8 @@ openapi: "3.0.0" +info: + title: Sample API + description: API specification example + version: 1.0.0 paths: /path1: get: @@ -14,7 +18,7 @@ paths: prop1: type: object description: prop1 description - prop2: + prop2: $ref: '#/components/schemas/componentProp2' components: schemas: diff --git a/test/projects/changelog/CL-27.1_openapi.yaml b/test/projects/changelog/CL-27.1_openapi.yaml index e7ee548..2ea75ee 100644 --- a/test/projects/changelog/CL-27.1_openapi.yaml +++ b/test/projects/changelog/CL-27.1_openapi.yaml @@ -80,7 +80,7 @@ paths: '405': description: Validation exception security: - - { } + - {} /pet/{petId}: get: tags: diff --git a/test/projects/changelog/CL-27.2_openapi.yaml b/test/projects/changelog/CL-27.2_openapi.yaml index b72d5b3..5728689 100644 --- a/test/projects/changelog/CL-27.2_openapi.yaml +++ b/test/projects/changelog/CL-27.2_openapi.yaml @@ -81,7 +81,7 @@ paths: '405': description: Validation exception security: - - { } + - {} - petstore_auth: - 'write:pets' - 'read:pets' diff --git a/test/projects/changes_test_after/test-api.after.yaml b/test/projects/changes_test_after/test-api.after.yaml index 1f707e4..2266b20 100644 --- a/test/projects/changes_test_after/test-api.after.yaml +++ b/test/projects/changes_test_after/test-api.after.yaml @@ -3,7 +3,7 @@ info: title: My Test API description: My Test API description version: "1.1" - contact: { } + contact: {} license: name: Apache 2.0 url: http://www.apache.org/licenses/LICENSE-2.0 @@ -438,4 +438,4 @@ components: schema: $ref: "#/components/responses/error_400/content/application~1json/schema" security: - - openId: [ ] + - openId: [] diff --git a/test/projects/changes_test_before/test-api.before.yaml b/test/projects/changes_test_before/test-api.before.yaml index 288c82c..c7caee9 100644 --- a/test/projects/changes_test_before/test-api.before.yaml +++ b/test/projects/changes_test_before/test-api.before.yaml @@ -3,7 +3,7 @@ info: title: My Test API description: My Test API description version: "1.1" - contact: { } + contact: {} license: name: Apache 2.0 url: http://www.apache.org/licenses/LICENSE-2.0 @@ -516,4 +516,4 @@ components: schema: $ref: "#/components/responses/error_400/content/application~1json/schema" security: - - openId: [ ] + - openId: [] diff --git a/test/projects/deprecated-item-description/deprecated-schema.yaml b/test/projects/deprecated-item-description/deprecated-schema.yaml index 1d129d4..45ee17f 100644 --- a/test/projects/deprecated-item-description/deprecated-schema.yaml +++ b/test/projects/deprecated-item-description/deprecated-schema.yaml @@ -39,7 +39,7 @@ paths: type: string deprecated: true # [Deprecated] schema in response '200' (application/json) - examples: { } + examples: {} requestBody: content: @@ -50,7 +50,7 @@ paths: post: requestBody: $ref: '#/components/requestBodies/RequestBody' - responses: { } + responses: {} components: schemas: diff --git a/test/projects/deprecated/PublicRegistry API(4).yaml b/test/projects/deprecated/PublicRegistry API(4).yaml index 0c9939d..5348bd2 100644 --- a/test/projects/deprecated/PublicRegistry API(4).yaml +++ b/test/projects/deprecated/PublicRegistry API(4).yaml @@ -67,12 +67,12 @@ paths: deprecated: true description: | Starts the SAML authentication process in APIHUB. - - In case of successful authentication, the request will be redirected to the **redirectUri** and + + In case of successful authentication, the request will be redirected to the **redirectUri** and the response will contain cookie with access token for future API calls. All subsequent APIHUB calls must use this token in a **BearerAuth** authentication. operationId: postAuthSAML - security: [ { } ] + security: [{}] parameters: - name: redirectUri in: query @@ -122,7 +122,7 @@ paths: application/json: schema: $ref: "#/components/schemas/PackageCreate" - examples: { } + examples: {} required: true responses: "201": @@ -139,7 +139,7 @@ paths: type: array items: $ref: "#/components/schemas/PackageList" - examples: { } + examples: {} "400": description: Bad request content: @@ -155,14 +155,14 @@ paths: application/json: schema: $ref: "#/components/schemas/ErrorResponse" - examples: { } + examples: {} "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" - examples: { } + examples: {} "500": description: Internal Server Error content: @@ -189,9 +189,9 @@ paths: in: query description: | Filter the packages by kind. - + The list of values is acceptable. In this case, the following pattern will be used: ```?kind=group,package,dashboard```. - + If not transmitted, the default value will be used. schema: type: array @@ -208,7 +208,7 @@ paths: in: query description: | Show all the descendants to the parent workspace or group. - + * If ```true```, return the list of all child groups/packages/dashboards to the parentId (take into account all other filter parameters). * If the parentId is not transmitted??? * If the parent is transmitted, but kind not - and parentId = package??? @@ -292,7 +292,7 @@ paths: default: false summary: $ref: "#/components/schemas/ChangeSummary" - examples: { } + examples: {} "400": description: Bad request content: @@ -308,7 +308,7 @@ paths: application/json: schema: $ref: "#/components/schemas/ErrorResponse" - examples: { } + examples: {} "500": description: Internal Server Error content: @@ -547,7 +547,7 @@ components: deprecatedInfo: description: | Additional information about single deprecated item: - * for REST API it is value of 'x-deprecated-meta' extension (value of extension must be string), which is defined for deprecated item. + * for REST API it is value of 'x-deprecated-meta' extension (value of extension must be string), which is defined for deprecated item. * for GraphQL API it is value of 'reason' argument of @deprecated directive. type: string tolerantHash: @@ -689,7 +689,7 @@ components: type: boolean restGroupingPrefix: description: | - Regular expression used as criteria for grouping operations. + Regular expression used as criteria for grouping operations. Groups for the package version are calculated during publication of this version. type: string example: "/api/v1/{group}/" @@ -1427,7 +1427,7 @@ components: title: SearchResultPackage description: | Global search result for packages with kind = package; must be returned when searchLevel = package - * If search term matches the package id/name/description/service name, return the latest published version only. + * If search term matches the package id/name/description/service name, return the latest published version only. * If search term matches the version name/label, return that version. type: object required: @@ -1934,7 +1934,7 @@ components: BuildResultV2: description: | Result of build operation in ZIP archive. - * The archive contains folders with sources, builded JSON documents and JSON operation files. + * The archive contains folders with sources, builded JSON documents and JSON operation files. * In addition, several config files are provided. he structure of these files is described below. title: BuildResult type: object @@ -1973,7 +1973,7 @@ components: description: | Type of the build process. Available options are: - **build** - Standard build process. + **build** - Standard build process. Consist of contract and operations build and validation, calculation of the changelog, creation of the final version of the published contracts. **changelog** - Only the changelog calculation, no API contracts version will be created. @@ -2419,7 +2419,7 @@ components: BuildResult: description: | Result of build operation in ZIP archive. - * The archive contains folders with sources, builded JSON documents and JSON operation files. + * The archive contains folders with sources, builded JSON documents and JSON operation files. * In addition, several config files are provided. he structure of these files is described below. title: BuildResult type: object @@ -2769,7 +2769,7 @@ components: deprecatedInfo: description: | Additional information about deprecated operation: - * for REST API it is value of 'x-deprecated-meta' extension (value of extension must be string), which is defined for deprecated operation. + * for REST API it is value of 'x-deprecated-meta' extension (value of extension must be string), which is defined for deprecated operation. * for GraphQL API it is value of 'reason' argument of @deprecated directive, which is defined for deprecated operation. type: string deprecatedInPreviousVersions: @@ -2836,9 +2836,9 @@ components: type: array items: anyOf: - - type: string - - type: integer - example: [["components/schemas/Cat/minProperties", "components/schemas/Dog/minProperties"],["/quoteManagement/v5/quote"]] + - type: string + - type: integer + example: [["components/schemas/Cat/minProperties", "components/schemas/Dog/minProperties"], ["/quoteManagement/v5/quote"]] currentValueHash: type: string description: | @@ -2857,9 +2857,9 @@ components: type: array items: anyOf: - - type: string - - type: integer - example: [["components/schemas/Cat/minProperties", "components/schemas/Dog/minProperties"],["/quoteManagement/v5/quote"]] + - type: string + - type: integer + example: [["components/schemas/Cat/minProperties", "components/schemas/Dog/minProperties"], ["/quoteManagement/v5/quote"]] previousValueHash: type: string description: | @@ -2878,9 +2878,9 @@ components: type: array items: anyOf: - - type: string - - type: integer - example: [["components/schemas/Cat/minProperties", "components/schemas/Dog/minProperties"],["/quoteManagement/v5/quote"]] + - type: string + - type: integer + example: [["components/schemas/Cat/minProperties", "components/schemas/Dog/minProperties"], ["/quoteManagement/v5/quote"]] previousDeclarationJsonPaths: description: | (below, a document is not considered to be an original document, but a document with one specific operation)\ @@ -2890,9 +2890,9 @@ components: type: array items: anyOf: - - type: string - - type: integer - example: [["components/schemas/Cat/minProperties", "components/schemas/Dog/minProperties"],["/quoteManagement/v5/quote"]] + - type: string + - type: integer + example: [["components/schemas/Cat/minProperties", "components/schemas/Dog/minProperties"], ["/quoteManagement/v5/quote"]] previousValueHash: type: string description: | @@ -2916,9 +2916,9 @@ components: type: array items: anyOf: - - type: string - - type: integer - example: [["components/schemas/Cat/minProperties", "components/schemas/Dog/minProperties"],["/quoteManagement/v5/quote"]] + - type: string + - type: integer + example: [["components/schemas/Cat/minProperties", "components/schemas/Dog/minProperties"], ["/quoteManagement/v5/quote"]] previousDeclarationJsonPaths: description: | (below, a document is not considered to be an original document, but a document with one specific operation)\ @@ -2928,9 +2928,9 @@ components: type: array items: anyOf: - - type: string - - type: integer - example: [["components/schemas/Cat/minProperties", "components/schemas/Dog/minProperties"],["/quoteManagement/v5/quote"]] + - type: string + - type: integer + example: [["components/schemas/Cat/minProperties", "components/schemas/Dog/minProperties"], ["/quoteManagement/v5/quote"]] previousKey: type: string description: Previous key (name) of the renamed entity. @@ -2940,7 +2940,7 @@ components: BuildConfig: type: object description: | - Configuration of the source files. + Configuration of the source files. Content can not be empty, files or refs are **required**. required: - version @@ -2958,8 +2958,8 @@ components: example: "2022.2" default: "" previousVersionPackageId: - description: | - Required in case of snapshot when publishing version should be compared to different package. + description: | + Required in case of snapshot when publishing version should be compared to different package. Do not set anything if the package sould be compared to itself. Value equals to packageId is forbidden. type: string example: "QS.CloudOSS.PL.MC" @@ -3058,9 +3058,9 @@ components: description: File name. example: "qitmf-v5.11.json" publish: - description: | - Flag, publish the source file or not. - Required for case with external refs when specification is separated into multiple files. + description: | + Flag, publish the source file or not. + Required for case with external refs when specification is separated into multiple files. After dereference in scope of build process the source files(parts) are no longer required. So it's possible to skip publish of such files. type: boolean default: true @@ -3238,7 +3238,7 @@ components: example: template123.json BuildTypes: type: string - description: | + description: | Type of the build process. Available options are:\ **build** - Standard build process to publish new version. Consist of contract and operations build and validation, calculation of the changelog, creation of the final version of the published contracts.\ **changelog** - Only the changelog calculation, no API contracts version will be created. The ```files``` and ```refs``` objects are not required in this case.\ @@ -3397,4 +3397,4 @@ components: BasicAuth: type: http description: Login/password authentication. - scheme: basic \ No newline at end of file + scheme: basic diff --git a/test/projects/deprecated/PublicRegistry API(4)v2.yaml b/test/projects/deprecated/PublicRegistry API(4)v2.yaml index c2a8e4b..2b120c6 100644 --- a/test/projects/deprecated/PublicRegistry API(4)v2.yaml +++ b/test/projects/deprecated/PublicRegistry API(4)v2.yaml @@ -67,12 +67,12 @@ paths: deprecated: true description: | Starts the SAML authentication process in APIHUB. - - In case of successful authentication, the request will be redirected to the **redirectUri** and + + In case of successful authentication, the request will be redirected to the **redirectUri** and the response will contain cookie with access token for future API calls. All subsequent APIHUB calls must use this token in a **BearerAuth** authentication. operationId: postAuthSAML - security: [ { } ] + security: [{}] parameters: - name: redirectUri in: query @@ -123,7 +123,7 @@ paths: application/json: schema: $ref: "#/components/schemas/PackageCreate" - examples: { } + examples: {} required: true responses: "201": @@ -140,7 +140,7 @@ paths: type: array items: $ref: "#/components/schemas/PackageList" - examples: { } + examples: {} "400": description: Bad request content: @@ -156,14 +156,14 @@ paths: application/json: schema: $ref: "#/components/schemas/ErrorResponse" - examples: { } + examples: {} "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" - examples: { } + examples: {} "500": description: Internal Server Error content: @@ -191,9 +191,9 @@ paths: in: query description: | Filter the packages by kind. - + The list of values is acceptable. In this case, the following pattern will be used: ```?kind=group,package,dashboard```. - + If not transmitted, the default value will be used. schema: type: array @@ -210,7 +210,7 @@ paths: in: query description: | Show all the descendants to the parent workspace or group. - + * If ```true```, return the list of all child groups/packages/dashboards to the parentId (take into account all other filter parameters). * If the parentId is not transmitted??? * If the parent is transmitted, but kind not - and parentId = package??? @@ -296,7 +296,7 @@ paths: default: false summary: $ref: "#/components/schemas/ChangeSummary" - examples: { } + examples: {} "400": description: Bad request content: @@ -312,7 +312,7 @@ paths: application/json: schema: $ref: "#/components/schemas/ErrorResponse" - examples: { } + examples: {} "500": description: Internal Server Error content: @@ -551,7 +551,7 @@ components: deprecatedInfo: description: | Additional information about single deprecated item: - * for REST API it is value of 'x-deprecated-meta' extension (value of extension must be string), which is defined for deprecated item. + * for REST API it is value of 'x-deprecated-meta' extension (value of extension must be string), which is defined for deprecated item. * for GraphQL API it is value of 'reason' argument of @deprecated directive. type: string tolerantHash: @@ -693,7 +693,7 @@ components: type: boolean restGroupingPrefix: description: | - Regular expression used as criteria for grouping operations. + Regular expression used as criteria for grouping operations. Groups for the package version are calculated during publication of this version. type: string example: "/api/v1/{group}/" @@ -1431,7 +1431,7 @@ components: title: SearchResultPackage description: | Global search result for packages with kind = package; must be returned when searchLevel = package - * If search term matches the package id/name/description/service name, return the latest published version only. + * If search term matches the package id/name/description/service name, return the latest published version only. * If search term matches the version name/label, return that version. type: object required: @@ -1938,7 +1938,7 @@ components: BuildResultV2: description: | Result of build operation in ZIP archive. - * The archive contains folders with sources, builded JSON documents and JSON operation files. + * The archive contains folders with sources, builded JSON documents and JSON operation files. * In addition, several config files are provided. he structure of these files is described below. title: BuildResult type: object @@ -1977,7 +1977,7 @@ components: description: | Type of the build process. Available options are: - **build** - Standard build process. + **build** - Standard build process. Consist of contract and operations build and validation, calculation of the changelog, creation of the final version of the published contracts. **changelog** - Only the changelog calculation, no API contracts version will be created. @@ -2423,7 +2423,7 @@ components: BuildResult: description: | Result of build operation in ZIP archive. - * The archive contains folders with sources, builded JSON documents and JSON operation files. + * The archive contains folders with sources, builded JSON documents and JSON operation files. * In addition, several config files are provided. he structure of these files is described below. title: BuildResult type: object @@ -2773,7 +2773,7 @@ components: deprecatedInfo: description: | Additional information about deprecated operation: - * for REST API it is value of 'x-deprecated-meta' extension (value of extension must be string), which is defined for deprecated operation. + * for REST API it is value of 'x-deprecated-meta' extension (value of extension must be string), which is defined for deprecated operation. * for GraphQL API it is value of 'reason' argument of @deprecated directive, which is defined for deprecated operation. type: string deprecatedInPreviousVersions: @@ -2840,9 +2840,9 @@ components: type: array items: anyOf: - - type: string - - type: integer - example: [["components/schemas/Cat/minProperties", "components/schemas/Dog/minProperties"],["/quoteManagement/v5/quote"]] + - type: string + - type: integer + example: [["components/schemas/Cat/minProperties", "components/schemas/Dog/minProperties"], ["/quoteManagement/v5/quote"]] currentValueHash: type: string description: | @@ -2861,9 +2861,9 @@ components: type: array items: anyOf: - - type: string - - type: integer - example: [["components/schemas/Cat/minProperties", "components/schemas/Dog/minProperties"],["/quoteManagement/v5/quote"]] + - type: string + - type: integer + example: [["components/schemas/Cat/minProperties", "components/schemas/Dog/minProperties"], ["/quoteManagement/v5/quote"]] previousValueHash: type: string description: | @@ -2882,9 +2882,9 @@ components: type: array items: anyOf: - - type: string - - type: integer - example: [["components/schemas/Cat/minProperties", "components/schemas/Dog/minProperties"],["/quoteManagement/v5/quote"]] + - type: string + - type: integer + example: [["components/schemas/Cat/minProperties", "components/schemas/Dog/minProperties"], ["/quoteManagement/v5/quote"]] previousDeclarationJsonPaths: description: | (below, a document is not considered to be an original document, but a document with one specific operation)\ @@ -2894,9 +2894,9 @@ components: type: array items: anyOf: - - type: string - - type: integer - example: [["components/schemas/Cat/minProperties", "components/schemas/Dog/minProperties"],["/quoteManagement/v5/quote"]] + - type: string + - type: integer + example: [["components/schemas/Cat/minProperties", "components/schemas/Dog/minProperties"], ["/quoteManagement/v5/quote"]] previousValueHash: type: string description: | @@ -2920,9 +2920,9 @@ components: type: array items: anyOf: - - type: string - - type: integer - example: [["components/schemas/Cat/minProperties", "components/schemas/Dog/minProperties"],["/quoteManagement/v5/quote"]] + - type: string + - type: integer + example: [["components/schemas/Cat/minProperties", "components/schemas/Dog/minProperties"], ["/quoteManagement/v5/quote"]] previousDeclarationJsonPaths: description: | (below, a document is not considered to be an original document, but a document with one specific operation)\ @@ -2932,9 +2932,9 @@ components: type: array items: anyOf: - - type: string - - type: integer - example: [["components/schemas/Cat/minProperties", "components/schemas/Dog/minProperties"],["/quoteManagement/v5/quote"]] + - type: string + - type: integer + example: [["components/schemas/Cat/minProperties", "components/schemas/Dog/minProperties"], ["/quoteManagement/v5/quote"]] previousKey: type: string description: Previous key (name) of the renamed entity. @@ -2944,7 +2944,7 @@ components: BuildConfig: type: object description: | - Configuration of the source files. + Configuration of the source files. Content can not be empty, files or refs are **required**. required: - version @@ -2962,8 +2962,8 @@ components: example: "2022.2" default: "" previousVersionPackageId: - description: | - Required in case of snapshot when publishing version should be compared to different package. + description: | + Required in case of snapshot when publishing version should be compared to different package. Do not set anything if the package sould be compared to itself. Value equals to packageId is forbidden. type: string example: "QS.CloudOSS.PL.MC" @@ -3062,9 +3062,9 @@ components: description: File name. example: "qitmf-v5.11.json" publish: - description: | - Flag, publish the source file or not. - Required for case with external refs when specification is separated into multiple files. + description: | + Flag, publish the source file or not. + Required for case with external refs when specification is separated into multiple files. After dereference in scope of build process the source files(parts) are no longer required. So it's possible to skip publish of such files. type: boolean default: true @@ -3242,7 +3242,7 @@ components: example: template123.json BuildTypes: type: string - description: | + description: | Type of the build process. Available options are:\ **build** - Standard build process to publish new version. Consist of contract and operations build and validation, calculation of the changelog, creation of the final version of the published contracts.\ **changelog** - Only the changelog calculation, no API contracts version will be created. The ```files``` and ```refs``` objects are not required in this case.\ @@ -3401,4 +3401,4 @@ components: BasicAuth: type: http description: Login/password authentication. - scheme: basic \ No newline at end of file + scheme: basic diff --git a/test/projects/deprecated/PublicRegistry API(4)v3.yaml b/test/projects/deprecated/PublicRegistry API(4)v3.yaml index 29752c2..c9d5b0d 100644 --- a/test/projects/deprecated/PublicRegistry API(4)v3.yaml +++ b/test/projects/deprecated/PublicRegistry API(4)v3.yaml @@ -72,7 +72,7 @@ paths: application/json: schema: $ref: "#/components/schemas/PackageCreate" - examples: { } + examples: {} required: true responses: "201": @@ -89,7 +89,7 @@ paths: type: array items: $ref: "#/components/schemas/PackageList" - examples: { } + examples: {} "400": description: Bad request content: @@ -105,14 +105,14 @@ paths: application/json: schema: $ref: "#/components/schemas/ErrorResponse" - examples: { } + examples: {} "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" - examples: { } + examples: {} "500": description: Internal Server Error content: @@ -140,9 +140,9 @@ paths: in: query description: | Filter the packages by kind. - + The list of values is acceptable. In this case, the following pattern will be used: ```?kind=group,package,dashboard```. - + If not transmitted, the default value will be used. schema: type: array @@ -159,7 +159,7 @@ paths: in: query description: | Show all the descendants to the parent workspace or group. - + * If ```true```, return the list of all child groups/packages/dashboards to the parentId (take into account all other filter parameters). * If the parentId is not transmitted??? * If the parent is transmitted, but kind not - and parentId = package??? @@ -239,7 +239,7 @@ paths: default: false summary: $ref: "#/components/schemas/ChangeSummary" - examples: { } + examples: {} "400": description: Bad request content: @@ -255,7 +255,7 @@ paths: application/json: schema: $ref: "#/components/schemas/ErrorResponse" - examples: { } + examples: {} "500": description: Internal Server Error content: @@ -494,7 +494,7 @@ components: deprecatedInfo: description: | Additional information about single deprecated item: - * for REST API it is value of 'x-deprecated-meta' extension (value of extension must be string), which is defined for deprecated item. + * for REST API it is value of 'x-deprecated-meta' extension (value of extension must be string), which is defined for deprecated item. * for GraphQL API it is value of 'reason' argument of @deprecated directive. type: string tolerantHash: @@ -636,7 +636,7 @@ components: type: boolean restGroupingPrefix: description: | - Regular expression used as criteria for grouping operations. + Regular expression used as criteria for grouping operations. Groups for the package version are calculated during publication of this version. type: string example: "/api/v1/{group}/" @@ -1374,7 +1374,7 @@ components: title: SearchResultPackage description: | Global search result for packages with kind = package; must be returned when searchLevel = package - * If search term matches the package id/name/description/service name, return the latest published version only. + * If search term matches the package id/name/description/service name, return the latest published version only. * If search term matches the version name/label, return that version. type: object required: @@ -1881,7 +1881,7 @@ components: BuildResultV2: description: | Result of build operation in ZIP archive. - * The archive contains folders with sources, builded JSON documents and JSON operation files. + * The archive contains folders with sources, builded JSON documents and JSON operation files. * In addition, several config files are provided. he structure of these files is described below. title: BuildResult type: object @@ -1920,7 +1920,7 @@ components: description: | Type of the build process. Available options are: - **build** - Standard build process. + **build** - Standard build process. Consist of contract and operations build and validation, calculation of the changelog, creation of the final version of the published contracts. **changelog** - Only the changelog calculation, no API contracts version will be created. @@ -2366,7 +2366,7 @@ components: BuildResult: description: | Result of build operation in ZIP archive. - * The archive contains folders with sources, builded JSON documents and JSON operation files. + * The archive contains folders with sources, builded JSON documents and JSON operation files. * In addition, several config files are provided. he structure of these files is described below. title: BuildResult type: object @@ -2716,7 +2716,7 @@ components: deprecatedInfo: description: | Additional information about deprecated operation: - * for REST API it is value of 'x-deprecated-meta' extension (value of extension must be string), which is defined for deprecated operation. + * for REST API it is value of 'x-deprecated-meta' extension (value of extension must be string), which is defined for deprecated operation. * for GraphQL API it is value of 'reason' argument of @deprecated directive, which is defined for deprecated operation. type: string deprecatedInPreviousVersions: @@ -2783,9 +2783,9 @@ components: type: array items: anyOf: - - type: string - - type: integer - example: [["components/schemas/Cat/minProperties", "components/schemas/Dog/minProperties"],["/quoteManagement/v5/quote"]] + - type: string + - type: integer + example: [["components/schemas/Cat/minProperties", "components/schemas/Dog/minProperties"], ["/quoteManagement/v5/quote"]] currentValueHash: type: string description: | @@ -2804,9 +2804,9 @@ components: type: array items: anyOf: - - type: string - - type: integer - example: [["components/schemas/Cat/minProperties", "components/schemas/Dog/minProperties"],["/quoteManagement/v5/quote"]] + - type: string + - type: integer + example: [["components/schemas/Cat/minProperties", "components/schemas/Dog/minProperties"], ["/quoteManagement/v5/quote"]] previousValueHash: type: string description: | @@ -2825,9 +2825,9 @@ components: type: array items: anyOf: - - type: string - - type: integer - example: [["components/schemas/Cat/minProperties", "components/schemas/Dog/minProperties"],["/quoteManagement/v5/quote"]] + - type: string + - type: integer + example: [["components/schemas/Cat/minProperties", "components/schemas/Dog/minProperties"], ["/quoteManagement/v5/quote"]] previousDeclarationJsonPaths: description: | (below, a document is not considered to be an original document, but a document with one specific operation)\ @@ -2837,9 +2837,9 @@ components: type: array items: anyOf: - - type: string - - type: integer - example: [["components/schemas/Cat/minProperties", "components/schemas/Dog/minProperties"],["/quoteManagement/v5/quote"]] + - type: string + - type: integer + example: [["components/schemas/Cat/minProperties", "components/schemas/Dog/minProperties"], ["/quoteManagement/v5/quote"]] previousValueHash: type: string description: | @@ -2863,9 +2863,9 @@ components: type: array items: anyOf: - - type: string - - type: integer - example: [["components/schemas/Cat/minProperties", "components/schemas/Dog/minProperties"],["/quoteManagement/v5/quote"]] + - type: string + - type: integer + example: [["components/schemas/Cat/minProperties", "components/schemas/Dog/minProperties"], ["/quoteManagement/v5/quote"]] previousDeclarationJsonPaths: description: | (below, a document is not considered to be an original document, but a document with one specific operation)\ @@ -2875,9 +2875,9 @@ components: type: array items: anyOf: - - type: string - - type: integer - example: [["components/schemas/Cat/minProperties", "components/schemas/Dog/minProperties"],["/quoteManagement/v5/quote"]] + - type: string + - type: integer + example: [["components/schemas/Cat/minProperties", "components/schemas/Dog/minProperties"], ["/quoteManagement/v5/quote"]] previousKey: type: string description: Previous key (name) of the renamed entity. @@ -2887,7 +2887,7 @@ components: BuildConfig: type: object description: | - Configuration of the source files. + Configuration of the source files. Content can not be empty, files or refs are **required**. required: - version @@ -2905,8 +2905,8 @@ components: example: "2022.2" default: "" previousVersionPackageId: - description: | - Required in case of snapshot when publishing version should be compared to different package. + description: | + Required in case of snapshot when publishing version should be compared to different package. Do not set anything if the package sould be compared to itself. Value equals to packageId is forbidden. type: string example: "QS.CloudOSS.PL.MC" @@ -3005,9 +3005,9 @@ components: description: File name. example: "qitmf-v5.11.json" publish: - description: | - Flag, publish the source file or not. - Required for case with external refs when specification is separated into multiple files. + description: | + Flag, publish the source file or not. + Required for case with external refs when specification is separated into multiple files. After dereference in scope of build process the source files(parts) are no longer required. So it's possible to skip publish of such files. type: boolean default: true @@ -3185,7 +3185,7 @@ components: example: template123.json BuildTypes: type: string - description: | + description: | Type of the build process. Available options are:\ **build** - Standard build process to publish new version. Consist of contract and operations build and validation, calculation of the changelog, creation of the final version of the published contracts.\ **changelog** - Only the changelog calculation, no API contracts version will be created. The ```files``` and ```refs``` objects are not required in this case.\ @@ -3344,4 +3344,4 @@ components: BasicAuth: type: http description: Login/password authentication. - scheme: basic \ No newline at end of file + scheme: basic diff --git a/test/projects/deprecated/TemplateDictionary(1).yaml b/test/projects/deprecated/TemplateDictionary(1).yaml index 55aa5df..1cbbbc1 100644 --- a/test/projects/deprecated/TemplateDictionary(1).yaml +++ b/test/projects/deprecated/TemplateDictionary(1).yaml @@ -3,7 +3,7 @@ info: '' servers: - url: / security: - - OAuth2 Access Token: [ ] + - OAuth2 Access Token: [] paths: /api/v2/test/animals/{id}: get: @@ -25,7 +25,7 @@ paths: content: application/json: schema: - items: [ { } ] + items: [{}] '400': description: Bad request content: @@ -62,7 +62,7 @@ paths: content: application/json: schema: - items: [ { } ] + items: [{}] required: true responses: '200': @@ -127,7 +127,7 @@ paths: content: application/json: schema: - items: [ { } ] + items: [{}] required: true responses: '200': @@ -136,7 +136,7 @@ paths: application/json: schema: type: array - items: [ { } ] + items: [{}] '400': description: Bad request content: diff --git a/test/projects/deprecated/TemplateDictionary(2).yaml b/test/projects/deprecated/TemplateDictionary(2).yaml index 55aa5df..1cbbbc1 100644 --- a/test/projects/deprecated/TemplateDictionary(2).yaml +++ b/test/projects/deprecated/TemplateDictionary(2).yaml @@ -3,7 +3,7 @@ info: '' servers: - url: / security: - - OAuth2 Access Token: [ ] + - OAuth2 Access Token: [] paths: /api/v2/test/animals/{id}: get: @@ -25,7 +25,7 @@ paths: content: application/json: schema: - items: [ { } ] + items: [{}] '400': description: Bad request content: @@ -62,7 +62,7 @@ paths: content: application/json: schema: - items: [ { } ] + items: [{}] required: true responses: '200': @@ -127,7 +127,7 @@ paths: content: application/json: schema: - items: [ { } ] + items: [{}] required: true responses: '200': @@ -136,7 +136,7 @@ paths: application/json: schema: type: array - items: [ { } ] + items: [{}] '400': description: Bad request content: diff --git a/test/projects/deprecated/TemplateDictionary(3).yaml b/test/projects/deprecated/TemplateDictionary(3).yaml index 72942b5..f044de3 100644 --- a/test/projects/deprecated/TemplateDictionary(3).yaml +++ b/test/projects/deprecated/TemplateDictionary(3).yaml @@ -3,4 +3,4 @@ info: '' servers: - url: / security: - - OAuth2 Access Token: [ ] + - OAuth2 Access Token: [] diff --git a/test/projects/new-deprecated/deprecated-in-allof-1.yaml b/test/projects/new-deprecated/deprecated-in-allof-1.yaml index 9db88ba..515ac25 100644 --- a/test/projects/new-deprecated/deprecated-in-allof-1.yaml +++ b/test/projects/new-deprecated/deprecated-in-allof-1.yaml @@ -18,7 +18,7 @@ paths: - $ref: "#/components/schemas/Schema1" - $ref: "#/components/schemas/Schema2" required: true - responses: { } + responses: {} components: schemas: diff --git a/test/projects/new-deprecated/many-to-one-deprecation-history-relation.yaml b/test/projects/new-deprecated/many-to-one-deprecation-history-relation.yaml index 7cd0993..4998737 100644 --- a/test/projects/new-deprecated/many-to-one-deprecation-history-relation.yaml +++ b/test/projects/new-deprecated/many-to-one-deprecation-history-relation.yaml @@ -13,7 +13,7 @@ paths: schema: $ref: "#/components/schemas/schema" required: true - responses: { } + responses: {} components: schemas: @@ -28,4 +28,4 @@ components: prop2: $ref: '#/components/schemas/commonPropSchema' prop3: - $ref: '#/components/schemas/commonPropSchema' \ No newline at end of file + $ref: '#/components/schemas/commonPropSchema' diff --git a/test/projects/new-deprecated/many-to-one-deprecation-history-relation2.yaml b/test/projects/new-deprecated/many-to-one-deprecation-history-relation2.yaml index 0cf613f..1e910f9 100644 --- a/test/projects/new-deprecated/many-to-one-deprecation-history-relation2.yaml +++ b/test/projects/new-deprecated/many-to-one-deprecation-history-relation2.yaml @@ -13,7 +13,7 @@ paths: schema: $ref: "#/components/schemas/schema" required: true - responses: { } + responses: {} components: schemas: diff --git a/test/projects/new-deprecated/one-schema-usage-1.yaml b/test/projects/new-deprecated/one-schema-usage-1.yaml index 6de9895..cd4f524 100644 --- a/test/projects/new-deprecated/one-schema-usage-1.yaml +++ b/test/projects/new-deprecated/one-schema-usage-1.yaml @@ -15,14 +15,14 @@ paths: responses: '200': description: OK - content: { } + content: {} post: parameters: - $ref: "#/components/parameters/CommonDeprecatedParameter" responses: '200': description: OK - content: { } + content: {} components: parameters: diff --git a/test/projects/new-deprecated/one-schema-usage-2.yaml b/test/projects/new-deprecated/one-schema-usage-2.yaml index 164f816..4eb994d 100644 --- a/test/projects/new-deprecated/one-schema-usage-2.yaml +++ b/test/projects/new-deprecated/one-schema-usage-2.yaml @@ -14,9 +14,9 @@ paths: responses: '200': description: OK - content: { } + content: {} post: responses: '200': description: OK - content: { } + content: {} diff --git a/test/projects/new-deprecated/properties-components-same-schema.yaml b/test/projects/new-deprecated/properties-components-same-schema.yaml index 4ee9d43..52626b5 100644 --- a/test/projects/new-deprecated/properties-components-same-schema.yaml +++ b/test/projects/new-deprecated/properties-components-same-schema.yaml @@ -13,7 +13,7 @@ paths: schema: $ref: "#/components/schemas/schema" required: true - responses: { } + responses: {} components: schemas: diff --git a/test/projects/new-deprecated/properties-inline-add-description.yaml b/test/projects/new-deprecated/properties-inline-add-description.yaml index 996782b..d8c4f0b 100644 --- a/test/projects/new-deprecated/properties-inline-add-description.yaml +++ b/test/projects/new-deprecated/properties-inline-add-description.yaml @@ -13,7 +13,7 @@ paths: schema: $ref: "#/components/schemas/schema" required: true - responses: { } + responses: {} components: schemas: diff --git a/test/projects/new-deprecated/properties-inline-add-description2.yaml b/test/projects/new-deprecated/properties-inline-add-description2.yaml index 95569ef..d52a4c8 100644 --- a/test/projects/new-deprecated/properties-inline-add-description2.yaml +++ b/test/projects/new-deprecated/properties-inline-add-description2.yaml @@ -13,7 +13,7 @@ paths: schema: $ref: "#/components/schemas/schema" required: true - responses: { } + responses: {} components: schemas: diff --git a/test/projects/new-deprecated/properties-inline-same-schema-step-deprecation.yaml b/test/projects/new-deprecated/properties-inline-same-schema-step-deprecation.yaml index ff0f8f9..339a165 100644 --- a/test/projects/new-deprecated/properties-inline-same-schema-step-deprecation.yaml +++ b/test/projects/new-deprecated/properties-inline-same-schema-step-deprecation.yaml @@ -13,7 +13,7 @@ paths: schema: $ref: "#/components/schemas/schema" required: true - responses: { } + responses: {} components: schemas: diff --git a/test/projects/new-deprecated/properties-inline-same-schema-step-deprecation2.yaml b/test/projects/new-deprecated/properties-inline-same-schema-step-deprecation2.yaml index 1755e80..e023808 100644 --- a/test/projects/new-deprecated/properties-inline-same-schema-step-deprecation2.yaml +++ b/test/projects/new-deprecated/properties-inline-same-schema-step-deprecation2.yaml @@ -13,7 +13,7 @@ paths: schema: $ref: "#/components/schemas/schema" required: true - responses: { } + responses: {} components: schemas: diff --git a/test/projects/new-deprecated/properties-inline-same-schema.yaml b/test/projects/new-deprecated/properties-inline-same-schema.yaml index 2a22488..7c8f0fa 100644 --- a/test/projects/new-deprecated/properties-inline-same-schema.yaml +++ b/test/projects/new-deprecated/properties-inline-same-schema.yaml @@ -20,5 +20,5 @@ paths: type: string deprecated: true required: true - responses: { } + responses: {} diff --git a/test/projects/new-deprecated/refactor-extract-deprecated-schema-to-components.yaml b/test/projects/new-deprecated/refactor-extract-deprecated-schema-to-components.yaml index d0d7b5a..319be58 100644 --- a/test/projects/new-deprecated/refactor-extract-deprecated-schema-to-components.yaml +++ b/test/projects/new-deprecated/refactor-extract-deprecated-schema-to-components.yaml @@ -17,5 +17,5 @@ paths: type: string deprecated: true required: true - responses: { } + responses: {} diff --git a/test/projects/new-deprecated/refactor-extract-deprecated-schema-to-components2.yaml b/test/projects/new-deprecated/refactor-extract-deprecated-schema-to-components2.yaml index 3c3ac8e..2e85034 100644 --- a/test/projects/new-deprecated/refactor-extract-deprecated-schema-to-components2.yaml +++ b/test/projects/new-deprecated/refactor-extract-deprecated-schema-to-components2.yaml @@ -13,7 +13,7 @@ paths: schema: $ref: "#/components/schemas/schema" required: true - responses: { } + responses: {} components: schemas: diff --git a/test/projects/new-deprecated/refactor-inline-deprecated-schema-add-new-schema-to-components.yaml b/test/projects/new-deprecated/refactor-inline-deprecated-schema-add-new-schema-to-components.yaml index 0014dbd..57ca845 100644 --- a/test/projects/new-deprecated/refactor-inline-deprecated-schema-add-new-schema-to-components.yaml +++ b/test/projects/new-deprecated/refactor-inline-deprecated-schema-add-new-schema-to-components.yaml @@ -16,7 +16,7 @@ paths: TestSchema: $ref: "#/components/schemas/schema" required: true - responses: { } + responses: {} components: schemas: diff --git a/test/projects/new-deprecated/refactor-inline-deprecated-schema-add-new-schema-to-components2.yaml b/test/projects/new-deprecated/refactor-inline-deprecated-schema-add-new-schema-to-components2.yaml index a6c1a2c..ff01a9a 100644 --- a/test/projects/new-deprecated/refactor-inline-deprecated-schema-add-new-schema-to-components2.yaml +++ b/test/projects/new-deprecated/refactor-inline-deprecated-schema-add-new-schema-to-components2.yaml @@ -20,7 +20,7 @@ paths: TestSchema: $ref: "#/components/schemas/schema" required: true - responses: { } + responses: {} components: schemas: diff --git a/test/projects/new-deprecated/refactor-inline-deprecated-schema-from-components.yaml b/test/projects/new-deprecated/refactor-inline-deprecated-schema-from-components.yaml index 3c3ac8e..2e85034 100644 --- a/test/projects/new-deprecated/refactor-inline-deprecated-schema-from-components.yaml +++ b/test/projects/new-deprecated/refactor-inline-deprecated-schema-from-components.yaml @@ -13,7 +13,7 @@ paths: schema: $ref: "#/components/schemas/schema" required: true - responses: { } + responses: {} components: schemas: diff --git a/test/projects/new-deprecated/refactor-inline-deprecated-schema-from-components2.yaml b/test/projects/new-deprecated/refactor-inline-deprecated-schema-from-components2.yaml index d0d7b5a..319be58 100644 --- a/test/projects/new-deprecated/refactor-inline-deprecated-schema-from-components2.yaml +++ b/test/projects/new-deprecated/refactor-inline-deprecated-schema-from-components2.yaml @@ -17,5 +17,5 @@ paths: type: string deprecated: true required: true - responses: { } + responses: {} diff --git a/test/projects/new-deprecated/semi-breaking-changes.yaml b/test/projects/new-deprecated/semi-breaking-changes.yaml index 12e53cc..c0ae51b 100644 --- a/test/projects/new-deprecated/semi-breaking-changes.yaml +++ b/test/projects/new-deprecated/semi-breaking-changes.yaml @@ -23,4 +23,4 @@ paths: - prop1 - prop2 required: true - responses: { } + responses: {} diff --git a/test/projects/new-deprecated/semi-breaking-changes2.yaml b/test/projects/new-deprecated/semi-breaking-changes2.yaml index 0f8f00b..65ddebd 100644 --- a/test/projects/new-deprecated/semi-breaking-changes2.yaml +++ b/test/projects/new-deprecated/semi-breaking-changes2.yaml @@ -19,4 +19,4 @@ paths: required: - prop1 required: true - responses: { } + responses: {} diff --git a/test/projects/new-deprecated/semi-breaking-classification-1.yaml b/test/projects/new-deprecated/semi-breaking-classification-1.yaml index 89f1684..6285176 100644 --- a/test/projects/new-deprecated/semi-breaking-classification-1.yaml +++ b/test/projects/new-deprecated/semi-breaking-classification-1.yaml @@ -18,7 +18,7 @@ paths: responses: '200': description: OK - content: { } + content: {} post: parameters: - name: param1 @@ -28,4 +28,4 @@ paths: responses: '200': description: OK - content: { } + content: {} diff --git a/test/projects/new-deprecated/semi-breaking-classification-2.yaml b/test/projects/new-deprecated/semi-breaking-classification-2.yaml index 1648e85..e4fbdd6 100644 --- a/test/projects/new-deprecated/semi-breaking-classification-2.yaml +++ b/test/projects/new-deprecated/semi-breaking-classification-2.yaml @@ -14,14 +14,14 @@ paths: responses: '200': description: OK - content: { } + content: {} post: parameters: - $ref: "#/components/parameters/CommonDeprecatedParameter" responses: '200': description: OK - content: { } + content: {} components: parameters: diff --git a/test/projects/new-deprecated/semi-breaking-classification-3.yaml b/test/projects/new-deprecated/semi-breaking-classification-3.yaml index 8bfe15a..e53ec88 100644 --- a/test/projects/new-deprecated/semi-breaking-classification-3.yaml +++ b/test/projects/new-deprecated/semi-breaking-classification-3.yaml @@ -13,9 +13,9 @@ paths: responses: '200': description: OK - content: { } + content: {} post: responses: '200': description: OK - content: { } + content: {}