Skip to content

Commit 485a6d5

Browse files
joschijoschi
committed
Failing test for #464 
1 parent 5105f0b commit 485a6d5

File tree

23 files changed

+418
-0
lines changed

23 files changed

+418
-0
lines changed

‎core/src/test/java/org/openapitools/openapidiff/core/ExternalRefsTest.java

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
package org.openapitools.openapidiff.core;
2+
3+
import static org.openapitools.openapidiff.core.TestUtils.assertOpenApiAreEquals;
4+
5+
import org.junit.jupiter.api.Test;
6+
7+
public class ExternalRefsTest {
8+
@Test
9+
public void testDiffSame() {
10+
assertOpenApiAreEquals(
11+
"issue-464/source/specification/openapi.yaml",
12+
"issue-464/destination/specification/openapi.yaml");
13+
}
14+
}

‎core/src/test/resources/issue-464/destination/specification/common/examples/200-health.yaml

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
status: up
2+
date_time: "2021-09-04T21:00:00Z"
3+
api_name: api
4+
api_version: 1.1.2

‎core/src/test/resources/issue-464/destination/specification/common/examples/400.yaml

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
type: /problem/bad-request
2+
title: Bad Request
3+
status: 400
4+
detail: Invalid or malformed request syntax
5+
instance: /problem/bad-request#invalid-or-malformed-request-syntax

‎core/src/test/resources/issue-464/destination/specification/common/examples/404.yaml

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
type: /problem/data-not-found
2+
title: Data not found
3+
status: 404
4+
detail: Requested data not found
5+
instance: /problem/data-not-found#requested-data-not-found

‎core/src/test/resources/issue-464/destination/specification/common/examples/500.yaml

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
type: /problem/internal-server-error
2+
title: Internal Server Error
3+
status: 500
4+
detail: A technical exception occurred within the application
5+
instance: /problem/internal-server-error#a-technical-exception-occurred-within-the-application

‎core/src/test/resources/issue-464/destination/specification/common/examples/Product/200-GetProductResponse.yaml

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
products:
2+
- id: Prod-000001
3+
status: Active

‎core/src/test/resources/issue-464/destination/specification/common/models/GetProductResponse.yaml

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
type: object
2+
description: Model for response from call to GET products requiring an array of products to be returned.
3+
title: GetProductResponse
4+
properties:
5+
Products:
6+
type: array
7+
items:
8+
$ref: Product.yaml
9+

‎core/src/test/resources/issue-464/destination/specification/common/models/Product.yaml

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
type: object
2+
description: Product Data Model
3+
title: ''
4+
properties:
5+
id:
6+
type: string
7+
example: Prod-00001
8+
description: An unique Id of product record
9+
status:
10+
type: string
11+
example: Active
12+
enum:
13+
- Active
14+
- Expired
15+
description: Defines the current status of the product

‎core/src/test/resources/issue-464/destination/specification/common/models/error.yaml

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
type: object
2+
properties:
3+
type:
4+
type: string
5+
format: uri-reference
6+
description: |
7+
A URI reference that uniquely identifies the problem type only in the context of the provided API. Opposed to the specification in RFC-7807, it is neither recommended to be dereferenceable and point to a human-readable documentation nor globally unique for the problem type.
8+
default: about:blank
9+
example: /problem/connection-error
10+
title:
11+
type: string
12+
description: |
13+
A short summary of the problem type. Written in English and readable for engineers, usually not suited for non technical stakeholders and not localized.
14+
example: Service Unavailable
15+
status:
16+
type: integer
17+
format: int32
18+
description: |
19+
The HTTP status code generated by the origin server for this occurrence of the problem.
20+
minimum: 100
21+
maximum: 600
22+
exclusiveMaximum: true
23+
example: 503
24+
detail:
25+
type: string
26+
description: |
27+
A human readable explanation specific to this occurrence of the problem that is helpful to locate the problem and give advice on how to proceed. Written in English and readable for engineers, usually not suited for non technical stakeholders and not localized.
28+
example: Connection to database timed out
29+
instance:
30+
type: string
31+
format: uri-reference
32+
description: |
33+
A URI reference that identifies the specific occurrence of the problem, e.g. by adding a fragment identifier or sub-path to the problem type. May be used to locate the root of this problem in the source code.
34+
example: /problem/connection-error#token-info-read-timed-out

‎core/src/test/resources/issue-464/destination/specification/common/parameters/correlation-id.yaml

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
name: correlation-id
2+
in: header
3+
schema:
4+
type: string
5+
example: 4cbc91f7-11d3-4019-a92b-64a54964b470
6+
description: A unique identifier attached to request and responses as header that allows reference to a particular transaction or chain of transactions. Based on UUID conforming to RFC 4122 - https://datatracker.ietf.org/doc/html/rfc4122

‎core/src/test/resources/issue-464/destination/specification/common/parameters/traceparent.yaml

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
name: traceparent
2+
in: header
3+
schema:
4+
type: string
5+
example: 00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01
6+
description: The traceparent HTTP header field identifies the incoming request in a tracing system. Conforming to OpenTelemetry (OTel) Trace Context

‎core/src/test/resources/issue-464/destination/specification/openapi.yaml

+110
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
openapi: 3.0.0
2+
info:
3+
title: service/someapi/v1
4+
version: 1.1.2
5+
contact:
6+
name: john.doe
7+
email: [email protected]
8+
description: Provide description of the API
9+
servers:
10+
- url: 'https://api.acme.com/service/someapi/v1'
11+
paths:
12+
/products:
13+
get:
14+
summary: Query Products
15+
operationId: get-products
16+
responses:
17+
'200':
18+
$ref: '#/components/responses/200-GetProductResponse'
19+
'400':
20+
$ref: '#/components/responses/400'
21+
'404':
22+
$ref: '#/components/responses/404'
23+
'500':
24+
$ref: '#/components/responses/500'
25+
description: Get Product Records
26+
parameters:
27+
- $ref: ./common/parameters/correlation-id.yaml
28+
- $ref: ./common/parameters/traceparent.yaml
29+
tags:
30+
- applicant
31+
components:
32+
schemas:
33+
Error:
34+
$ref: common/models/error.yaml
35+
GetProductResponse:
36+
$ref: ./common/models/GetProductResponse.yaml
37+
securitySchemes:
38+
Oauth:
39+
type: oauth2
40+
description: Oauth Security Token Enforcement for internal production environment.
41+
flows:
42+
clientCredentials:
43+
tokenUrl: 'https://api.acme.com/auth/app/v1/token'
44+
scopes:
45+
scope: READ
46+
responses:
47+
'400':
48+
description: 400 Bad Request
49+
content:
50+
application/json:
51+
schema:
52+
$ref: '#/components/schemas/Error'
53+
examples:
54+
400 Bad Request:
55+
value:
56+
$ref: common/examples/400.yaml
57+
headers:
58+
correlation-id:
59+
schema:
60+
type: string
61+
description: An ID passed by clients to correlate multiple API requests.
62+
'404':
63+
description: 404 Not Found
64+
content:
65+
application/json:
66+
schema:
67+
$ref: '#/components/schemas/Error'
68+
examples:
69+
404 Not Found:
70+
value:
71+
$ref: common/examples/404.yaml
72+
headers:
73+
correlation-id:
74+
schema:
75+
type: string
76+
description: An ID passed by clients to correlate multiple API requests.
77+
'500':
78+
description: 500 Internal Server Error
79+
content:
80+
application/json:
81+
schema:
82+
$ref: '#/components/schemas/Error'
83+
examples:
84+
500 Internal Server Error:
85+
value:
86+
$ref: common/examples/500.yaml
87+
headers:
88+
correlation-id:
89+
schema:
90+
type: string
91+
description: An ID passed by clients to correlate multiple API requests.
92+
200-GetProductResponse:
93+
description: Get Product Response
94+
content:
95+
application/json:
96+
schema:
97+
$ref: '#/components/schemas/GetProductResponse'
98+
examples:
99+
200 - Sample Data:
100+
value:
101+
$ref: common/examples/Product/200-GetProductResponse.yaml
102+
headers:
103+
correlation-id:
104+
schema:
105+
type: string
106+
description: An ID passed by clients to correlate multiple API requests.
107+
security:
108+
- Oauth: []
109+
tags:
110+
- name: applicant

‎core/src/test/resources/issue-464/source/specification/common/examples/200-health.yaml

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
status: up
2+
date_time: "2021-09-04T21:00:00Z"
3+
api_name: api
4+
api_version: 1.1.2

‎core/src/test/resources/issue-464/source/specification/common/examples/400.yaml

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
type: /problem/bad-request
2+
title: Bad Request
3+
status: 400
4+
detail: Invalid or malformed request syntax
5+
instance: /problem/bad-request#invalid-or-malformed-request-syntax

‎core/src/test/resources/issue-464/source/specification/common/examples/404.yaml

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
type: /problem/data-not-found
2+
title: Data not found
3+
status: 404
4+
detail: Requested data not found
5+
instance: /problem/data-not-found#requested-data-not-found

‎core/src/test/resources/issue-464/source/specification/common/examples/500.yaml

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
type: /problem/internal-server-error
2+
title: Internal Server Error
3+
status: 500
4+
detail: A technical exception occurred within the application
5+
instance: /problem/internal-server-error#a-technical-exception-occurred-within-the-application

‎core/src/test/resources/issue-464/source/specification/common/examples/Product/200-GetProductResponse.yaml

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
products:
2+
- id: Prod-000001
3+
status: Active

‎core/src/test/resources/issue-464/source/specification/common/models/GetProductResponse.yaml

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
type: object
2+
description: Model for response from call to GET products requiring an array of products to be returned.
3+
title: GetProductResponse
4+
properties:
5+
Products:
6+
type: array
7+
items:
8+
$ref: Product.yaml
9+

‎core/src/test/resources/issue-464/source/specification/common/models/Product.yaml

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
type: object
2+
description: Product Data Model
3+
title: ''
4+
properties:
5+
id:
6+
type: string
7+
example: Prod-00001
8+
description: An unique Id of product record
9+
status:
10+
type: string
11+
example: Active
12+
enum:
13+
- Active
14+
- Expired
15+
description: Defines the current status of the product

‎core/src/test/resources/issue-464/source/specification/common/models/error.yaml

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
type: object
2+
properties:
3+
type:
4+
type: string
5+
format: uri-reference
6+
description: |
7+
A URI reference that uniquely identifies the problem type only in the context of the provided API. Opposed to the specification in RFC-7807, it is neither recommended to be dereferenceable and point to a human-readable documentation nor globally unique for the problem type.
8+
default: about:blank
9+
example: /problem/connection-error
10+
title:
11+
type: string
12+
description: |
13+
A short summary of the problem type. Written in English and readable for engineers, usually not suited for non technical stakeholders and not localized.
14+
example: Service Unavailable
15+
status:
16+
type: integer
17+
format: int32
18+
description: |
19+
The HTTP status code generated by the origin server for this occurrence of the problem.
20+
minimum: 100
21+
maximum: 600
22+
exclusiveMaximum: true
23+
example: 503
24+
detail:
25+
type: string
26+
description: |
27+
A human readable explanation specific to this occurrence of the problem that is helpful to locate the problem and give advice on how to proceed. Written in English and readable for engineers, usually not suited for non technical stakeholders and not localized.
28+
example: Connection to database timed out
29+
instance:
30+
type: string
31+
format: uri-reference
32+
description: |
33+
A URI reference that identifies the specific occurrence of the problem, e.g. by adding a fragment identifier or sub-path to the problem type. May be used to locate the root of this problem in the source code.
34+
example: /problem/connection-error#token-info-read-timed-out

‎core/src/test/resources/issue-464/source/specification/common/parameters/correlation-id.yaml

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
name: correlation-id
2+
in: header
3+
schema:
4+
type: string
5+
example: 4cbc91f7-11d3-4019-a92b-64a54964b470
6+
description: A unique identifier attached to request and responses as header that allows reference to a particular transaction or chain of transactions. Based on UUID conforming to RFC 4122 - https://datatracker.ietf.org/doc/html/rfc4122

‎core/src/test/resources/issue-464/source/specification/common/parameters/traceparent.yaml

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
name: traceparent
2+
in: header
3+
schema:
4+
type: string
5+
example: 00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01
6+
description: The traceparent HTTP header field identifies the incoming request in a tracing system. Conforming to OpenTelemetry (OTel) Trace Context

0 commit comments

Comments
 (0)