Skip to content

Commit

Permalink
#288 minor improvements in ditto-api-2.yml;
Browse files Browse the repository at this point in the history
Signed-off-by: Stefan Maute <stefan.maute@bosch.io>
  • Loading branch information
Stefan Maute committed Jan 25, 2021
1 parent 9092e89 commit a4b5b08
Showing 1 changed file with 4 additions and 11 deletions.
15 changes: 4 additions & 11 deletions documentation/src/main/resources/openapi/ditto-api-2.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5972,16 +5972,13 @@ components:
description: |-
JSON representation of the value to be created/updated. This may be as well `null` or an empty object.
Consider that the value has to be a JSON value, examples:
Consider that the value has to be a JSON value.
Examples:
* for a number, the JSON value is the number: `42`
* for a string, the JSON value must be quoted: `"aString"`
* for a boolean, the JSON value is the boolean: `true`
* for an object, the JSON value is the object: `{ "key": "value"}` -} We strongly recommend to use a restricted set of characters for the key (identifier). Currently these identifiers should follow the pattern: [_a-zA-Z][_a-zA-Z0-9\-]*
* for an list, the JSON value is the list: `[ 1,2,3 ]`
required: true
PatchValue:
Expand All @@ -5993,18 +5990,14 @@ components:
description: |-
JSON representation of the value to be patched. This may be as well an empty object.
Consider that the value has to be a JSON value, examples:
Consider that the value has to be a JSON value.
Examples:
* for a number, the JSON value is the number: `42`
* for a string, the JSON value must be quoted: `"aString"`
* for a boolean, the JSON value is the boolean: `true`
* for an object, the JSON value is the object: `{ "key": "value"}` -} We strongly recommend to use a restricted set of characters for the key (identifier). Currently these identifiers should follow the pattern: [_a-zA-Z][_a-zA-Z0-9\-]*
* for an list, the JSON value is the list: `[ 1,2,3 ]`
* special value `null` will delete the referenced key. For further documentation see [RFC 7396](https://tools.ietf.org/html/rfc7396).
required: true
responses:
Expand Down

0 comments on commit a4b5b08

Please sign in to comment.