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.

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

Issues found during site-generator building #219

Merged
merged 1 commit into from
Sep 9, 2024
Merged

Issues found during site-generator building #219

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions aep/general/0134/aep.md.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,9 +136,11 @@ using `PUT`.

To illustrate this, consider a `PUT` request to a `Book` resource:

```
PUT /v1/publishers/123/books/456

{"title": "Mary Poppins", "author": "P.L. Travers"}
```

Next consider that the resource is later augmented with a new field (here we
add `rating`, and use a protobuf example without loss of generality):
Expand Down
4 changes: 4 additions & 0 deletions aep/general/0159/aep.md.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,10 @@ guidance in [unreachable resources].
specified with `*` and permit the collection to be specified; a URI pattern
**must not** hard-code the `-` character.

{% tab oas %}
toumorokoshi marked this conversation as resolved.
Show resolved Hide resolved

Note: OAS guidance is yet to be written.

{% endtabs %}

### Unique resource lookup
Expand Down
8 changes: 4 additions & 4 deletions aep/general/0193/aep.md.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,10 +65,6 @@ A JSON representation of an error response might look like the following:
}
```

{% tab oas -%}

The media-type for an error response should be "application/problem+json".

{% tab proto -%}

Services **must** return a [`google.rpc.Status`][Status] message when an API
Expand All @@ -81,6 +77,10 @@ The error response structure defined above **should** be returned in the
[`aep.api.ProblemDetails`](https://buf.build/aep/api/docs/main:aep.api#aep.api.ProblemDetails)
to define this field.

{% tab oas -%}

The media-type for an error response should be "application/problem+json".

{% endtabs %}

#### Dynamic variables
Expand Down
Loading