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.

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

Add mediaType attribute to Reference Object #31

Closed
andrea-gioia opened this issue May 11, 2024 Discussed in #17 · 0 comments
Closed

Add mediaType attribute to Reference Object #31

andrea-gioia opened this issue May 11, 2024 Discussed in #17 · 0 comments
Assignees
Labels
🏁 Accepted (RFC 3) RFC Stage 3 (See CONTRIBUTING.md) 👻 Needs Champion RFC Needs a champion to progress (See CONTRIBUTING.md) 📙 RFC
Milestone

Comments

@andrea-gioia
Copy link
Contributor

andrea-gioia commented May 11, 2024

Add mediaType attribute to Reference Object

Champion: @andrea-gioia

Summary

Add mediaType attribute to Reference Object

Motivation

We need the mediaType attribute to referentiating external resources with an encoding different from the one of the root entity of the descriptor file

Design and examples

Field Name Type Description
description string A description which by default SHOULD override that of the referenced component. CommonMark syntax MAY be used for rich text representation. If the referenced object type does not allow a description field, then this field has no effect.
mediaType string The media type of the referenced resource. It must conform to media type format, according to RFC6838.
$ref string:uri-reference REQUIRED. The reference identifier. This MUST be in the form of a URI.

Alternatives

Add mediaType attribute to Reference Object and at the same time remove External Reference Object. Reference Object can then be used to resolve all the references, internal end external as well.

Decision

We decided to add mediaType attribute to Reference Object and keep External Reference Object to differentiate clearly internal references that should be evaluated by external tools from external references that can be ignored.

Consequences

NA

References

NA

@andrea-gioia andrea-gioia added this to the spec v1.0.0 milestone May 11, 2024
@andrea-gioia andrea-gioia changed the title Write a proposal ti add mediaType attribute to Reference Object Write a proposal to Add mediaType attribute to Reference Object May 11, 2024
@andrea-gioia andrea-gioia changed the title Write a proposal to Add mediaType attribute to Reference Object RFC-000001: Add mediaType attribute to Reference Object May 11, 2024
@andrea-gioia andrea-gioia added 📙 RFC 💭 Strawman (RFC 0) RFC Stage 0 (See CONTRIBUTING.md) 👻 Needs Champion RFC Needs a champion to progress (See CONTRIBUTING.md) and removed enhancement labels May 11, 2024
@andrea-gioia andrea-gioia changed the title RFC-000001: Add mediaType attribute to Reference Object Add mediaType attribute to Reference Object May 27, 2024
@andrea-gioia andrea-gioia self-assigned this Jun 12, 2024
@andrea-gioia andrea-gioia added 🏁 Accepted (RFC 3) RFC Stage 3 (See CONTRIBUTING.md) and removed 💭 Strawman (RFC 0) RFC Stage 0 (See CONTRIBUTING.md) labels Jun 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🏁 Accepted (RFC 3) RFC Stage 3 (See CONTRIBUTING.md) 👻 Needs Champion RFC Needs a champion to progress (See CONTRIBUTING.md) 📙 RFC
Projects
Status: Done
Development

No branches or pull requests

1 participant