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

OAS examples for standard methods #215

Closed
wants to merge 3 commits into from

Conversation

rambleraptor
Copy link
Member

Fixes #118

This adds OAS examples + guidance for the rest of the standard methods.

🍱 Types of changes

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

  • Enhancement

📋 Your checklist for this pull request

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

General

Additional checklist for a new AEP

  • A new AEP should be no more than two pages if printed out.
  • Ensure that the PR is editable by maintainers.
  • Ensure that File structure
    guidelines are met.
  • Ensure that
    Document structure
    guidelines are met.

💝 Thank you!

@rambleraptor rambleraptor requested a review from a team as a code owner August 23, 2024 23:14
@rambleraptor rambleraptor changed the title OAS examples for OAS examples for standard methods Aug 23, 2024
description: A representation of a single book.
type: object
properties:
name:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Other examples skip the full resource definition. Since you've added the full resource, name be path? I find path in AEP-122 and AEP-148 and no references to name.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same comment for the Book component schemas in the other examples.

@toumorokoshi toumorokoshi added this to the GA milestone Nov 5, 2024
@toumorokoshi
Copy link
Member

@rambleraptor can we close this in favor of #232?

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.

AIP-134: author an OAS example.
3 participants