PUT /v1/orchestrator/metrics/:metric.id — orchestrator-api · SKMTC Hub

Orchestrator

Updates an existing metric

put/v1/orchestrator/metrics/{metric.id}

Path parameters

metric.idstring required

Request body

idstring required

Required. The unique identifier of the metric.

namestring required

Required. The name of the metric.

descriptionstring required

The description of the metric

versionstring required

The version of this metric

commentsstring

Optional comments that describe the purpose of this metric. They may also describe a scenario in which the metric can be useful.

categorystring required

Semantically, the reference to control catalog category or domain; it must conform to the directory structure of the security-metrics respository

deprecatedSincestring date-time

Optional, but required if the metric is removed. The metric is not deleted for backward compatibility and the timestamp is set to the time of removal.

Response

OK

idstring required

Required. The unique identifier of the metric.

namestring required

Required. The name of the metric.

descriptionstring required

The description of the metric

versionstring required

The version of this metric

commentsstring

Optional comments that describe the purpose of this metric. They may also describe a scenario in which the metric can be useful.

categorystring required

Semantically, the reference to control catalog category or domain; it must conform to the directory structure of the security-metrics respository

deprecatedSincestring date-time

Optional, but required if the metric is removed. The metric is not deleted for backward compatibility and the timestamp is set to the time of removal.

Changes

Changed in 7 of the 50 revisions of this API.252734

Mar 4, 202697c4541f02f011See the full diff
- ▲
  added the new required request property
  new-required-request-property
- ○
  added the required property to the response with the status
  response-required-property-added
Jul 21, 202548f235df8ac6475See the full diff
- ▲
  added the new required request property
  new-required-request-property
- ▲
  the request property became required
  request-property-became-required
- ▲
  the request property became required
  request-property-became-required
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ●
  removed the request property
  request-property-removed
- ●
  removed the request property
  request-property-removed
- ●
  removed the request property
  request-property-removed
- ●
  removed the request property
  request-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  the response property became required for the status
  response-property-became-required
- ○
  the response property became required for the status
  response-property-became-required
- ○
  added the required property to the response with the status
  response-required-property-added
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jan 8, 20252b79660c20a044See the full diff
- ▲
  the request property became required
  request-property-became-required
- ▲
  the request property ///// became required
  request-property-became-required
- ▲
  the request property ///// became required
  request-property-became-required
- ▲
  the request property became required
  request-property-became-required
- ○
  the response property became required for the status
  response-property-became-required
- ○
  the response property ///// became required for the status
  response-property-became-required
- ○
  the response property ///// became required for the status
  response-property-became-required
- ○
  the response property became required for the status
  response-property-became-required
Apr 16, 20247ea70d31170c11See the full diff
- ▲
  added the pattern ^-?(?:0|[1-9][0-9]{0,11})(?:\.[0-9]{1,9})?s$ to the request property
  request-property-pattern-added
- ○
  the response's property pattern ^-?(?:0|[1-9][0-9]{0,11})(?:\.[0-9]{1,9})?s$ was added for the status
  response-property-pattern-added
Feb 16, 2024b58167cced1e8142See the full diff
- ▲
  added to the request property allOf list
  request-property-all-of-added
- ▲
  added to the request property allOf list
  request-property-all-of-added
- ▲
  the request property type changed from object to no type
  request-property-type-changed
- ▲
  the request property type changed from integer to string, and format from int64 to no format
  request-property-type-changed
- ▲
  the request property type changed from object to no type
  request-property-type-changed
- ▲
  the response's property type changed from object to no type for status
  response-property-type-changed
- ▲
  the response's property type changed from integer to string, and format from int64 to no format for status
  response-property-type-changed
- ▲
  the response's property type changed from object to no type for status
  response-property-type-changed
- ●
  removed the request property /
  request-property-removed
- ●
  removed the request property /
  request-property-removed
- ●
  removed the request property /
  request-property-removed
- ●
  removed the request property /
  request-property-removed
- ●
  removed the request property /
  request-property-removed
- ●
  removed the request property /
  request-property-removed
- ●
  removed the request property /
  request-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ○
  added to the response property allOf list for the response status
  response-property-all-of-added
- ○
  added to the response property allOf list for the response status
  response-property-all-of-added
Nov 29, 2023dc83c7b45e882See the full diff
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the optional property to the response with the status
  response-optional-property-added
Nov 7, 20229aea46cc4c8a7619See the full diff
- ▲
  the request property type changed from no type to object
  request-property-type-changed
- ▲
  the response property became optional for the status
  response-property-became-optional
- ▲
  the response property became optional for the status
  response-property-became-optional
- ▲
  the response property became optional for the status
  response-property-became-optional
- ▲
  the response property became optional for the status
  response-property-became-optional
- ▲
  the response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ●
  removed from the request property allOf list
  request-property-all-of-removed
- ●
  removed the request property
  request-property-removed
- ●
  removed the request property
  request-property-removed
- ●
  removed the request property
  request-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ○
  added the new optional request property /
  new-optional-request-property
- ○
  added the new optional request property /
  new-optional-request-property
- ○
  added the new optional request property /
  new-optional-request-property
- ○
  added the new optional request property /
  new-optional-request-property
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the new optional request property
  new-optional-request-property
- ○
  the request property became optional
  request-property-became-optional
- ○
  the request property became optional
  request-property-became-optional
- ○
  the request property became optional
  request-property-became-optional
- ○
  the request property became optional
  request-property-became-optional
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  removed from the response property allOf list for the response status
  response-property-all-of-removed
This revision also has 110 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog