add resource reference field on paths #256
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
toumorokoshi
reviewed
Jan 2, 2025
| @@ -354,6 +354,7 @@ | |||
| 'in': 'path', | |||
| 'required': true, | |||
| 'schema': { 'type': 'string' }, | |||
| 'x-aep-resource-reference': { 'resource': 'Publisher' }, | |||
There was a problem hiding this comment.
these files are autogenerated now. I think you should modify aep-lib-go to add the new field: https://github.com/aep-dev/aep-lib-go/blob/main/pkg/api/openapi.go#L326. Or file an issue.
There was a problem hiding this comment.
There was a problem hiding this comment.
How is this file autogenerated?
There was a problem hiding this comment.
here's a PR documenting it! #258. Since I'm sure it'll come up a lot.
| @@ -411,6 +412,7 @@ | |||
| 'in': 'path', | |||
| 'required': true, | |||
| 'schema': { 'type': 'string' }, | |||
| 'x-aep-resource-reference': { 'resource': 'Publisher' }, | |||
There was a problem hiding this comment.
Suggested change
| 'x-aep-resource-reference': { 'resource': 'Publisher' }, | |
| 'x-aep-resource-reference': { 'resource': 'publisher' }, |
same with the others - we use lower kebab case.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
x-aep-resourceestablishes a list of parents. The individual API endpoints do not establish which fields correspond to a parent resource (if any). This could be established through some guessing, but it's better to annotate these fields specifically.This introduces
x-aep-resource-referenceto indicate that a particular field represents a parent resource. This is super useful for the Resource Explorer in particular.🍱 Types of changes
What types of changes does your code introduce to AEP? Put an
xin the boxesthat apply
📋 Your checklist for this pull request
Please review the AEP Style and Guidance for
contributing to this repository.
General
references AEPs
correctly.
(usually
prettier -w .)💝 Thank you!