Skip to content

Commit

Permalink
Updated API from documentation release
Browse files Browse the repository at this point in the history
  • Loading branch information
ct-sdks[bot] committed Nov 29, 2024
1 parent 505b3af commit f4cb4be
Show file tree
Hide file tree
Showing 41 changed files with 2,063 additions and 0 deletions.
66 changes: 66 additions & 0 deletions api-specs/test/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
# @commercetools-api-specs/test

## 0.3.0

### Minor Changes

- [#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

## 0.2.3

### Patch Changes

- [#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'

## 0.2.2

### Patch Changes

- [#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

## 0.2.1

### Patch Changes

- [#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

## 0.2.0

### Minor Changes

- [#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

- [#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

## 0.1.0

### Minor Changes

- [#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.
The API response code is now visible in the example code section header to help identifying what the example is referring to.

## 0.0.4

### Patch Changes

- [#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

## 0.0.3

### Patch Changes

- [#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

* [#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

## 0.0.2

### Patch Changes

- [#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

## 0.0.1

### Patch Changes

- [`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
54 changes: 54 additions & 0 deletions api-specs/test/annotation-types/annotations.raml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
#%RAML 1.0 Library
usage: Generator annotation types.

annotationTypes:
enumDescriptions:
description: |
Describes the values of an enum type.
type: object
properties:
//:
description: |
Adds a description for the enum value given by the key.
enumGroups:
description: |
Groups the values of an enum type.
type: object
properties:
//:
description: |
Specifies the group for the enum value given by the key.
beta:
description: |
if true, designates that the element is not released yet like regular elements and should be treated as being subject to
changes, incompleteness and ongoing development.
Documentation must provide a hint that the element is in beta status and can opt to hide such elements.
If not set, false must be assumed.
type: boolean
deprecated:
description: |
If true, designates that the element carrying this annotation should not be used any more and is subject to potential later removal.
If used, the description text should explain the new way the effect of the deprecated element is to be achieved.
If not set, false must be assumed.
Documentation can choose to hide deprecated elements, mark them deprecated or make them less prominent as needed.
Documentation must not suppress the fact that an element is deprecated.
type: boolean
refersTo:
description: |
Must contain either a type name in the current API or a detectable addressing scheme like URN or URL pointing to other entities.
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.
Documentation should generate a navigatable link to that other entity.
type: string
docsBaseUri:
allowedTargets:
- API
type: string
docsBaseUriParameters:
allowedTargets:
- API
type: object
## Reminder for future needs:
# messagesEmitted:
# description: |
# list of messages emitted by an endpoint (Strings?)
# type: String[]
Loading

0 comments on commit f4cb4be

Please sign in to comment.