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

description in sinkCredential #271

Closed
jlurien opened this issue Aug 5, 2024 · 3 comments
Closed

description in sinkCredential #271

jlurien opened this issue Aug 5, 2024 · 3 comments
Labels
correction correction in documentation

Comments

@jlurien
Copy link
Contributor

jlurien commented Aug 5, 2024

Problem description

The current syntax with description under allOf was reported to cause problems with generators

        sinkCredential:
          allOf:
            - description: A sink credential provides authentication or authorization information necessary to enable delivery of events to a target.
            - $ref: "#/components/schemas/SinkCredential"

Expected behavior
In this case description could be moved to SinkCredential schema; as it is generic enough to be reused in the 2 $ref to this schema, and the allOf above can be removed.

@rartych
Copy link
Collaborator

rartych commented Aug 5, 2024

We need to close RC.2 very soon, but for me the proposed correction is important for all subscription related APIs.
As we have still open PR #267 with changes in subscription template, I added the proposed changes.
@jlurien please review it.

@jlurien
Copy link
Contributor Author

jlurien commented Aug 6, 2024

The change LGTM, but @PedroDiez will review formally the other PR on behalf of TEF

@rartych
Copy link
Collaborator

rartych commented Aug 8, 2024

Closing as resolved in #267

@rartych rartych closed this as completed Aug 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
correction correction in documentation
Projects
None yet
Development

No branches or pull requests

2 participants