API Definition

17KB

Service Manager Schema.yaml

Open

validate a commissioning file

post

Authorizations

AuthorizationstringRequired

Body

commissioningFilestringRequired

The commissioning file of this service as base64 encoded content of a buffer

Responses

200

Validation Successful

No content

400

Validation Error

application/json

406

Invalid Content

application/json

post

/validate/service

POST /api/validate/service HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "commissioningFile": "text"
}

No content

Create a new service

post

Authorizations

AuthorizationstringRequired

Body

idstring · min: 4Required

commissioningFilestringRequired

The commissioning file of this service as base64 encoded content of a buffer

parametersobjectOptional

The parameter values of this service as a JSON object

marketplaceobjectOptional

targetStatestring · enumOptionalPossible values:

Responses

201

Created service

application/json

400

Validation Error

application/json

406

Invalid Content

application/json

post

/services

POST /api/services HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 98

{
  "id": "text",
  "commissioningFile": "text",
  "parameters": {},
  "marketplace": {},
  "targetState": "disabled"
}

{
  "id": "text",
  "targetState": "text",
  "currentState": "text"
}

Read all services

get

Authorizations

AuthorizationstringRequired

Responses

200

Array of services

application/json

idstringOptional

commissioningDataobjectOptional

resourcesobjectOptional

targetStatestringOptional

currentStatestringOptional

get

/services

GET /api/services HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

Array of services

[
  {
    "id": "text",
    "commissioningData": {},
    "resources": {},
    "targetState": "text",
    "currentState": "text"
  }
]

Get the service schemas

post

Authorizations

AuthorizationstringRequired

Body

commissioningFilestringRequired

The commissioning file of this service as base64 encoded content of a buffer

Responses

201

Service schemas

application/json

400

Validation Error

application/json

406

Invalid Content

application/json

post

/services/parametersSchema

POST /api/services/parametersSchema HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "commissioningFile": "text"
}

{}

Get status of all services

get

Authorizations

AuthorizationstringRequired

Responses

200

Map of service statuses

application/json

objectOptional

get

/services/status

GET /api/services/status HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

Map of service statuses

{}

Get information of all services

get

Authorizations

AuthorizationstringRequired

Responses

200

Map of service information

application/json

objectOptional

get

/services/info

GET /api/services/info HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

Map of service information

{}

Get the instance names of the services

get

Authorizations

AuthorizationstringRequired

Responses

200

Map of service information

application/json

string[]Optional

get

/services/instances

GET /api/services/instances HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

Map of service information

[
  "text"
]

Get a specific service

get

Authorizations

AuthorizationstringRequired

Path parameters

idstringRequired

Id of service

Responses

200

Service

application/json

idstringOptional

commissioningDataobjectOptional

resourcesobjectOptional

targetStatestringOptional

currentStatestringOptional

400

Invalid request

404

Service not found

get

/services/{id}

GET /api/services/{id} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "text",
  "commissioningData": {},
  "resources": {},
  "targetState": "text",
  "currentState": "text"
}

Update an existing service

put

Authorizations

AuthorizationstringRequired

Path parameters

idstringRequired

Id of service

Body

parametersobjectOptional

commissioningFilestringOptional

marketplaceobjectOptional

Responses

202

Accepted

400

Validation Error

application/json

406

Invalid Content

application/json

put

/services/{id}

PUT /api/services/{id} HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 61

{
  "parameters": {},
  "commissioningFile": "text",
  "marketplace": {}
}

No content

Delete an existing service

delete

Authorizations

AuthorizationstringRequired

Path parameters

idstringRequired

Id of service

Responses

200

application/json

idstringOptional

The id of the deleted service

404

Service not found

delete

/services/{id}

DELETE /api/services/{id} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "text"
}

Get a specific service status

get

Authorizations

AuthorizationstringRequired

Path parameters

idstringRequired

Id of service

Responses

200

Service

application/json

idstringOptional

Unique identifier representing a specific service.

targetStatestringOptional

Target state of the service (user's wish).

currentStatestringOptional

Current state of the service.

400

Invalid request

404

Service not found

get

/services/{id}/status

GET /api/services/{id}/status HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "text",
  "targetState": "text",
  "currentState": "text"
}

Get the service dependencies

get

Authorizations

AuthorizationstringRequired

Path parameters

idstringRequired

Id of service

Responses

200

Service dependencies

application/json

dependentstring[]Optional

Ids of dependent cross reference services

dependsOnstring[]Optional

Ids of depends on cross reference services

400

Invalid request

404

Service not found

get

/services/{id}/dependencies

GET /api/services/{id}/dependencies HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "dependent": [
    "text"
  ],
  "dependsOn": [
    "text"
  ]
}

Get all ingress routes

get

Authorizations

AuthorizationstringRequired

Responses

200

Ingress routes

application/json

idstringOptional

containerHoststringOptional

containerPortintegerOptional

containerPrefixRewritestringOptional

ingressPortintegerOptional

ingressUrlPrefixstringOptional

typestringOptional

headersstring[]Optional

400

Invalid request

get

/services/ingress-routes

GET /api/services/ingress-routes HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "id": "text",
    "containerHost": "text",
    "containerPort": 1,
    "containerPrefixRewrite": "text",
    "ingressPort": 1,
    "ingressUrlPrefix": "text",
    "type": "text",
    "headers": [
      "text"
    ]
  }
]

Get all Cybus::Link routes

get

Authorizations

AuthorizationstringRequired

Responses

200

Links

application/json

idstringOptional

ingressRoutestringOptional

namestringOptional

hrefstringOptional

400

Invalid request

get

/services/links

GET /api/services/links HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "id": "text",
    "ingressRoute": "text",
    "name": "text",
    "href": "text"
  }
]

Get all links by all services

get

Authorizations

AuthorizationstringRequired

Responses

200

Links

application/json

idstringOptional

namestringOptional

400

Invalid request

get

/services/all-links

GET /api/services/all-links HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "id": "text",
    "name": "text",
    "links": []
  }
]

Perform an operation on a service

put

Authorizations

AuthorizationstringRequired

Path parameters

idstringRequired

Id of service

Body

operationstringOptional

Disable and enable

Responses

200

Service

application/json

idstringOptional

Unique identifier representing a specific service.

targetStatestringOptional

Target state of the service (user's wish).

currentStatestringOptional

Current state of the service.

400

Invalid request

404

Service not found

put

/services/{id}/operation

PUT /api/services/{id}/operation HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "operation": "text"
}

{
  "id": "text",
  "targetState": "text",
  "currentState": "text"
}

Get all of the resource schemas

get

Authorizations

AuthorizationstringRequired

Responses

200

Resource schemas in a JSON string

application/json

Other propertiesanyOptional

400

Invalid request

500

Internal error

get

/resources/schemas

GET /api/resources/schemas HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "[a-zA-Z0-9]+": {},
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

PreviousRule Sandbox NextResources

Last updated 1 year ago

Was this helpful?

hashtagvalidate a commissioning file

hashtagCreate a new service

hashtagRead all services

hashtagGet the service schemas

hashtagGet status of all services

hashtagGet information of all services

hashtagGet the instance names of the services

hashtagGet a specific service

hashtagUpdate an existing service

hashtagDelete an existing service

hashtagGet a specific service status

hashtagGet the service dependencies

hashtagGet all ingress routes

hashtagGet all Cybus::Link routes

hashtagGet all links by all services

hashtagPerform an operation on a service

hashtagGet all of the resource schemas

validate a commissioning file

Create a new service

Read all services

Get the service schemas

Get status of all services

Get information of all services

Get the instance names of the services

Get a specific service

Update an existing service

Delete an existing service

Get a specific service status

Get the service dependencies

Get all ingress routes

Get all Cybus::Link routes

Get all links by all services

Perform an operation on a service

Get all of the resource schemas