Skip to content

Latest commit

 

History

History
165 lines (93 loc) · 1.94 KB

sku.md

File metadata and controls

165 lines (93 loc) · 1.94 KB
Raw

Kali API - v1.0 - Sku

/api/

POST /api/

Creates a new sku from the submitted data.

Parameters

sku:

  • type: object (SkuType)
  • required: true

sku[project]:

  • type: string
  • required: true
  • description: Name of the application

sku[type]:

  • type: string
  • required: true
  • description: Type of the entity to be skued

sku[id]:

  • type: string
  • required: true
  • description: Id of the entity to be skued

sku[permalink]:

  • type: string
  • required: false
  • description: Permanent link of the entity.

/api/{project}

POST /api/{project}

Create a new sku record without details and return code allocated.

Parameters

sku:

  • type: object (SkuType)
  • required: true

sku[project]:

  • type: string
  • required: true
  • description: Name of the application

Response

code:

  • type: string

/api/{sku}

DELETE /api/{sku}

Removes a sku.

Requirements

sku

  • Description: Sku code

GET /api/{sku}

Get a sku.

Requirements

sku

  • Description: Sku code

Response

project:

  • type: string

code:

  • type: string

created_at:

  • type: DateTime

deleted_at:

  • type: DateTime

id:

  • type: string

type:

  • type: string

active:

  • type: boolean

permalink:

  • type: string

PUT /api/{sku}

Edit an sku from the submitted data.

Requirements

sku

  • Requirement: [\d\w]*
  • Type: string

Parameters

sku:

  • type: object (SkuType)
  • required: false

sku[project]:

  • type: string
  • required: true
  • description: Name of the application

sku[type]:

  • type: string
  • required: true
  • description: Type of the entity to be skued

sku[id]:

  • type: string
  • required: true
  • description: Id of the entity to be skued

sku[permalink]:

  • type: string
  • required: false
  • description: Permanent link of the entity.