diff --git a/aep/general/0132/aep.md.j2 b/aep/general/0132/aep.md.j2 index ffb309f3..1b24b6d8 100644 --- a/aep/general/0132/aep.md.j2 +++ b/aep/general/0132/aep.md.j2 @@ -194,7 +194,7 @@ when the REST/JSON interface is used. `List` operations **must** be specified with consistent OpenAPI metadata: -{% sample 'list.oas.yaml', 'paths' %} +{% sample 'list.oas.yaml', '$.paths' %} - The `operationId` **must** begin with the word `list`. The remainder of the `operationId` **should** be the plural form of the resource type's name. diff --git a/aep/general/0135/aep.md.j2 b/aep/general/0135/aep.md.j2 index aa956ac1..5c1c4133 100644 --- a/aep/general/0135/aep.md.j2 +++ b/aep/general/0135/aep.md.j2 @@ -59,7 +59,7 @@ rpc DeleteBook(DeleteBookRequest) returns (google.protobuf.Empty) { {% tab oas %} -{% sample 'delete.oas.yaml', 'paths' %} +{% sample 'delete.oas.yaml', '$.paths' %} - The response body **should** be omitted. - The HTTP response code **should** be `204 No Content` if the delete was @@ -104,7 +104,7 @@ message DeleteBookRequest { {% tab oas -%} -{% sample 'delete.oas.yaml', 'paths' %} +{% sample 'delete.oas.yaml', '$.paths' %} - Delete methods **should** return `204 No Content` with no response body, or `202 Accepted` with a representation of the operation in the response body if @@ -149,7 +149,7 @@ rpc DeleteBook(DeleteBookRequest) returns (aep.api.Operation) { {% tab oas -%} -{% sample 'long_running_delete.oas.yaml', 'paths' %} +{% sample 'long_running_delete.oas.yaml', '$.paths' %} - The response status code should be `202 Accepted` if the request was accepted for later processing. When the request is processed it could still fail. @@ -191,7 +191,7 @@ is `false` (or unset) and child resources are present. {% tab oas -%} -{% sample 'cascading_delete.oas.yaml', 'paths' %} +{% sample 'cascading_delete.oas.yaml', '$.paths' %} The API **must** fail with a `409 Conflict` error if the `force` field is `false` (or unset) and child resources are present. diff --git a/aep/general/0136/aep.md.j2 b/aep/general/0136/aep.md.j2 index 361d0f73..756d440d 100644 --- a/aep/general/0136/aep.md.j2 +++ b/aep/general/0136/aep.md.j2 @@ -45,7 +45,7 @@ apply consistently: {% tab oas %} -{% sample 'library.oas.yaml', '$.paths.\/publishers\/{publisherId}\/books\/{bookId}:archive' %} +{% sample 'library.oas.yaml', '$.paths./publishers/{publisherId}/books/{bookId}:archive' %} - The name of the RPC **should** be a verb followed by a noun. - The name of the RPC **must not** contain prepositions ("for", "with", @@ -86,7 +86,7 @@ While most custom methods operate on a single resource, some custom methods {% tab oas %} -{% sample 'library.oas.yaml', '$.paths.\/publishers\/{publisherId}\/books:sort' %} +{% sample 'library.oas.yaml', '$.paths./publishers/{publisherId}/books:sort' %} {% endtabs %} @@ -106,7 +106,7 @@ permanent effect on data within the API. {% tab oas %} -{% sample 'translate.oas.yaml', '$.paths.\/projects\/{projectId}:translateText' %} +{% sample 'translate.oas.yaml', '$.paths./projects/{projectId}:translateText' %} {% endtabs %} diff --git a/aep/general/0144/aep.md.j2 b/aep/general/0144/aep.md.j2 index 71464a0d..4abbff93 100644 --- a/aep/general/0144/aep.md.j2 +++ b/aep/general/0144/aep.md.j2 @@ -111,7 +111,7 @@ define custom methods using the verbs `Add` and `Remove`: {% tab oas %} -{% sample 'add_remove.oas.yaml', 'paths' %} +{% sample 'add_remove.oas.yaml', '$.paths' %} - The data being added or removed **should** be a primitive (usually a `string`). @@ -157,7 +157,7 @@ subresource instead. {% tab oas %} -{% sample 'add_remove.oas.yaml', 'requestBody' %} +{% sample 'add_remove.oas.yaml', '$./publishers/{publisherId}/books/{bookId}:addAuthor.requestBody' %} - A field for the value being added or removed **must** be included. It **should** be the singular name of the field. diff --git a/aep/general/0151/aep.md.j2 b/aep/general/0151/aep.md.j2 index 42b42d5e..41fd9a1e 100644 --- a/aep/general/0151/aep.md.j2 +++ b/aep/general/0151/aep.md.j2 @@ -133,7 +133,7 @@ When using protocol buffers, the common component {% tab oas %} -{% sample 'lro.oas.yaml', 'paths' %} +{% sample 'lro.oas.yaml', '$.paths' %} - `202` **must** be the only success status code defined. - The `202` response **must** define an `application/json` response body and no diff --git a/aep/general/0164/aep.md.j2 b/aep/general/0164/aep.md.j2 index 9e5c5bd6..c678e7f2 100644 --- a/aep/general/0164/aep.md.j2 +++ b/aep/general/0164/aep.md.j2 @@ -48,7 +48,7 @@ A resource that supports soft delete **should** provide an `Undelete` method: {% tab oas %} -{% sample 'undelete.oas.yaml', 'paths' %} +{% sample 'undelete.oas.yaml', '$.paths' %} - The HTTP method **must** be `POST`. - The response message **must** be the resource itself. diff --git a/aep/general/0231/aep.md.j2 b/aep/general/0231/aep.md.j2 index a76ea427..0376e164 100644 --- a/aep/general/0231/aep.md.j2 +++ b/aep/general/0231/aep.md.j2 @@ -84,7 +84,7 @@ message BatchGetBooksRequest { {% tab oas %} -{% sample 'batchget.oas.yaml', 'paths' %} +{% sample 'batchget.oas.yaml', '$.paths' %} - The `paths` parameter **must** be a query parameter which accepts an array of resource paths specifying the resources to retrieve. @@ -124,7 +124,7 @@ message BatchGetBooksResponse { {% tab oas %} -{% sample 'batchget.oas.yaml', '/publishers/{publisherId}/books:BatchGet' %} +{% sample 'batchget.oas.yaml', '$.paths./publishers/{publisherId}/books:BatchGet' %} Example response body: