Skip to content

fix: comment out placeholders in CAMARA_common.yaml for $ref consumption #602

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
hdamker wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: comment out placeholders in CAMARA_common.yaml for $ref consumption #602

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
76 changes: 38 additions & 38 deletions artifacts/CAMARA_common.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -309,7 +309,7 @@ components:
enum:
- INVALID_ARGUMENT
- OUT_OF_RANGE
- "{{SPECIFIC_CODE}}"
# - "{{SPECIFIC_CODE}}" - API-specific codes added if needed
examples:
GENERIC_400_INVALID_ARGUMENT:
description: Invalid Argument. Generic Syntax Exception
Expand All @@ -323,12 +323,12 @@ components:
status: 400
code: OUT_OF_RANGE
message: Client specified an invalid range.
GENERIC_400_{{SPECIFIC_CODE}}:
description: Specific Syntax Exception regarding a field that is relevant in the context of the API
value:
status: 400
code: "{{SPECIFIC_CODE}}"
message: Message for specific code
# GENERIC_400_{{SPECIFIC_CODE}}:
# description: Specific Syntax Exception regarding a field that is relevant in the context of the API
# value:
# status: 400
# code: "{{SPECIFIC_CODE}}"
# message: Message for specific code
Generic401:
description: Unauthorized
headers:
Expand Down Expand Up @@ -373,7 +373,7 @@ components:
enum:
- PERMISSION_DENIED
- INVALID_TOKEN_CONTEXT
- "{{SPECIFIC_CODE}}"
# - "{{SPECIFIC_CODE}}" - API-specific codes added if needed
examples:
GENERIC_403_PERMISSION_DENIED:
description: Permission denied. OAuth2 token access does not have the required scope or when the user fails operational security
Expand All @@ -386,13 +386,14 @@ components:
value:
status: 403
code: INVALID_TOKEN_CONTEXT
message: "{{field}} is not consistent with access token."
GENERIC_403_{{SPECIFIC_CODE}}:
description: Indicate a Business Logic condition that forbids a process not attached to a specific field in the context of the API
value:
status: 403
code: "{{SPECIFIC_CODE}}"
message: Message for specific code
# message: "{{field}} is not consistent with access token."
message: "... is not consistent with access token."
# GENERIC_403_{{SPECIFIC_CODE}}:
# description: Indicate a Business Logic condition that forbids a process not attached to a specific field in the context of the API
# value:
# status: 403
# code: "{{SPECIFIC_CODE}}"
# message: Message for specific code
Generic404:
description: Not found
headers:
Expand All @@ -412,7 +413,7 @@ components:
enum:
- NOT_FOUND
- IDENTIFIER_NOT_FOUND
- "{{SPECIFIC_CODE}}"
# - "{{SPECIFIC_CODE}}" - API-specific codes added if needed
examples:
GENERIC_404_NOT_FOUND:
description: Resource is not found
Expand All @@ -426,12 +427,12 @@ components:
status: 404
code: IDENTIFIER_NOT_FOUND
message: Device identifier not found.
GENERIC_404_{{SPECIFIC_CODE}}:
description: Specific situation to highlight the resource/concept not found
value:
status: 404
code: "{{SPECIFIC_CODE}}"
message: Message for specific code
# GENERIC_404_{{SPECIFIC_CODE}}:
# description: Specific situation to highlight the resource/concept not found
# value:
# status: 404
# code: "{{SPECIFIC_CODE}}"
# message: Message for specific code
Generic405:
description: Method Not Allowed
headers:
Expand Down Expand Up @@ -503,7 +504,7 @@ components:
- ALREADY_EXISTS
- CONFLICT
- INCOMPATIBLE_STATE
- "{{SPECIFIC_CODE}}"
# - "{{SPECIFIC_CODE}}" - API-specific codes added if needed
examples:
GENERIC_409_ABORTED:
description: The resource is undergoing modification by another process
Expand All @@ -521,7 +522,7 @@ components:
###################################
# This Error Code is DEPRECATED
###################################
description: Duplication of an existing resource
description: Duplication of an existing resource
value:
status: 409
code: CONFLICT
Expand All @@ -533,13 +534,12 @@ components:
status: 409
code: INCOMPATIBLE_STATE
message: Resource must be in AVAILABLE state to extend. Current state is UNAVAILABLE.

GENERIC_409_{{SPECIFIC_CODE}}:
description: Specific conflict situation that is relevant in the context of the API
value:
status: 409
code: "{{SPECIFIC_CODE}}"
message: Message for specific code
# GENERIC_409_{{SPECIFIC_CODE}}:
# description: Specific conflict situation that is relevant in the context of the API
# value:
# status: 409
# code: "{{SPECIFIC_CODE}}"
# message: Message for specific code
Generic410:
description: Gone
headers:
Expand Down Expand Up @@ -636,7 +636,7 @@ components:
- MISSING_IDENTIFIER
- UNSUPPORTED_IDENTIFIER
- UNNECESSARY_IDENTIFIER
- "{{SPECIFIC_CODE}}"
# - "{{SPECIFIC_CODE}}" - API-specific codes added if needed
examples:
GENERIC_422_SERVICE_NOT_APPLICABLE:
description: Service not applicable for the provided identifier
Expand All @@ -662,12 +662,12 @@ components:
status: 422
code: UNNECESSARY_IDENTIFIER
message: The device is already identified by the access token.
GENERIC_422_{{SPECIFIC_CODE}}:
description: Any semantic condition associated to business logic, specifically related to a field or data structure
value:
status: 422
code: "{{SPECIFIC_CODE}}"
message: Message for specific code
# GENERIC_422_{{SPECIFIC_CODE}}:
# description: Any semantic condition associated to business logic, specifically related to a field or data structure
# value:
# status: 422
# code: "{{SPECIFIC_CODE}}"
# message: Message for specific code
Generic429:
description: Too Many Requests
headers:
Expand Down