Skip to content

fix(132): remove leftover plural-name rule for list response field - #423

Open
laurencehook-lr wants to merge 1 commit into
aep-dev:mainfrom
laurencehook-lr:fix-132-results-field
Open

laurencehook-lr wants to merge 1 commit into
aep-dev:mainfrom
laurencehook-lr:fix-132-results-field

Conversation

@laurencehook-lr

Copy link
Copy Markdown

Line 102 of AEP-132 requires the list response array to be named results (added in #355), and the OAS tab (line 129) and the generated ListBooksResponse example agree. The bullet at lines 114–116 still said the field must be "named for the English plural term for the resource", which looks like a leftover from the AIP text and contradicts line 102. #378 made the same alignment for AEP-231.

This rewords the bullet so it no longer conflicts, and keeps the "no other repeated fields" constraint. make check passes.

Supersedes #422 (same change, clean commit message).

🍱 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

💝 Thank you!

Line 102 requires the list response array to be named `results`; the bullet at lines 114-116 still said it must be named for the English plural term. Reword it so it no longer conflicts.

@mkistler mkistler left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks good. 👍

This change is good because it eliminates inconsistency / confusion in this AEP.

I wish we had captured somewhere the rationale for fixing the name of the array field as "results" rather than follow the AIP guidance of using the plural name of the resource. But we can address that in a separate PR -- if indeed we can even recover that information.

This branch has not been deployed

No deployments
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