Skip to content

Use bulleted list for resources #186

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
merged 4 commits into from
Jun 4, 2025
Merged

Use bulleted list for resources #186

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3bf2e92
Use bulleted list for resources
toshi38 Jun 3, 2025
796d47d
Merge branch 'main' into patch-1
mathieu-benoit Jun 3, 2025
b406bc0
Apply suggestions from code review
toshi38 Jun 4, 2025
8ab5e6e
Update content/en/docs/score specification/score-spec-reference.md
mathieu-benoit Jun 4, 2025
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
14 changes: 5 additions & 9 deletions content/en/docs/score specification/score-spec-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -287,17 +287,13 @@ resources: # optional
param-name: value
```

`resources`: the resource dependencies needed by the workload.

`resource-name`: a required property that specifies the resource name.

`type`: the resource type. This should be a type supported by the Score implementations being used.
`class`: an optional specialisation of the resource type.
`id`: an optional external resource identifier. When two resources share the same type, class, and id, they are considered the same resource when used across related Workloads.
`params`: an optional map of parameters that may configure this resource. Params support both metadata and resource placeholders local to this Workload.

`metadata`: an optional property that specifies additional resource metadata.

- `type`: the resource type. This should be a type supported by the Score implementations being used.
- `class`: an optional specialisation of the resource type.
- `id`: an optional external resource identifier. When two resources share the same type, class, and id, they are considered the same resource when used across related Workloads.
- `params`: an optional map of parameters that may configure this resource. Params support both metadata and resource placeholders local to this Workload.
- `metadata`: an optional property that specifies additional resource metadata.
- `annotations`: An optional property to specify meta data for a resource. This can be utilised to provide additional instructions for the Score CLI Implementation to interpret.

### Resource example
Expand Down