Skip to content

Commit f4cb4be

Browse files
committed
Updated API from documentation release
1 parent 505b3af commit f4cb4be

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+2063
-0
lines changed

api-specs/test/CHANGELOG.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# @commercetools-api-specs/test
2+
3+
## 0.3.0
4+
5+
### Minor Changes
6+
7+
- [#2076](https://github.com/commercetools/commercetools-docs-kit/pull/2076) [`dbe4950`](https://github.com/commercetools/commercetools-docs-kit/commit/dbe49500fa962cc3d6d4a51e79f8eade8b46271d) Thanks [@timonrey](https://github.com/timonrey)! - Add API OAuth scopes columns layout
8+
9+
## 0.2.3
10+
11+
### Patch Changes
12+
13+
- [#1983](https://github.com/commercetools/commercetools-docs-kit/pull/1983) [`2f83a52`](https://github.com/commercetools/commercetools-docs-kit/commit/2f83a526443b2545e7cdc4aa820fc8dbe965e3a2) Thanks [@gabriele-ct](https://github.com/gabriele-ct)! - Correctly handle type field when the name is reserved word 'enum'
14+
15+
## 0.2.2
16+
17+
### Patch Changes
18+
19+
- [#1960](https://github.com/commercetools/commercetools-docs-kit/pull/1960) [`ad4437b`](https://github.com/commercetools/commercetools-docs-kit/commit/ad4437b9c9112524c4b74df8d98423393c8d6688) Thanks [@gabriele-ct](https://github.com/gabriele-ct)! - apply ui changes for learning go live
20+
21+
## 0.2.1
22+
23+
### Patch Changes
24+
25+
- [#1661](https://github.com/commercetools/commercetools-docs-kit/pull/1661) [`8759c1ea`](https://github.com/commercetools/commercetools-docs-kit/commit/8759c1ea7fdf07c3c25abc041bd1dfb941bce409) Thanks [@gabriele-ct](https://github.com/gabriele-ct)! - Add support for primitive and generic JSON types in API request and response
26+
27+
## 0.2.0
28+
29+
### Minor Changes
30+
31+
- [#1448](https://github.com/commercetools/commercetools-docs-kit/pull/1448) [`8266d506`](https://github.com/commercetools/commercetools-docs-kit/commit/8266d5064a27b8c29460e28187ac8a224d21ad5b) Thanks [@gabriele-ct](https://github.com/gabriele-ct)! - Display nicely multiple types (union) in API parameters
32+
33+
- [#1445](https://github.com/commercetools/commercetools-docs-kit/pull/1445) [`ae9d441a`](https://github.com/commercetools/commercetools-docs-kit/commit/ae9d441a1acf5289724281a16680795d1ea1167b) Thanks [@gabriele-ct](https://github.com/gabriele-ct)! - Add support for endpoint URN resolution in links. As per type URN, an override mechanism is provided and documented
34+
35+
## 0.1.0
36+
37+
### Minor Changes
38+
39+
- [#1331](https://github.com/commercetools/commercetools-docs-kit/pull/1331) [`9dfa5e73`](https://github.com/commercetools/commercetools-docs-kit/commit/9dfa5e7341eddafe876e33b390c4b22de64b41f3) Thanks [@gabriele-ct](https://github.com/gabriele-ct)! - When an API endpoint method response has one or more `example` nodes defined in the .raml file, those examples will be displayed in the API method page. In case no `example` nodes are defined, the response type example will be displayed instead.
40+
The API response code is now visible in the example code section header to help identifying what the example is referring to.
41+
42+
## 0.0.4
43+
44+
### Patch Changes
45+
46+
- [#1198](https://github.com/commercetools/commercetools-docs-kit/pull/1198) [`fdc249d5`](https://github.com/commercetools/commercetools-docs-kit/commit/fdc249d5df2198dacea00bf26573bdbf684519f3) Thanks [@renovate](https://github.com/apps/renovate)! - Update dependencies
47+
48+
## 0.0.3
49+
50+
### Patch Changes
51+
52+
- [#1145](https://github.com/commercetools/commercetools-docs-kit/pull/1145) [`424806a`](https://github.com/commercetools/commercetools-docs-kit/commit/424806a8fedeacc33b2fa9ce68a353049ef0c42a) Thanks [@renovate](https://github.com/apps/renovate)! - fix(deps): update all dependencies
53+
54+
* [#1152](https://github.com/commercetools/commercetools-docs-kit/pull/1152) [`795b5cc`](https://github.com/commercetools/commercetools-docs-kit/commit/795b5ccd3141220031c4aa3dca2f42b7b2e9d572) Thanks [@emmenko](https://github.com/emmenko)! - Upgrade to Yarn v3
55+
56+
## 0.0.2
57+
58+
### Patch Changes
59+
60+
- [#1018](https://github.com/commercetools/commercetools-docs-kit/pull/1018) [`853f891`](https://github.com/commercetools/commercetools-docs-kit/commit/853f8915072f8153fd1efa266b06b66f0360717a) Thanks [@nkuehn](https://github.com/nkuehn)! - Resolve URN style links in RAML descriptions
61+
62+
## 0.0.1
63+
64+
### Patch Changes
65+
66+
- [`b0dcc19`](https://github.com/commercetools/commercetools-docs-kit/commit/b0dcc1989983043331eb5deb77a6ba40befe51b0) [#866](https://github.com/commercetools/commercetools-docs-kit/pull/866) Thanks [@emmenko](https://github.com/emmenko)! - Update uikit versions to latest
Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
#%RAML 1.0 Library
2+
usage: Generator annotation types.
3+
4+
annotationTypes:
5+
enumDescriptions:
6+
description: |
7+
Describes the values of an enum type.
8+
type: object
9+
properties:
10+
//:
11+
description: |
12+
Adds a description for the enum value given by the key.
13+
enumGroups:
14+
description: |
15+
Groups the values of an enum type.
16+
type: object
17+
properties:
18+
//:
19+
description: |
20+
Specifies the group for the enum value given by the key.
21+
beta:
22+
description: |
23+
if true, designates that the element is not released yet like regular elements and should be treated as being subject to
24+
changes, incompleteness and ongoing development.
25+
Documentation must provide a hint that the element is in beta status and can opt to hide such elements.
26+
If not set, false must be assumed.
27+
type: boolean
28+
deprecated:
29+
description: |
30+
If true, designates that the element carrying this annotation should not be used any more and is subject to potential later removal.
31+
If used, the description text should explain the new way the effect of the deprecated element is to be achieved.
32+
If not set, false must be assumed.
33+
Documentation can choose to hide deprecated elements, mark them deprecated or make them less prominent as needed.
34+
Documentation must not suppress the fact that an element is deprecated.
35+
type: boolean
36+
refersTo:
37+
description: |
38+
Must contain either a type name in the current API or a detectable addressing scheme like URN or URL pointing to other entities.
39+
if the `refersTo` annotation is used on a RAML element it designates that the element is referring, linking or pointing to another type of entity.
40+
Documentation should generate a navigatable link to that other entity.
41+
type: string
42+
docsBaseUri:
43+
allowedTargets:
44+
- API
45+
type: string
46+
docsBaseUriParameters:
47+
allowedTargets:
48+
- API
49+
type: object
50+
## Reminder for future needs:
51+
# messagesEmitted:
52+
# description: |
53+
# list of messages emitted by an endpoint (Strings?)
54+
# type: String[]

0 commit comments

Comments
 (0)