Skip to content

fix(133,137): correct Create/Apply HTTP response codes to 201 #406

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.

Sign up for GitHub

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

Open
thegagne wants to merge 4 commits into
base: main
from
+21 −8
Open

fix(133,137): correct Create/Apply HTTP response codes to 201 #406

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e0cc8e3
fix(133,137): correct Create/Apply HTTP response codes to 201
thegagne Mar 24, 2026
2e66397
fix: remove RFC 7231 footnote links from notes
thegagne Mar 25, 2026
52d31de
fix: remove notes, keep status code guidance only
thegagne Mar 25, 2026
34582b0
fix: use must for 201 response code guidance
thegagne Mar 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion aep/general/0133/aep.md.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,8 +90,9 @@ Create methods implement a common request message pattern:

{% tab oas %}

{% sample '../example.oas.yaml', '$.paths./publishers/{publisher_id}/books.post.responses.200' %}
{% sample '../example.oas.yaml', '$.paths./publishers/{publisher_id}/books.post.responses.201' %}

- The response **must** return a `201 Created` HTTP status code.
- The response **must** be the resource itself. There is no separate response
schema.
- The response **should** include the fully-populated resource, and **must**
Expand Down
2 changes: 1 addition & 1 deletion aep/general/0137/aep.md.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ Apply methods implement a common request message pattern:

{% tab oas %}

{% sample '../example.oas.yaml', '$.paths./publishers/{publisher_id}/books/{book_id}.put.responses.200' %}
{% sample '../example.oas.yaml', '$.paths./publishers/{publisher_id}/books/{book_id}.put.responses' %}

- If the resource is created, the response **must** return a `201` status code.
- If the resource is updated, the response **must** return a `200` status code.
Expand Down
24 changes: 18 additions & 6 deletions aep/general/example.oas.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ paths:
$ref: '#/components/schemas/isbn'
required: true
responses:
'200':
'201':
Copy link
Copy Markdown
Member

@toumorokoshi toumorokoshi Mar 24, 2026

Choose a reason for hiding this comment

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

these examples are generated via aepc: https://github.com/aep-dev/aepc. It would be great to update that first. But I can do so after to align if that's too much effort.

Copy link
Copy Markdown
Contributor Author

@thegagne thegagne Mar 25, 2026

Choose a reason for hiding this comment

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

I'll give it a shot.

Copy link
Copy Markdown
Contributor Author

@thegagne thegagne Mar 25, 2026

Choose a reason for hiding this comment

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

aep-dev/aep-lib-go#15 - I think this needs to happen first unless I'm mistaken?

Copy link
Copy Markdown
Member

@toumorokoshi toumorokoshi Mar 30, 2026

Choose a reason for hiding this comment

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

yep! thanks for drafting that, and it's a go get to update aepc.

content:
application/json:
schema:
Expand Down Expand Up @@ -269,7 +269,7 @@ paths:
$ref: '#/components/schemas/publisher'
required: true
responses:
'200':
'201':
content:
application/json:
schema:
Expand Down Expand Up @@ -354,7 +354,13 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/publisher'
description: Successful response
description: Successful response (updated)
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/publisher'
description: Successful response (created)
/publishers/{publisher_id}/books:
get:
description: List method for book
Expand Down Expand Up @@ -411,7 +417,7 @@ paths:
$ref: '#/components/schemas/book'
required: true
responses:
'200':
'201':
content:
application/json:
schema:
Expand Down Expand Up @@ -516,7 +522,13 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/book'
description: Successful response
description: Successful response (updated)
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/book'
description: Successful response (created)
/publishers/{publisher_id}/books/{book_id}/editions:
get:
description: List method for book-edition
Expand Down Expand Up @@ -579,7 +591,7 @@ paths:
$ref: '#/components/schemas/book-edition'
required: true
responses:
'200':
'201':
content:
application/json:
schema:
Expand Down