Skip to content

Fix stale API Readiness Checklist pointer in mandatory error-response template #693

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 stale API Readiness Checklist pointer in mandatory error-response template #693

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: 1 addition & 1 deletion artifacts/api-templates/sample-implicit-events.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@

The list of error codes in this API specification is not exhaustive. Therefore the API specification MAY not document some non-mandatory error statuses as indicated in `CAMARA API Design Guide`.

Please refer to the `CAMARA_common.yaml` of the Commonalities Release associated to this API version for a complete list of error responses. The applicable Commonalities Release can be identified in the `API Readiness Checklist` document associated to this API version.
Please refer to the `CAMARA_common.yaml` of the Commonalities Release associated to this API version for a complete list of error responses. The applicable Commonalities Release can be identified from the `x-camara-commonalities` field, the changelog and the metadata of the released API version.

As a specific rule, error `501 - NOT_IMPLEMENTED` can be only a possible error response if it is explicitly documented in the API.
<!-- CAMARA:MANDATORY:additional-error-responses:END -->
Expand Down Expand Up @@ -405,10 +405,10 @@
required:
- name
properties:
name:
type: string
maxLength: 128
description: Human-readable name for the resource

Check warning on line 411 in artifacts/api-templates/sample-implicit-events.yaml

View workflow job for this annotation

GitHub Actions / Lint artifacts

owasp:api4:2023-string-restricted 

Schema of type string should specify a format, pattern, enum, or const.
device:
$ref: "../common/CAMARA_common.yaml#/components/schemas/Device"
sink:
Expand All @@ -435,10 +435,10 @@
properties:
resourceId:
$ref: "#/components/schemas/ResourceId"
name:
type: string
maxLength: 128
description: Human-readable name for the resource

Check warning on line 441 in artifacts/api-templates/sample-implicit-events.yaml

View workflow job for this annotation

GitHub Actions / Lint artifacts

owasp:api4:2023-string-restricted 

Schema of type string should specify a format, pattern, enum, or const.
device:
$ref: "../common/CAMARA_common.yaml#/components/schemas/Device"
sink:
Expand Down
2 changes: 1 addition & 1 deletion artifacts/api-templates/sample-service-subscriptions.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ info:

The list of error codes in this API specification is not exhaustive. Therefore the API specification MAY not document some non-mandatory error statuses as indicated in `CAMARA API Design Guide`.

Please refer to the `CAMARA_common.yaml` of the Commonalities Release associated to this API version for a complete list of error responses. The applicable Commonalities Release can be identified in the `API Readiness Checklist` document associated to this API version.
Please refer to the `CAMARA_common.yaml` of the Commonalities Release associated to this API version for a complete list of error responses. The applicable Commonalities Release can be identified from the `x-camara-commonalities` field, the changelog and the metadata of the released API version.

As a specific rule, error `501 - NOT_IMPLEMENTED` can be only a possible error response if it is explicitly documented in the API.
<!-- CAMARA:MANDATORY:additional-error-responses:END -->
Expand Down
2 changes: 1 addition & 1 deletion artifacts/api-templates/sample-service.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@

The list of error codes in this API specification is not exhaustive. Therefore the API specification MAY not document some non-mandatory error statuses as indicated in `CAMARA API Design Guide`.

Please refer to the `CAMARA_common.yaml` of the Commonalities Release associated to this API version for a complete list of error responses. The applicable Commonalities Release can be identified in the `API Readiness Checklist` document associated to this API version.
Please refer to the `CAMARA_common.yaml` of the Commonalities Release associated to this API version for a complete list of error responses. The applicable Commonalities Release can be identified from the `x-camara-commonalities` field, the changelog and the metadata of the released API version.

As a specific rule, error `501 - NOT_IMPLEMENTED` can be only a possible error response if it is explicitly documented in the API.
<!-- CAMARA:MANDATORY:additional-error-responses:END -->
Expand Down Expand Up @@ -275,10 +275,10 @@
required:
- name
properties:
name:
type: string
maxLength: 128
description: Human-readable name for the resource

Check warning on line 281 in artifacts/api-templates/sample-service.yaml

View workflow job for this annotation

GitHub Actions / Lint artifacts

owasp:api4:2023-string-restricted 

Schema of type string should specify a format, pattern, enum, or const.
device:
$ref: "../common/CAMARA_common.yaml#/components/schemas/Device"
Resource:
Expand All @@ -290,9 +290,9 @@
properties:
resourceId:
$ref: "#/components/schemas/ResourceId"
name:
type: string
maxLength: 128
description: Human-readable name for the resource

Check warning on line 296 in artifacts/api-templates/sample-service.yaml

View workflow job for this annotation

GitHub Actions / Lint artifacts

owasp:api4:2023-string-restricted 

Schema of type string should specify a format, pattern, enum, or const.
device:
$ref: "../common/CAMARA_common.yaml#/components/schemas/Device"
2 changes: 1 addition & 1 deletion artifacts/common/info-description-templates.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ additional-error-responses:

The list of error codes in this API specification is not exhaustive. Therefore the API specification MAY not document some non-mandatory error statuses as indicated in `CAMARA API Design Guide`.

Please refer to the `CAMARA_common.yaml` of the Commonalities Release associated to this API version for a complete list of error responses. The applicable Commonalities Release can be identified in the `API Readiness Checklist` document associated to this API version.
Please refer to the `CAMARA_common.yaml` of the Commonalities Release associated to this API version for a complete list of error responses. The applicable Commonalities Release can be identified from the `x-camara-commonalities` field, the changelog and the metadata of the released API version.

As a specific rule, error `501 - NOT_IMPLEMENTED` can be only a possible error response if it is explicitly documented in the API.
<!-- CAMARA:MANDATORY:additional-error-responses:END -->
Expand Down
2 changes: 1 addition & 1 deletion documentation/CAMARA-API-Design-Guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -587,7 +587,7 @@ The following template MUST be used as part of the API documentation in the `inf

The list of error codes in this API specification is not exhaustive. Therefore the API specification MAY not document some non-mandatory error statuses as indicated in `CAMARA API Design Guide`.

Please refer to the `CAMARA_common.yaml` of the Commonalities Release associated to this API version for a complete list of error responses. The applicable Commonalities Release can be identified in the `API Readiness Checklist` document associated to this API version.
Please refer to the `CAMARA_common.yaml` of the Commonalities Release associated to this API version for a complete list of error responses. The applicable Commonalities Release can be identified from the `x-camara-commonalities` field, the changelog and the metadata of the released API version.

As a specific rule, error `501 - NOT_IMPLEMENTED` can be only a possible error response if it is explicitly documented in the API.

Expand Down
Loading