Skip to content

Commit f51cf3c

Browse files
MaggieKimani1MaggieKimani1
committed
chore: add a redocly ignore file to act as our baseline file during linting
1 parent 7d39711 commit f51cf3c

File tree

2 files changed

+161
-1
lines changed

2 files changed

+161
-1
lines changed

‎.github/workflows/validate-descriptions.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,4 +33,4 @@ jobs:
3333
- name: Validate description with redocly
3434
uses: fluximus-prime/redocly-cli-github-action@v1
3535
with:
36-
args: 'lint test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/${{ matrix.descriptions }} --skip-rule operation-4xx-response --skip-rule no-server-trailing-slash --skip-rule no-unused-components --skip-rule security-defined --skip-rule info-license-url --skip-rule info-license --skip-rule no-empty-servers --skip-rule operation-summary --skip-rule tag-description --generate-ignore-file --max-problems 1000'
36+
args: 'lint test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/${{ matrix.descriptions }} --skip-rule operation-4xx-response --skip-rule no-server-trailing-slash --skip-rule no-unused-components --skip-rule security-defined --skip-rule info-license-url --skip-rule info-license --skip-rule no-empty-servers --skip-rule operation-summary --skip-rule tag-description --max-problems 1000'

‎.redocly.lint-ignore.yaml‎

Lines changed: 160 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,160 @@
1+
# This file instructs Redocly's linter to ignore the rules contained for specific parts of your API.
2+
# See https://redocly.com/docs/cli/ for more information.
3+
test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Basic.OpenApi.json:
4+
no-server-example.com:
5+
- '#/servers/0/url'
6+
test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Basic.OpenApi.V3.1.json:
7+
no-server-example.com:
8+
- '#/servers/0/url'
9+
test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Empty.OpenApi.json:
10+
no-server-example.com:
11+
- '#/servers/0/url'
12+
test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Empty.OpenApi.V3.1.json:
13+
no-server-example.com:
14+
- '#/servers/0/url'
15+
test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Multiple.Schema.OpenApi.json:
16+
no-server-example.com:
17+
- '#/servers/0/url'
18+
struct:
19+
- >-
20+
#/components/schemas/Siterra.Documents.BusinessLogic.Entities.Document.DocumentClass/properties/Document/anyOf/1/nullable
21+
- >-
22+
#/components/schemas/Siterra.Documents.BusinessLogic.Entities.Document.DocumentTagRel/properties/Document/anyOf/1/nullable
23+
- >-
24+
#/components/schemas/Siterra.Documents.BusinessLogic.Entities.Document.DocumentTagRel/properties/Tag/anyOf/1/nullable
25+
- >-
26+
#/components/schemas/Siterra.Documents.BusinessLogic.Entities.Library.Library/properties/LibraryParent/anyOf/1/nullable
27+
- >-
28+
#/components/schemas/Siterra.Documents.BusinessLogic.Entities.Library.LibraryType/properties/MasterLibraryType/anyOf/1/nullable
29+
- >-
30+
#/components/schemas/Siterra.Documents.BusinessLogic.Entities.Library.LibraryType/properties/ParentLibraryTypes/anyOf/1/nullable
31+
- >-
32+
#/components/schemas/Siterra.Documents.BusinessLogic.Entities.Library.Library/properties/Type/anyOf/1/nullable
33+
- >-
34+
#/components/schemas/Siterra.Documents.BusinessLogic.Entities.Library.Library/properties/SourceFolder/anyOf/1/nullable
35+
- >-
36+
#/components/schemas/Siterra.Documents.BusinessLogic.Entities.Document.Document/properties/Library/anyOf/1/nullable
37+
- >-
38+
#/components/schemas/Siterra.Documents.BusinessLogic.Entities.Document.Document/properties/LastRevisionFile/anyOf/1/nullable
39+
- >-
40+
#/components/schemas/Siterra.Documents.BusinessLogic.Entities.Document.Document/properties/SourceDocument/anyOf/1/nullable
41+
- >-
42+
#/components/schemas/Siterra.Documents.BusinessLogic.Entities.Revision.Revision/properties/Document/anyOf/1/nullable
43+
- >-
44+
#/components/schemas/Siterra.Documents.App.DTO.RevisionDto/properties/Document/anyOf/1/nullable
45+
test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Multiple.Schema.OpenApi.V3.1.json:
46+
no-server-example.com:
47+
- '#/servers/0/url'
48+
test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/TripService.OpenApi.json:
49+
struct:
50+
- >-
51+
#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Location/properties/City/anyOf/1/nullable
52+
- >-
53+
#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person/properties/HomeAddress/anyOf/1/nullable
54+
- >-
55+
#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person/properties/BestFriend/anyOf/1/nullable
56+
- >-
57+
#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.AirportLocation/allOf/1/properties/EmergencyAuthority/anyOf/1/nullable
58+
- >-
59+
#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Airport/properties/Location/anyOf/1/nullable
60+
- >-
61+
#/paths/~1GetNearestAirport(lat={lat},lon={lon})/get/responses/200/content/application~1json/schema/anyOf/1/nullable
62+
- >-
63+
#/paths/~1GetPersonWithMostFriends()/get/responses/200/content/application~1json/schema/anyOf/1/nullable
64+
- >-
65+
#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Manager/allOf/1/properties/BossOffice/anyOf/1/nullable
66+
- >-
67+
#/components/responses/GetFavoriteAirlineResponse/content/application~1json/schema/anyOf/1/nullable
68+
- >-
69+
#/paths/~1Me~1Microsoft.OData.Service.Sample.TrippinInMemory.Models.Manager~1Microsoft.OData.Service.Sample.TrippinInMemory.Models.Hire/post/requestBody/content/application~1json/schema/properties/hire/anyOf/1/nullable
70+
- >-
71+
#/paths/~1NewComePeople~1{UserName}~1Microsoft.OData.Service.Sample.TrippinInMemory.Models.Manager~1Microsoft.OData.Service.Sample.TrippinInMemory.Models.Hire/post/requestBody/content/application~1json/schema/properties/hire/anyOf/1/nullable
72+
- >-
73+
#/paths/~1People~1{UserName}~1Microsoft.OData.Service.Sample.TrippinInMemory.Models.Manager~1Microsoft.OData.Service.Sample.TrippinInMemory.Models.Hire/post/requestBody/content/application~1json/schema/properties/hire/anyOf/1/nullable
74+
- >-
75+
#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Event/allOf/1/properties/OccursAt/anyOf/1/nullable
76+
- >-
77+
#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Flight/allOf/1/properties/Airline/anyOf/1/nullable
78+
- >-
79+
#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Flight/allOf/1/properties/From/anyOf/1/nullable
80+
- >-
81+
#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Flight/allOf/1/properties/To/anyOf/1/nullable
82+
test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Basic.OpenApi.V3.1.yaml:
83+
no-server-example.com:
84+
- '#/servers/0/url'
85+
test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Basic.OpenApi.yaml:
86+
no-server-example.com:
87+
- '#/servers/0/url'
88+
test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Empty.OpenApi.V3.1.yaml:
89+
no-server-example.com:
90+
- '#/servers/0/url'
91+
test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Empty.OpenApi.yaml:
92+
no-server-example.com:
93+
- '#/servers/0/url'
94+
test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Multiple.Schema.OpenApi.V3.1.yaml:
95+
no-server-example.com:
96+
- '#/servers/0/url'
97+
test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Multiple.Schema.OpenApi.yaml:
98+
no-server-example.com:
99+
- '#/servers/0/url'
100+
struct:
101+
- >-
102+
#/components/schemas/Siterra.Documents.BusinessLogic.Entities.Document.DocumentClass/properties/Document/anyOf/1/nullable
103+
- >-
104+
#/components/schemas/Siterra.Documents.BusinessLogic.Entities.Document.DocumentTagRel/properties/Document/anyOf/1/nullable
105+
- >-
106+
#/components/schemas/Siterra.Documents.BusinessLogic.Entities.Document.DocumentTagRel/properties/Tag/anyOf/1/nullable
107+
- >-
108+
#/components/schemas/Siterra.Documents.BusinessLogic.Entities.Library.Library/properties/LibraryParent/anyOf/1/nullable
109+
- >-
110+
#/components/schemas/Siterra.Documents.BusinessLogic.Entities.Library.LibraryType/properties/MasterLibraryType/anyOf/1/nullable
111+
- >-
112+
#/components/schemas/Siterra.Documents.BusinessLogic.Entities.Library.LibraryType/properties/ParentLibraryTypes/anyOf/1/nullable
113+
- >-
114+
#/components/schemas/Siterra.Documents.BusinessLogic.Entities.Library.Library/properties/Type/anyOf/1/nullable
115+
- >-
116+
#/components/schemas/Siterra.Documents.BusinessLogic.Entities.Library.Library/properties/SourceFolder/anyOf/1/nullable
117+
- >-
118+
#/components/schemas/Siterra.Documents.BusinessLogic.Entities.Document.Document/properties/Library/anyOf/1/nullable
119+
- >-
120+
#/components/schemas/Siterra.Documents.BusinessLogic.Entities.Document.Document/properties/LastRevisionFile/anyOf/1/nullable
121+
- >-
122+
#/components/schemas/Siterra.Documents.BusinessLogic.Entities.Document.Document/properties/SourceDocument/anyOf/1/nullable
123+
- >-
124+
#/components/schemas/Siterra.Documents.BusinessLogic.Entities.Revision.Revision/properties/Document/anyOf/1/nullable
125+
- >-
126+
#/components/schemas/Siterra.Documents.App.DTO.RevisionDto/properties/Document/anyOf/1/nullable
127+
test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/TripService.OpenApi.yaml:
128+
struct:
129+
- >-
130+
#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Location/properties/City/anyOf/1/nullable
131+
- >-
132+
#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person/properties/HomeAddress/anyOf/1/nullable
133+
- >-
134+
#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person/properties/BestFriend/anyOf/1/nullable
135+
- >-
136+
#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.AirportLocation/allOf/1/properties/EmergencyAuthority/anyOf/1/nullable
137+
- >-
138+
#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Airport/properties/Location/anyOf/1/nullable
139+
- >-
140+
#/paths/~1GetNearestAirport(lat={lat},lon={lon})/get/responses/200/content/application~1json/schema/anyOf/1/nullable
141+
- >-
142+
#/paths/~1GetPersonWithMostFriends()/get/responses/200/content/application~1json/schema/anyOf/1/nullable
143+
- >-
144+
#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Manager/allOf/1/properties/BossOffice/anyOf/1/nullable
145+
- >-
146+
#/components/responses/GetFavoriteAirlineResponse/content/application~1json/schema/anyOf/1/nullable
147+
- >-
148+
#/paths/~1Me~1Microsoft.OData.Service.Sample.TrippinInMemory.Models.Manager~1Microsoft.OData.Service.Sample.TrippinInMemory.Models.Hire/post/requestBody/content/application~1json/schema/properties/hire/anyOf/1/nullable
149+
- >-
150+
#/paths/~1NewComePeople~1{UserName}~1Microsoft.OData.Service.Sample.TrippinInMemory.Models.Manager~1Microsoft.OData.Service.Sample.TrippinInMemory.Models.Hire/post/requestBody/content/application~1json/schema/properties/hire/anyOf/1/nullable
151+
- >-
152+
#/paths/~1People~1{UserName}~1Microsoft.OData.Service.Sample.TrippinInMemory.Models.Manager~1Microsoft.OData.Service.Sample.TrippinInMemory.Models.Hire/post/requestBody/content/application~1json/schema/properties/hire/anyOf/1/nullable
153+
- >-
154+
#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Event/allOf/1/properties/OccursAt/anyOf/1/nullable
155+
- >-
156+
#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Flight/allOf/1/properties/Airline/anyOf/1/nullable
157+
- >-
158+
#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Flight/allOf/1/properties/From/anyOf/1/nullable
159+
- >-
160+
#/components/schemas/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Flight/allOf/1/properties/To/anyOf/1/nullable

0 commit comments

Comments
 (0)