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

fix(133): add oas examples #232

Merged
merged 3 commits into from
Nov 6, 2024
Merged

Conversation

toumorokoshi
Copy link
Member

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.

This PR also does some smaller changes to flesh out or normalize the oas guidance, including removing
the example LRO in exchange for just referencing it instead.

🍱 Types of changes

What types of changes does your code introduce to AEP? Put an x in the boxes
that apply

  • Enhancement
  • New proposal
  • Migrated from google.aip.dev
  • Chore / Quick Fix

📋 Your checklist for this pull request

Please review the AEP Style and Guidance for
contributing to this repository.

General

@toumorokoshi
Copy link
Member Author

depends on #240 now (written on top of that PR).

@toumorokoshi toumorokoshi force-pushed the yft/create branch 2 times, most recently from 6d8c72c to c81b7a4 Compare November 5, 2024 19:37
@toumorokoshi toumorokoshi added this to the GA milestone Nov 5, 2024
aep/general/0133/aep.md.j2 Outdated Show resolved Hide resolved
aep/general/oas.yaml Outdated Show resolved Hide resolved
aep/general/oas.yaml Outdated Show resolved Hide resolved
@toumorokoshi toumorokoshi force-pushed the yft/create branch 2 times, most recently from 59f5b8b to 85e1d42 Compare November 5, 2024 21:44
toumorokoshi and others added 2 commits November 6, 2024 08:56
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.
- incorrect syntax in 132 create.
@toumorokoshi
Copy link
Member Author

toumorokoshi commented Nov 6, 2024

updated to no longer rely on #240, which is closed.

@toumorokoshi toumorokoshi merged commit cb2a30a into aep-dev:main Nov 6, 2024
2 checks passed
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

Successfully merging this pull request may close these issues.

2 participants