Scaleway logo
Annotations API
Annotations API

Schemas

Download schema

scaleway.annotations.v1.Binding

id
​string

ID of the binding. (UUID format)

srn
​string · pattern: ^srn://annotations\.…

SRN of the binding.

target_srn
​string

SRN of the resource the binding is attached to.

Key associated to the binding.

Value associated to the binding.

scaleway.annotations.v1.Binding.Key

id
​string

ID of the key. (UUID format)

srn
​string · pattern: ^srn://annotations\.…

SRN of the key.

name
​string

Name of the key.

scaleway.annotations.v1.Binding.Value

id
​string

ID of the value. (UUID format)

srn
​string · pattern: ^srn://annotations\.…

SRN of the value.

name
​string

Name of the value.

scaleway.annotations.v1.DeleteAllBindingsMatchingSRNResponse

total_deleted
​integer · uint64

Total number of bindings deleted.

scaleway.annotations.v1.DeleteAllBindingsMatchingValueResponse

total_deleted
​integer · uint64

Total number of bindings deleted.

scaleway.annotations.v1.DeleteAllValuesMatchingKeyResponse

total_deleted
​integer · uint64

Total number of values deleted.

scaleway.annotations.v1.Key

id
​string

ID of the annotation key. (UUID format)

srn
​string · pattern: ^srn://annotations\.…

SRN of the annotation key.

name
​string

Name of the annotation key.

description
​string

Description of the annotation key.

scaleway.annotations.v1.ListAllKeysAndValuesResponse

List of keys with values for an organization, sorted alphabetically by name.

scaleway.annotations.v1.ListAllKeysAndValuesResponse.Key

id
​string

ID of the key. (UUID format)

srn
​string · pattern: ^srn://annotations\.…

SRN of the key.

name
​string

Name of the key.

description
​string

Description of the key.

List of values associated with the key, sorted alphabetically by name.

scaleway.annotations.v1.ListAllKeysAndValuesResponse.Value

id
​string

ID of the value. (UUID format)

srn
​string · pattern: ^srn://annotations\.…

SRN of the value.

name
​string

Name of the value.

description
​string

Description of the value.

scaleway.annotations.v1.ListBindingsResponse

List of bindings for the organization. Response order by ID.

total_count
​integer · uint64

Total number of bindings returned.

scaleway.annotations.v1.ListKeysResponse

List of keys for an organization, sorted alphabetically by name.

total_count
​integer · uint64

Total number of keys returned.

scaleway.annotations.v1.ListValuesResponse

List of values for a key, sorted alphabetically by name.

total_count
​integer · uint64

Total number of values returned.

scaleway.annotations.v1.Value

id
​string

ID of the value. (UUID format)

srn
​string · pattern: ^srn://annotations\.…

SRN of the annotation value.

key_id
​string

ID of the key the value is associated to. (UUID format)

name
​string

Name of the value (e.g. "production" for a key "environment").

description
​string

Description of the value.