Skip to content

Mark credential fields as writeOnly in EAM schema #55

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

Merged
JoseMConde merged 1 commit into from
Jul 28, 2026
Merged

Mark credential fields as writeOnly in EAM schema #55

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
4 changes: 3 additions & 1 deletion code/API_definitions/edge-application-management.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1134,7 +1134,7 @@
$ref: "../common/CAMARA_common.yaml#/components/responses/Generic429"

schemas:
AccessTokenCredential:

Check notice on line 1137 in code/API_definitions/edge-application-management.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

Component may be unused 

[S-211] Potentially unused component has been detected. | Suggestion: Spectral does not follow discriminator mappings — verify the schema is truly unused.
type: object
description:
An access token credential. This type of credential is meant to be
Expand All @@ -1144,12 +1144,13 @@
- $ref: "#/components/schemas/SinkCredential"
- type: object
properties:
accessToken:

Check notice on line 1147 in code/API_definitions/edge-application-management.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

String has no format/pattern/enum 

[S-313] Schema of type string should specify a format, pattern, enum, or const. | Suggestion: Acceptable if free-form field or implementation-dependent — no fix needed.
description:
Access Token granting access to the POST operation to create
notification
type: string
maxLength: 8192
writeOnly: true
maxLength: 4096
accessTokenExpiresUtc:
type: string
format: date-time
Expand Down Expand Up @@ -1454,7 +1455,7 @@
description: Name of the application.
appProvider:
$ref: "#/components/schemas/AppProvider"
version:

Check notice on line 1458 in code/API_definitions/edge-application-management.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

String has no format/pattern/enum 

[S-313] Schema of type string should specify a format, pattern, enum, or const. | Suggestion: Acceptable if free-form field or implementation-dependent — no fix needed.
type: string
maxLength: 64
description: Application version information
Expand Down Expand Up @@ -1492,15 +1493,16 @@
e.g. in Github repo.
imagePath:
$ref: "#/components/schemas/Uri"
userName:

Check notice on line 1496 in code/API_definitions/edge-application-management.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

String has no format/pattern/enum 

[S-313] Schema of type string should specify a format, pattern, enum, or const. | Suggestion: Acceptable if free-form field or implementation-dependent — no fix needed.
type: string
maxLength: 64
description: |
Username to acces the Helm chart, docker-compose
file or VM image repository
credentials:

Check notice on line 1502 in code/API_definitions/edge-application-management.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

String has no format/pattern/enum 

[S-313] Schema of type string should specify a format, pattern, enum, or const. | Suggestion: Acceptable if free-form field or implementation-dependent — no fix needed.
type: string
maxLength: 2048
writeOnly: true
description: |
Password or personal access token created by
developer to acces the app repository. API users can generate
Expand Down Expand Up @@ -1546,7 +1548,7 @@
- componentName
- networkInterfaces
properties:
componentName:

Check notice on line 1551 in code/API_definitions/edge-application-management.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

String has no format/pattern/enum 

[S-313] Schema of type string should specify a format, pattern, enum, or const. | Suggestion: Acceptable if free-form field or implementation-dependent — no fix needed.
type: string
maxLength: 64
description: Component name must be unique with an application
Expand Down Expand Up @@ -1627,7 +1629,7 @@
- clusterRef
- edgeCloudZoneId
properties:
name:

Check notice on line 1632 in code/API_definitions/edge-application-management.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

String has no format/pattern/enum 

[S-313] Schema of type string should specify a format, pattern, enum, or const. | Suggestion: Acceptable if free-form field or implementation-dependent — no fix needed.
type: string
maxLength: 64
description: |
Expand All @@ -1653,12 +1655,12 @@
$ref: "#/components/schemas/KubernetesNodePool"
minItems: 1

EdgeCloudProvider:

Check notice on line 1658 in code/API_definitions/edge-application-management.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

String has no format/pattern/enum 

[S-313] Schema of type string should specify a format, pattern, enum, or const. | Suggestion: Acceptable if free-form field or implementation-dependent — no fix needed.
type: string
maxLength: 64
description: Human readable name of the Edge Cloud Provider.

EdgeCloudRegion:

Check notice on line 1663 in code/API_definitions/edge-application-management.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

String has no format/pattern/enum 

[S-313] Schema of type string should specify a format, pattern, enum, or const. | Suggestion: Acceptable if free-form field or implementation-dependent — no fix needed.
type: string
maxLength: 64
description: |
Expand Down Expand Up @@ -1709,7 +1711,7 @@
edgeCloudRegion:
$ref: "#/components/schemas/EdgeCloudRegion"

EdgeCloudZoneName:

Check notice on line 1714 in code/API_definitions/edge-application-management.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

String has no format/pattern/enum 

[S-313] Schema of type string should specify a format, pattern, enum, or const. | Suggestion: Acceptable if free-form field or implementation-dependent — no fix needed.
type: string
maxLength: 64
description: |
Expand Down