Merge pull request #31 from commercetools/api-clients

Api clients

Author: Jens Schulze

api.raml

@@ -163,3 +163,4 @@ resourceTypes:
   /zones: !include resources/zones.raml
   /me: !include resources/me.raml
   /extensions: !include resources/extensions.raml
+  /api-clients: !include resources/api-clients.raml

examples/api-client-create.example.json

@@ -0,0 +1,4 @@
+{
+  "name": "api-client-name",
+  "scope": "view_products"
+}

examples/api-client.example.json

@@ -0,0 +1,8 @@
+{
+  "id": "api-client-id",
+  "name": "api-client-name",
+  "scope": "view_products",
+  "createdAt": "2018-01-01T00:00:00.001Z",
+  "lastUsedAt": "2017-9-10",
+  "secret": "secret-passphrase"
+}

examples/api-clients.example.json

@@ -0,0 +1,15 @@
+{
+  "offset": 0,
+  "count": 1,
+  "total": 1,
+  "results": [
+    {
+      "id": "api-client-id",
+      "name": "api-client-name",
+      "scope": "view_products",
+      "createdAt": "2018-01-01T00:00:00.001Z",
+      "lastUsedAt": "2017-9-10",
+      "secret": "secret-passphrase"
+    }
+  ]
+}

resources/api-clients.raml

@@ -0,0 +1,27 @@
+type:
+  baseDomain:
+    resourceType: ApiClient
+    resourceQueryType: ApiClientPagedQueryResponse
+    resourceDraft: ApiClientDraft
+    resourceExample: !include ../examples/api-client.example.json
+    resourceQueryExample: !include ../examples/api-clients.example.json
+    resourceCreateExample: !include ../examples/api-client-create.example.json
+    whereExample: scopes = view_products
+    sortExample: createdAt asc
+description: |
+  Manage your API Clients via an API. Useful for Infrastructure-as-Code tooling, and regularly rotating API secrets.
+get:
+  securedBy: [oauth_2_0: {scopes: ["manage_api_clients:{projectKey}", "view_api_clients:{projectKey}"]}]
+post:
+  securedBy: [oauth_2_0: {scopes: ["manage_api_clients:{projectKey}"]}]
+/{ID}:
+  (methodName): withId
+  type:
+    baseResource:
+      uriParameterName: ID
+      resourceType: ApiClient
+      resourceExample: !include ../examples/api-client.example.json
+  get:
+    securedBy: [oauth_2_0: {scopes: ["manage_api_clients:{projectKey}", "view_api_clients:{projectKey}"]}]
+  delete:
+    securedBy: [oauth_2_0: {scopes: ["manage_api_clients:{projectKey}"]}]

resources/states.raml

@@ -12,7 +12,8 @@ type:
     sortExample: createdAt asc
 description: |
   The commercetools platform allows you to model states of certain objects, such as orders, line items, products,
-  reviews, and payments in order to define finite state machines reflecting the business logic you’d like to implement.
+  reviews, and payments in order to define finite state machines reflecting the business logic you’d like to
+  implement.
 get:
   securedBy: [oauth_2_0: {scopes: ["manage_project:{projectKey}", "view_orders:{projectKey}"]}]
 post:

types/api-client/ApiClient.raml

@@ -0,0 +1,20 @@
+#%RAML 1.0 DataType
+(package): ApiClient
+(docs-uri): https://docs.commercetools.com/http-api-projects-apiClients.html#apiclient
+
+displayName: ApiClient
+
+type: object
+properties:
+  id:
+    type: string
+  name:
+    type: string
+  scope:
+    type: string
+  createdAt:
+    type: datetime
+  lastUsedAt:
+    type: date-only
+  secret?:
+    type: string

types/api-client/ApiClientDraft.raml

@@ -0,0 +1,12 @@
+#%RAML 1.0 DataType
+(package): ApiClient
+(docs-uri): https://docs.commercetools.com/http-api-projects-apiClients.html#apiclientdraft
+
+displayName: ApiClientDraft
+
+type: object
+properties:
+  name:
+    type: string
+  scope:
+    type: string

types/api-client/ApiClientPagedQueryResponse.raml

@@ -0,0 +1,18 @@
+#%RAML 1.0 DataType
+(package): ApiClient
+
+displayName: ApiClientPagedQueryResponse
+
+type: object
+properties:
+    count:
+        type: number
+        format: int64
+    total?:
+        type: number
+        format: int64
+    offset:
+        type: number
+        format: int64
+    results:
+        type: ApiClient[]

types/types.raml

@@ -1,6 +1,9 @@
 PagedQueryResponse: !include PagedQueryResponse.raml
 Update: !include Update.raml
 UpdateAction: !include UpdateAction.raml
+ApiClient: !include api-client/ApiClient.raml
+ApiClientDraft: !include api-client/ApiClientDraft.raml
+ApiClientPagedQueryResponse: !include api-client/ApiClientPagedQueryResponse.raml
 CartDiscount: !include cart-discount/CartDiscount.raml
 CartDiscountCustomLineItemsTarget: !include cart-discount/CartDiscountCustomLineItemsTarget.raml
 CartDiscountDraft: !include cart-discount/CartDiscountDraft.raml