Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

apidom-reference: internal vs external resolution #3451

Closed
6 tasks done
char0n opened this issue Nov 24, 2023 · 10 comments
Closed
6 tasks done

apidom-reference: internal vs external resolution #3451

char0n opened this issue Nov 24, 2023 · 10 comments
Assignees
@char0n
Labels
ApiDOM enhancement New feature or request OpenAPI 3.1

Comments

@char0n
Copy link
Member

char0n commented Nov 24, 2023 •
edited

Our dereference strategies can be configured to skip resolving external references.

Let's think about if it makes sense to configure allowing/disallowing resolving internal references as well. This will get very complicated with OpenAPI 3.1.0 so needs to be researched first.

Next thing is properly determining what is external and what is internal. Our current mechanism of deciding is IMHO insufficient in OpenAPI 3.1.0 dereference, because of use of JSON Schema 2020-12 $id keyword. If the URI defined in $id keyword is not found within the root definition, we fallback to fetching the URL.

TODO:

  • apidom
  • asyncapi-2
  • openapi-2
  • openapi-3-0
  • openapi-3-1
  • needs to be refactored in swagger-client as well
@char0n char0n self-assigned this Nov 24, 2023
@char0n char0n added enhancement New feature or request OpenAPI 3.1 ApiDOM labels Nov 24, 2023
@char0n char0n mentioned this issue Nov 24, 2023
Closed
6 tasks
@char0n
Copy link
Member Author

char0n commented Nov 24, 2023

For AsyncAPI 2.x, OpenAPI 2.0, OpenAPI 3.0.x - determining what is internal and external reference is quite straightforward. It already works properly (needs to be double-checked just to be sure).

For OpenAPI 3.1.0 - it's quite complicated as already mentioned above:

Next thing is properly determining what is external and what is internal. Our current mechanism of deciding is IMHO insufficient in OpenAPI 3.1.0 dereference, because of use of JSON Schema 2020-12 $id keyword. If the URI defined in $id keyword is not found within the root definition, we fallback to fetching the URL.

Ideally we want a solution is that common for all dereference strategies.

char0n added a commit that referenced this issue Nov 24, 2023
@char0n
fix(reference): fix internal/external URL determ for AsyncAPI 2.x
6737a59 
Refs #3451
@char0n char0n mentioned this issue Nov 24, 2023
Merged
char0n added a commit that referenced this issue Nov 24, 2023
@char0n
fix(reference): fix internal/external URL determination for AsyncAPI …
3cc0791 
…2.x (#3453)

Refs #3451
char0n added a commit that referenced this issue Nov 24, 2023
@char0n
fix(reference): fix internal/external URL determ for OpenAPI 2.0
1eb3b78 
Refs #3451
@char0n char0n mentioned this issue Nov 24, 2023
Merged
char0n added a commit that referenced this issue Nov 24, 2023
@char0n
fix(reference): fix internal/external URL determination for OpenAPI 2…
c720584 
….0 (#3454)

This change will handle cases where the referenced data is served
from the external URL, but the definition is served on the
the same external URL as well.

Refs #3451
char0n added a commit that referenced this issue Nov 24, 2023
@char0n
fix(reference): fix internal/external URL determ for OpenAPI 3.0.x
f0a6980 
Refs #3451
@char0n char0n mentioned this issue Nov 24, 2023
Merged
char0n added a commit that referenced this issue Nov 24, 2023
@char0n
fix(reference): fix internal/external URL determination for OpenAPI 3…
bac4850 
….0.x (#3455)

This change will handle cases where the referenced data is served
from the external URL, but the definition is served on the
the same external URL as well.

Refs #3451
@char0n
Copy link
Member Author

char0n commented Nov 24, 2023

OpenAPI 3.1.0 now remains to be fixed.

char0n added a commit that referenced this issue Nov 27, 2023
@char0n
fix(reference): fix internal/extrernal URL determ for OpenAPI 3.1.0
f688425 
This change will handle cases where the referenced data is served
from the external URL, but the definition is served on the
the same external URL as well.

Refs ##3451
@char0n char0n mentioned this issue Nov 27, 2023
Merged
@char0n
Copy link
Member Author

char0n commented Nov 28, 2023

One more bug related to other dereference strategies than OpenAPI 3.1.0 - all visitors needs to introduce toBaseURI method to determine the URL before it's fetched. Now they do fetch the URL and then stop visiting.

char0n added a commit that referenced this issue Nov 28, 2023
@char0n
fix(reference): fix internal/extrernal URL determ for OpenAPI 3.1.0 (#…
2215480 
…3459)

This change will handle cases where the referenced data is served
from the external URL, but the definition is served on the
the same external URL as well.

Refs #3451
char0n added a commit that referenced this issue Nov 28, 2023
@char0n
fix(reference): lazy fetch URLs only when needed
0152b85 
This change affects all dereference and resolution
strategies.

Refs #3451
@char0n char0n mentioned this issue Nov 28, 2023
Merged
char0n added a commit that referenced this issue Nov 28, 2023
@char0n
fix(reference): lazy fetch URLs only when needed (#3464)
222e3f0 
This change affects all dereference and resolution
strategies.

Refs #3451
@char0n
Copy link
Member Author

char0n commented Nov 28, 2023

What remains now is to add support for options.resolve.internal option into all dereference strategies. This will allow to base resolution strategies on dereference ones and by default set options.resolve.internal=false for all resolution strategies without ability to change it.

char0n added a commit that referenced this issue Mar 7, 2024
@char0n
feat(reference): skip processing internal refererences
9162d1d 
Refs #3451
@char0n char0n mentioned this issue Mar 7, 2024
Merged
@char0n
Copy link
Member Author

char0n commented Mar 7, 2024

apidom resolve strategy addressed in #3902

char0n added a commit that referenced this issue Mar 7, 2024
@char0n
feat(reference): skip processing internal refererences in apidom reso…
0762e8b 
…lve strategy (#3902)

Refs #3451
char0n added a commit that referenced this issue Mar 7, 2024
@char0n
feat(reference): skip processing internal refererences
195fd4c 
Refs #3451
@char0n char0n mentioned this issue Mar 7, 2024
Merged
@char0n
Copy link
Member Author

char0n commented Mar 7, 2024

OpenAPI 2.0 resolve strategy addressed in #3903

@char0n char0n mentioned this issue Mar 7, 2024
Closed
char0n added a commit that referenced this issue Mar 7, 2024
@char0n
feat(reference): skip processing internal refererences in OpenAPI 2.0…
dc787bf 
… resolve strategy (#3903)

Refs #3451
char0n added a commit that referenced this issue Mar 7, 2024
@char0n
feat(reference): add support for skipping internal references
b7db0ef 
Refs #3451
@char0n char0n mentioned this issue Mar 7, 2024
Merged
@char0n
Copy link
Member Author

char0n commented Mar 7, 2024

OpenAPI 3.0 addressed in #3904

char0n added a commit that referenced this issue Mar 7, 2024
@char0n
feat(reference): add support for skipping internal references in Open…
4da622a 
…API 3.0.x dereference strategy (#3904)

Refs #3451
char0n added a commit that referenced this issue Mar 7, 2024
@char0n
feat(reference): add support for skipping internal references
8917473 
Refs #3451
@char0n char0n mentioned this issue Mar 7, 2024
Merged
@char0n
Copy link
Member Author

char0n commented Mar 7, 2024

AsyncAPI 2.0 addressed in #3905

char0n added a commit that referenced this issue Mar 7, 2024
@char0n
feat(reference): eat(reference): add support for skipping internal re…
ad82680 
…ferences in AsyncAPI 2.x dereference strategy (#3905)

Refs #3451
char0n added a commit that referenced this issue Mar 7, 2024
@char0n
feat(reference): add support for skipping internal references
2ae0642 
Refs #3451
@char0n char0n mentioned this issue Mar 7, 2024
Merged
@char0n
Copy link
Member Author

char0n commented Mar 7, 2024

OpenAPI 3.1.0 addressed in #3906

char0n added a commit that referenced this issue Mar 7, 2024
@char0n
feat(reference): add support for skipping internal references in Open…
9d005db 
…API 3.1.0 dereference strategy (#3906)

Refs #3451
char0n added a commit to swagger-api/swagger-js that referenced this issue Mar 7, 2024
@char0n
feat(resolver): adapt OpenAPI 3.1.0 resolver startegy with ApiDOM
a9ae1bd 
Refs swagger-api/apidom#3451
@char0n char0n mentioned this issue Mar 7, 2024
Merged
@char0n
Copy link
Member Author

char0n commented Mar 7, 2024

swaggre-client integration addressed in swagger-api/swagger-js#3403

@char0n char0n closed this as completed Mar 7, 2024
char0n added a commit to swagger-api/swagger-js that referenced this issue Mar 7, 2024
@char0n
feat(resolver): adapt OpenAPI 3.1.0 resolver strategy with ApiDOM@0.9…
8cd8742 
…7.0 (#3403)

Refs swagger-api/apidom#3451
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@char0n char0n

Labels
ApiDOM enhancement New feature or request OpenAPI 3.1
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@char0n