Skip to content

Commit

Permalink
Add note about the json schema dereferencing limitation
Browse files Browse the repository at this point in the history
  • Loading branch information
carlesarnal committed Apr 29, 2024
1 parent 2637cd3 commit fcc8640
Showing 1 changed file with 4 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -150,9 +150,11 @@ $ curl -H "Authorization: Bearer $ACCESS_TOKEN" MY-REGISTRY-URL/apis/registry/v2

There are some cases where returning artifact content with referenced content inline might be helpful. For these cases, the Core Registry API v2 supports the `dereference` query parameter in certain operations.

This support is currently implemented only for Avro and Protobuf artifacts when the `dereference` parameter is specified in the API operation. This parameter is not supported for any other artifact types.
This support is currently implemented only for Avro, Protobuf, and JSON Schema artifacts when the `dereference` parameter is specified in the API operation. This parameter is not supported for any other artifact types.

NOTE: For Protobuf artifacts, dereferencing content is supported only when all of the schemas belong to the same package.
NOTE: For Protobuf artifacts, dereferencing content is supported only when all the schemas belong to the same package.

NOTE: For JSON Schema artifacts, dereferencing content is supported only for artifacts that reference the full content of a separate artifact. Dereferencing when an artifact references a part of a second artifact is *not* supported


[role="_additional-resources"]
Expand Down

0 comments on commit fcc8640

Please sign in to comment.