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

openapi snippets are not rendering #43

Closed
toumorokoshi opened this issue Oct 19, 2024 · 2 comments
Closed

openapi snippets are not rendering #43

toumorokoshi opened this issue Oct 19, 2024 · 2 comments

Comments

@toumorokoshi
Copy link
Member

example: http://localhost:4002/151#interface-definitions.

compare the original site, and the beta generator.
20241019_13h14m20s_grim
20241019_13h14m14s_grim

@toumorokoshi
Copy link
Member Author

this blocks fully addressing aep-dev/aeps#224

@toumorokoshi
Copy link
Member Author

Another note - it would be great if the selector syntax could somehow selectively choose a sub-element.

For example in OAS, the list and create endpoints are both mounted under the resource collection name. For example, the following syntax:

{% sample '../oas.yaml', '/publishers/{publisher_id}/books:' %}

On a complete OAS example renders:

20241021_21h14m00s_grim

It'd be great if you could just select the post method here, since the example is supposed to be for create. Maybe something json-path-ish:

{% sample '../oas.yaml', '"/publishers/{publisher_id}/books".get' %}

that will implicitly include the parent so that it's easy to figure out the position?

toumorokoshi added a commit to toumorokoshi/aep.dev that referenced this issue Oct 22, 2024
Adding oas examples for create.

This also tests out the pattern outlined in aep-dev#230 - 
adding a generated oas.yaml and use selective elements from it
as an example, which looks to work pretty well.

There is a blocker on aep-dev/site-generator#43
to allow for support from a json-path like structure to target sub-elements, but
this will at least allow for selective guidance to be easily added.
toumorokoshi added a commit to toumorokoshi/aep.dev that referenced this issue Nov 5, 2024
Adding oas examples for create.

This also tests out the pattern outlined in aep-dev#230 - 
adding a generated oas.yaml and use selective elements from it
as an example, which looks to work pretty well.

There is a blocker on aep-dev/site-generator#43
to allow for support from a json-path like structure to target sub-elements, but
this will at least allow for selective guidance to be easily added.
toumorokoshi added a commit to toumorokoshi/aep.dev that referenced this issue Nov 5, 2024
Adding oas examples for create.

This also tests out the pattern outlined in aep-dev#230 - 
adding a generated oas.yaml and use selective elements from it
as an example, which looks to work pretty well.

There is a blocker on aep-dev/site-generator#43
to allow for support from a json-path like structure to target sub-elements, but
this will at least allow for selective guidance to be easily added.
toumorokoshi added a commit to toumorokoshi/aep.dev that referenced this issue Nov 5, 2024
Adding oas examples for create.

This also tests out the pattern outlined in aep-dev#230 - 
adding a generated oas.yaml and use selective elements from it
as an example, which looks to work pretty well.

There is a blocker on aep-dev/site-generator#43
to allow for support from a json-path like structure to target sub-elements, but
this will at least allow for selective guidance to be easily added.
toumorokoshi added a commit to toumorokoshi/aep.dev that referenced this issue Nov 6, 2024
Adding oas examples for create.

This also tests out the pattern outlined in aep-dev#230 - 
adding a generated oas.yaml and use selective elements from it
as an example, which looks to work pretty well.

There is a blocker on aep-dev/site-generator#43
to allow for support from a json-path like structure to target sub-elements, but
this will at least allow for selective guidance to be easily added.
toumorokoshi added a commit to aep-dev/aeps that referenced this issue Nov 6, 2024
Adding oas examples for create.

This also tests out the pattern outlined in #230 - 
adding a generated oas.yaml and use selective elements from it
as an example, which looks to work pretty well.

There is a blocker on aep-dev/site-generator#43
to allow for support from a json-path like structure to target sub-elements, but
this will at least allow for selective guidance to be easily added.
---------

Co-authored-by: Richard Frankel <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants