Schema

A Schema is a data structure used in all domains. For example, data forms of Google OAuth2 credentials or AWS access keys can be a Schema resource.

Package : spaceone.api.repository.v1

Schema

Schema Methods:

Method	Request	Response
create	CreateSchemaRequest	SchemaInfo
update	UpdateSchemaRequest	SchemaInfo
delete	SchemaRequest	google.protobuf.Empty
get	GetRepositorySchemaRequest	SchemaInfo
list	SchemaQuery	SchemasInfo
stat	SchemaStatQuery	google.protobuf.Struct

create

POST /repository/v1/schemas

Type	Message
Request	CreateSchemaRequest
Response	SchemaInfo

update

PUT /repository/v1/schema/{schema}

Updates a specific Schema. You can make changes in Schema settings, including name, schema, labels, and tags.

Type	Message
Request	UpdateSchemaRequest
Response	SchemaInfo

Request Example

{
    "name": "slack_webhook_test",
    "schema": {},
    "labels": [],
    "tags": {},
    "domain_id": "domain-987654321098"
}

Response Example

{
    "name": "slack_webhook_test",
    "service_type": "secret.credentials",
    "schema": {},
    "labels": [],
    "tags": {
        "description": "Slack Webhook"
    },
    "repository_info": {
        "repository_id": "repo-123456789012",
        "name": "Local",
        "repository_type": "local"
    },
    "domain_id": "domain-987654321098",
    "created_at": "2022-01-01T05:46:49.929Z",
    "updated_at": "2022-01-01T05:46:49.929Z"
}

delete

DELETE /repository/v1/schema/{schema}

Deletes a specific Schema. You must specify the name of the Schema to delete, as the name is an identifier of Schema resources.

Type	Message
Request	SchemaRequest
Response	google.protobuf.Empty

Request Example

{
    "name": "slack_webhook"
}

get

GET /repository/v1/schemas/{schema}

Gets a specific Schema. You must specify the name of the Schema to get, as the name is an identifier of Schema resources. You can use the parameter repository_id to limit the scope of the method to a specific Repository.

Type	Message
Request	GetRepositorySchemaRequest
Response	SchemaInfo

Request Example

{
    "name": "slack_webhook",
    "repository_id": "repo-123456789012"
}

Response Example

{
    "name": "slack_webhook",
    "service_type": "secret.credentials",
    "schema": {},
    "labels": [],
    "tags": {
        "description": "Slack Webhook"
    },
    "repository_info": {
        "repository_id": "repo-123456789012",
        "name": "Local",
        "repository_type": "local"
    },
    "domain_id": "domain-987654321098",
    "created_at": "2022-01-01T10:20:09.064Z",
    "updated_at": "2022-01-01T10:20:09.064Z"
}

list

GET /repository/v1/schemas

POST /repository/v1/schemas/search

Gets a list of all Schemas in a specific Repository. The parameter repository_id is used as an identifier of a Repository to get its list of Schemas. You can use a query to get a filtered list of Schemas.

Type	Message
Request	SchemaQuery
Response	SchemasInfo

Request Example

{
    "query": {},
    "name": "slack_webhook",
    "service_type": "secret.credentials",
    "repository_id": "repo-123456789012"
}

Response Example

{
    "results": [
        {
            "name": "slack_webhook",
            "service_type": "secret.credentials",
            "schema": {},
            "labels": [],
            "tags": {
                "description": "Slack Webhook"
            },
            "repository_info": {
                "repository_id": "repo-123456789012",
                "name": "Local",
                "repository_type": "local"
            },
            "domain_id": "domain-987654321098",
            "created_at": "2022-01-01T10:20:09.064Z",
            "updated_at": "2022-01-01T10:20:09.064Z"
        }
    ],
    "total_count": 1
}

stat

POST /repository/v1/schemas/stat

Type	Message
Request	SchemaStatQuery
Response	google.protobuf.Struct

Message

CreateSchemaRequest

Field	Type	Required	Description
name	string	✔
service_type	string	✔
schema_id	string	✔
schema	google.protobuf.Struct	✔
labels	google.protobuf.ListValue	✘
tags	google.protobuf.Struct	✘
project_id	string	✘
domain_id	string	✔

GetRepositorySchemaRequest

Field	Type	Required	Description
name	string	✔
domain_id	string	✔
repository_id	string	✘
only	list of string	✘
schema_id	string	✘

SchemaInfo

Field	Type	Description
name	string
service_type	string
schema_id	string
schema	google.protobuf.Struct
labels	google.protobuf.ListValue
tags	google.protobuf.Struct
repository_info	RepositoryInfo
project_id	string
domain_id	string
created_at	string
updated_at	string

SchemaQuery

Field	Type	Required	Description
query	spaceone.api.core.v1.Query	✘
name	string	✘
service_type	string	✘
project_id	string	✔
repository_id	string	✔
domain_id	string	✔
schema_id	string	✘
state	NONE ENABLED DISABLED	✘

SchemaRequest

Field	Type	Required	Description
name	string	✔
domain_id	string	✔
schema_id	string	✘

SchemaStatQuery

Field	Type	Required	Description
query	spaceone.api.core.v1.StatisticsQuery	✔
repository_id	string	✔
domain_id	string	✔

SchemasInfo

Field	Type	Description
results	list of SchemaInfo
total_count	int32

UpdateSchemaRequest

Field	Type	Required	Description
name	string	✔
schema	google.protobuf.Struct	✘
labels	google.protobuf.ListValue	✘
tags	google.protobuf.Struct	✘
domain_id	string	✔