Skip to content

feat(ipa): enrich IPA-104 Get with Guideline components #65

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

Draft
andmatei wants to merge 1 commit into
base: CLOUDP-399897-ipa-103-methods
Choose a base branch
from
Draft

feat(ipa): enrich IPA-104 Get with Guideline components #65

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
10 changes: 5 additions & 5 deletions ipa/general/0101.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ resource.

The methods can be:

- The standard methods ([Get](0104.md), [List](0105.md), [Create](0106.md),
- The standard methods ([Get](0104.mdx), [List](0105.md), [Create](0106.md),
[Update](0107.md), [Delete](0108.md))
- [Custom methods](0109.md)

Expand All @@ -72,7 +72,7 @@ standard methods:
| Delete | None | None |
| List | None | Are the resources |

- A resource **must** support at minimum [Get](0104.md)
- A resource **must** support at minimum [Get](0104.mdx)
- Clients **must** be able to validate the state of resources after performing
a mutation such as [Create](0106.md), [Update](0107.md), or
[Delete](0108.md)
Expand All @@ -86,7 +86,7 @@ standard methods:

Read-only resources are resources that cannot be modified by API consumers.

- Read-only resources **must** have [Get](0104.md) and [List](0105.md) methods
- Read-only resources **must** have [Get](0104.mdx) and [List](0105.md) methods
- Read-only resources **must not** have [Create](0106.md), [Update](0107.md), or
[Delete](0108.md) methods
- Read-only resources **may** have [custom methods](0109.md) as appropriate
Expand Down Expand Up @@ -373,7 +373,7 @@ components:

<Guideline id="IPA-0101-must-support-get" given="resource" effort="reason">

A resource **must** support at minimum the [Get](0104.md) method.
A resource **must** support at minimum the [Get](0104.mdx) method.

<Example.Correct>

Expand Down Expand Up @@ -580,7 +580,7 @@ paths:
effort="reason"
>

Read-only resources **must** have [Get](0104.md) and [List](0105.md) methods.
Read-only resources **must** have [Get](0104.mdx) and [List](0105.md) methods.

<Example.Correct>

Expand Down
56 changes: 0 additions & 56 deletions ipa/general/0104.md
View file
Open in desktop

This file was deleted.

Loading
Loading