|
|
# DE Schema API
|
|
|
|
|
|
|
|
|
<a name="overview"></a>
|
|
|
## Overview
|
|
|
This API takes care of schema management in the Data Ecosystem and offers an implementation of our schema standard.
|
|
|
|
|
|
|
|
|
### Version information
|
|
|
*Version* : 1.0.0
|
|
|
|
|
|
|
|
|
### License information
|
|
|
*License* : Apache 2.0
|
|
|
*License URL* : http://www.apache.org/licenses/LICENSE-2.0.html
|
|
|
*Terms of service* : null
|
|
|
|
|
|
|
|
|
### URI scheme
|
|
|
*Host* : SCHEMA_SERVICE_GOOGLE_ENDPOINT_NAME_VALUE
|
|
|
*BasePath* : /de
|
|
|
|
|
|
|
|
|
### Tags
|
|
|
|
|
|
* schema : Schema Controller
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a name="paths"></a>
|
|
|
## Paths
|
|
|
|
|
|
<a name="addschema"></a>
|
|
|
### Adds a schema to the schema repository.
|
|
|
```
|
|
|
POST /schema-service/v1/schema
|
|
|
```
|
|
|
|
|
|
|
|
|
#### Description
|
|
|
Adds a schema to the schema repository.
|
|
|
|
|
|
|
|
|
#### Parameters
|
|
|
|
|
|
|Type|Name|Description|Schema|
|
|
|
|---|---|---|---|
|
|
|
|**Header**|**Slb-Data-Partition-Id** <br>*required*|Data Paritition ID|string|
|
|
|
|**Header**|**Slb-On-Behalf-Of** <br>*optional*|Slb On Behalf Of header|string|
|
|
|
|**Body**|**SchemaRequest** <br>*required*|SchemaRequest|[SchemaRequest](#schemarequest)|
|
|
|
|
|
|
|
|
|
#### Responses
|
|
|
|
|
|
|HTTP Code|Description|Schema|
|
|
|
|---|---|---|
|
|
|
|**200**|OK|[Schema Info](#schema-info)|
|
|
|
|**201**|item created|[Schema Info](#schema-info)|
|
|
|
|**400**|invalid input, object invalid|No Content|
|
|
|
|**401**|Unauthorized|No Content|
|
|
|
|**403**|Forbidden|No Content|
|
|
|
|**404**|Not Found|No Content|
|
|
|
|
|
|
|
|
|
#### Consumes
|
|
|
|
|
|
* `application/json`
|
|
|
|
|
|
|
|
|
#### Produces
|
|
|
|
|
|
* `application/json`
|
|
|
|
|
|
|
|
|
#### Tags
|
|
|
|
|
|
* schema
|
|
|
|
|
|
|
|
|
#### Security
|
|
|
|
|
|
|Type|Name|
|
|
|
|---|---|
|
|
|
|**oauth2**|**[sauth_id_token](#sauth_id_token)**|
|
|
|
|**oauth2**|**[google_id_token](#google_id_token)**|
|
|
|
|
|
|
|
|
|
<a name="updateschema"></a>
|
|
|
### Updates a schema to the schema repository.
|
|
|
```
|
|
|
PUT /schema-service/v1/schema
|
|
|
```
|
|
|
|
|
|
|
|
|
#### Description
|
|
|
Updates a schema to the schema repository
|
|
|
|
|
|
|
|
|
#### Parameters
|
|
|
|
|
|
|Type|Name|Description|Schema|
|
|
|
|---|---|---|---|
|
|
|
|**Header**|**Slb-Data-Partition-Id** <br>*required*|Data Paritition ID|string|
|
|
|
|**Header**|**Slb-On-Behalf-Of** <br>*optional*|Slb On Behalf Of header|string|
|
|
|
|**Body**|**SchemaRequest** <br>*required*|SchemaRequest|[SchemaRequest](#schemarequest)|
|
|
|
|
|
|
|
|
|
#### Responses
|
|
|
|
|
|
|HTTP Code|Description|Schema|
|
|
|
|---|---|---|
|
|
|
|**200**|OK|[Schema Info](#schema-info)|
|
|
|
|**201**|Created|No Content|
|
|
|
|**204**|item updated|[Schema Info](#schema-info)|
|
|
|
|**400**|invalid input, object invalid|No Content|
|
|
|
|**401**|Unauthorized|No Content|
|
|
|
|**403**|Forbidden|No Content|
|
|
|
|**404**|Not Found|No Content|
|
|
|
|
|
|
|
|
|
#### Consumes
|
|
|
|
|
|
* `application/json`
|
|
|
|
|
|
|
|
|
#### Produces
|
|
|
|
|
|
* `application/json`
|
|
|
|
|
|
|
|
|
#### Tags
|
|
|
|
|
|
* schema
|
|
|
|
|
|
|
|
|
#### Security
|
|
|
|
|
|
|Type|Name|
|
|
|
|---|---|
|
|
|
|**oauth2**|**[sauth_id_token](#sauth_id_token)**|
|
|
|
|**oauth2**|**[google_id_token](#google_id_token)**|
|
|
|
|
|
|
|
|
|
<a name="getschemausingget"></a>
|
|
|
### getSchema
|
|
|
```
|
|
|
GET /schema-service/v1/schema/{id}
|
|
|
```
|
|
|
|
|
|
|
|
|
#### Parameters
|
|
|
|
|
|
|Type|Name|Description|Schema|
|
|
|
|---|---|---|---|
|
|
|
|**Header**|**Slb-Data-Partition-Id** <br>*required*|Data Paritition ID|string|
|
|
|
|**Header**|**Slb-On-Behalf-Of** <br>*optional*|Slb On Behalf Of header|string|
|
|
|
|**Path**|**id** <br>*required*|id|string|
|
|
|
|
|
|
|
|
|
#### Responses
|
|
|
|
|
|
|HTTP Code|Description|Schema|
|
|
|
|---|---|---|
|
|
|
|**200**|OK|object|
|
|
|
|**401**|Unauthorized|No Content|
|
|
|
|**403**|Forbidden|No Content|
|
|
|
|**404**|Not Found|No Content|
|
|
|
|
|
|
|
|
|
#### Produces
|
|
|
|
|
|
* `application/json`
|
|
|
|
|
|
|
|
|
#### Tags
|
|
|
|
|
|
* schema
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a name="definitions"></a>
|
|
|
## Definitions
|
|
|
|
|
|
<a name="schema-info"></a>
|
|
|
### Schema Info
|
|
|
Schema info including status, creation and schemaIdentity
|
|
|
|
|
|
|
|
|
|Name|Description|Schema|
|
|
|
|---|---|---|
|
|
|
|**createdBy** <br>*optional*|Created By <br>**Example** : `"John Smith"`|string|
|
|
|
|**dateCreated** <br>*optional*||string (date-time)|
|
|
|
|**schemaIdentity** <br>*optional*||[SchemaIdentity](#schemaidentity)|
|
|
|
|**scope** <br>*optional*||enum (PRIVATE, PUBLIC)|
|
|
|
|**status** <br>*optional*||enum (PUBLISHED, OBSOLETE, DEVELOPMENT)|
|
|
|
|**supersededBy** <br>*optional*||[SchemaIdentity](#schemaidentity)|
|
|
|
|
|
|
|
|
|
<a name="schemaidentity"></a>
|
|
|
### SchemaIdentity
|
|
|
|
|
|
|Name|Schema|
|
|
|
|---|---|
|
|
|
|**authority** <br>*optional*|string|
|
|
|
|**entity** <br>*optional*|string|
|
|
|
|**id** <br>*optional*|string|
|
|
|
|**schemaVersionMajor** <br>*optional*|integer (int64)|
|
|
|
|**schemaVersionMinor** <br>*optional*|integer (int64)|
|
|
|
|**source** <br>*optional*|string|
|
|
|
|
|
|
|
|
|
<a name="schemarequest"></a>
|
|
|
### SchemaRequest
|
|
|
|
|
|
|Name|Schema|
|
|
|
|---|---|
|
|
|
|**schema** <br>*optional*|object|
|
|
|
|**schemaInfo** <br>*optional*|[Schema Info](#schema-info)|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a name="securityscheme"></a>
|
|
|
## Security
|
|
|
|
|
|
<a name="api_key"></a>
|
|
|
### api_key
|
|
|
*Type* : apiKey
|
|
|
*Name* : key
|
|
|
*In* : QUERY
|
|
|
|
|
|
|
|
|
<a name="google_id_token"></a>
|
|
|
### google_id_token
|
|
|
*Type* : oauth2
|
|
|
*Flow* : implicit
|
|
|
*Token URL* : OAUTH_AUTHORIZATION_URL_VALUE
|
|
|
|
|
|
|
|
|
<a name="sauth_id_token"></a>
|
|
|
### sauth_id_token
|
|
|
*Type* : oauth2
|
|
|
*Flow* : implicit
|
|
|
*Token URL* : SAUTH_AUTHORIZATION_URL_VALUE
|
|
|
|
|
|
|
|
|
|