Skip to content

Instantly share code, notes, and snippets.

@cyrilMargaria

cyrilMargaria/test.yaml

Last active May 20, 2020 08:23
Show Gist options
  • Save cyrilMargaria/a24eaada7d7bed0a41cbbf2ae3d0f9e6 to your computer and use it in GitHub Desktop.
Save cyrilMargaria/a24eaada7d7bed0a41cbbf2ae3d0f9e6 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
test.yaml
{
"swagger": "2.0",
"info": {
"description": "ietf-keystore API generated from ietf-keystore.yang",
"version": "1.0.0",
"title": "ietf-keystore API"
},
"host": "localhost:3000",
"basePath": "/",
"schemes": [
"http"
],
"tags": [
{
"name": "keystore"
}
],
"paths": {
"/keystore/": {
"post": {
"summary": "Create keystore",
"description": "Create operation of resource: keystore",
"operationId": "createkeystore",
"produces": [
"application/json"
],
"consumes": [
"application/json"
],
"x-cliParam": {
"paramKeys": [],
"readfmtstring": "/keystore/",
"writefmtstring": "{\\\"keystore\\\": %s}",
"writeparams": []
},
"tags": [
"keystore"
],
"parameters": [
{
"in": "body",
"name": "body_keystore",
"schema": {
"$ref": "#/definitions/keystore-grouping"
},
"description": "keystorebody object"
}
],
"responses": {
"200": {
"description": "Successful operation"
},
"400": {
"description": "Internal Error"
}
}
},
"get": {
"summary": "Read keystore",
"description": "Read operation of resource: keystore",
"operationId": "readkeystore",
"produces": [
"application/json"
],
"consumes": [
"application/json"
],
"x-cliParam": {
"paramKeys": [],
"readfmtstring": "/keystore/",
"writefmtstring": "{\\\"keystore\\\": %s}",
"writeparams": []
},
"tags": [
"keystore"
],
"parameters": [
{
"description": "true queries un-committed configuration",
"in": "query",
"name": "working",
"type": "boolean"
}
],
"responses": {
"200": {
"description": "Successful operation",
"schema": {
"$ref": "#/definitions/keystore-grouping"
}
},
"400": {
"description": "Internal Error"
}
}
},
"put": {
"summary": "Update keystore",
"description": "Update operation of resource: keystore",
"operationId": "updatekeystore",
"produces": [
"application/json"
],
"consumes": [
"application/json"
],
"x-cliParam": {
"paramKeys": [],
"readfmtstring": "/keystore/",
"writefmtstring": "{\\\"keystore\\\": %s}",
"writeparams": []
},
"tags": [
"keystore"
],
"parameters": [
{
"in": "body",
"name": "body_keystore",
"schema": {
"$ref": "#/definitions/keystore-grouping"
},
"description": "keystorebody object"
}
],
"responses": {
"200": {
"description": "Successful operation"
},
"400": {
"description": "Internal Error"
}
}
},
"delete": {
"summary": "Delete keystore",
"description": "Delete operation of resource: keystore",
"operationId": "deletekeystore",
"produces": [
"application/json"
],
"consumes": [
"application/json"
],
"x-cliParam": {
"paramKeys": [],
"readfmtstring": "/keystore/",
"writefmtstring": "{\\\"keystore\\\": %s}",
"writeparams": []
},
"tags": [
"keystore"
],
"responses": {
"200": {
"description": "Successful operation"
},
"400": {
"description": "Internal Error"
}
}
}
},
"/keystore/asymmetric-keys/": {
"post": {
"summary": "Create asymmetric-keys",
"description": "Create operation of resource: asymmetric-keys",
"operationId": "createkeystoreasymmetric-keys",
"produces": [
"application/json"
],
"consumes": [
"application/json"
],
"x-cliParam": {
"paramKeys": [],
"readfmtstring": "/keystore/asymmetric-keys/",
"writefmtstring": "{\\\"keystore\\\": {\\\"asymmetric-keys\\\": %s}}",
"writeparams": []
},
"tags": [
"keystore"
],
"parameters": [
{
"in": "body",
"name": "body_asymmetric-keys",
"schema": {
"$ref": "#/definitions/asymmetric-keys_schema"
},
"description": "asymmetric-keysbody object"
}
],
"responses": {
"200": {
"description": "Successful operation"
},
"400": {
"description": "Internal Error"
}
}
},
"get": {
"summary": "Read asymmetric-keys",
"description": "Read operation of resource: asymmetric-keys",
"operationId": "readkeystoreasymmetric-keys",
"produces": [
"application/json"
],
"consumes": [
"application/json"
],
"x-cliParam": {
"paramKeys": [],
"readfmtstring": "/keystore/asymmetric-keys/",
"writefmtstring": "{\\\"keystore\\\": {\\\"asymmetric-keys\\\": %s}}",
"writeparams": []
},
"tags": [
"keystore"
],
"parameters": [
{
"description": "true queries un-committed configuration",
"in": "query",
"name": "working",
"type": "boolean"
}
],
"responses": {
"200": {
"description": "Successful operation",
"schema": {
"$ref": "#/definitions/asymmetric-keys_schema"
}
},
"400": {
"description": "Internal Error"
}
}
},
"put": {
"summary": "Update asymmetric-keys",
"description": "Update operation of resource: asymmetric-keys",
"operationId": "updatekeystoreasymmetric-keys",
"produces": [
"application/json"
],
"consumes": [
"application/json"
],
"x-cliParam": {
"paramKeys": [],
"readfmtstring": "/keystore/asymmetric-keys/",
"writefmtstring": "{\\\"keystore\\\": {\\\"asymmetric-keys\\\": %s}}",
"writeparams": []
},
"tags": [
"keystore"
],
"parameters": [
{
"in": "body",
"name": "body_asymmetric-keys",
"schema": {
"$ref": "#/definitions/asymmetric-keys_schema"
},
"description": "asymmetric-keysbody object"
}
],
"responses": {
"200": {
"description": "Successful operation"
},
"400": {
"description": "Internal Error"
}
}
},
"delete": {
"summary": "Delete asymmetric-keys",
"description": "Delete operation of resource: asymmetric-keys",
"operationId": "deletekeystoreasymmetric-keys",
"produces": [
"application/json"
],
"consumes": [
"application/json"
],
"x-cliParam": {
"paramKeys": [],
"readfmtstring": "/keystore/asymmetric-keys/",
"writefmtstring": "{\\\"keystore\\\": {\\\"asymmetric-keys\\\": %s}}",
"writeparams": []
},
"tags": [
"keystore"
],
"responses": {
"200": {
"description": "Successful operation"
},
"400": {
"description": "Internal Error"
}
}
}
},
"/keystore/asymmetric-keys/asymmetric-key/": {
"post": {
"summary": "Create asymmetric-key",
"description": "Create operation of resource: asymmetric-key",
"operationId": "createkeystoreasymmetric-keysasymmetric-key",
"produces": [
"application/json"
],
"consumes": [
"application/json"
],
"x-cliParam": {
"paramKeys": [],
"readfmtstring": "/keystore/asymmetric-keys/asymmetric-key/",
"writefmtstring": "{\\\"keystore\\\": {\\\"asymmetric-keys\\\": {\\\"asymmetric-key\\\": %s}}}",
"writeparams": []
},
"tags": [
"keystore"
],
"parameters": [
{
"in": "body",
"name": "body_asymmetric-key",
"schema": {
"$ref": "#/definitions/asymmetric-key_schema"
},
"description": "asymmetric-keybody object"
}
],
"responses": {
"200": {
"description": "Successful operation"
},
"400": {
"description": "Internal Error"
}
}
},
"get": {
"summary": "Read asymmetric-key",
"description": "Read operation of resource: asymmetric-key",
"operationId": "readkeystoreasymmetric-keysasymmetric-key",
"produces": [
"application/json"
],
"consumes": [
"application/json"
],
"x-cliParam": {
"paramKeys": [],
"readfmtstring": "/keystore/asymmetric-keys/asymmetric-key/",
"writefmtstring": "{\\\"keystore\\\": {\\\"asymmetric-keys\\\": {\\\"asymmetric-key\\\": %s}}}",
"writeparams": []
},
"tags": [
"keystore"
],
"parameters": [
{
"description": "true queries un-committed configuration",
"in": "query",
"name": "working",
"type": "boolean"
}
],
"responses": {
"200": {
"description": "Successful operation",
"schema": {
"$ref": "#/definitions/asymmetric-key_schema"
}
},
"400": {
"description": "Internal Error"
}
}
},
"put": {
"summary": "Update asymmetric-key",
"description": "Update operation of resource: asymmetric-key",
"operationId": "updatekeystoreasymmetric-keysasymmetric-key",
"produces": [
"application/json"
],
"consumes": [
"application/json"
],
"x-cliParam": {
"paramKeys": [],
"readfmtstring": "/keystore/asymmetric-keys/asymmetric-key/",
"writefmtstring": "{\\\"keystore\\\": {\\\"asymmetric-keys\\\": {\\\"asymmetric-key\\\": %s}}}",
"writeparams": []
},
"tags": [
"keystore"
],
"parameters": [
{
"in": "body",
"name": "body_asymmetric-key",
"schema": {
"$ref": "#/definitions/asymmetric-key_schema"
},
"description": "asymmetric-keybody object"
}
],
"responses": {
"200": {
"description": "Successful operation"
},
"400": {
"description": "Internal Error"
}
}
},
"delete": {
"summary": "Delete asymmetric-key",
"description": "Delete operation of resource: asymmetric-key",
"operationId": "deletekeystoreasymmetric-keysasymmetric-key",
"produces": [
"application/json"
],
"consumes": [
"application/json"
],
"x-cliParam": {
"paramKeys": [],
"readfmtstring": "/keystore/asymmetric-keys/asymmetric-key/",
"writefmtstring": "{\\\"keystore\\\": {\\\"asymmetric-keys\\\": {\\\"asymmetric-key\\\": %s}}}",
"writeparams": []
},
"tags": [
"keystore"
],
"responses": {
"200": {
"description": "Successful operation"
},
"400": {
"description": "Internal Error"
}
}
}
},
"/keystore/asymmetric-keys/asymmetric-key/{name}/": {
"post": {
"summary": "Create asymmetric-key by ID",
"description": "Create operation of resource: asymmetric-key",
"operationId": "createkeystoreasymmetric-keysasymmetric-keyByID",
"produces": [
"application/json"
],
"consumes": [
"application/json"
],
"x-cliParam": {
"paramKeys": [
{
"key": "name"
}
],
"readfmtstring": "/keystore/asymmetric-keys/asymmetric-key[name=%s]/",
"writefmtstring": "{\\\"keystore\\\": {\\\"asymmetric-keys\\\": {\\\"asymmetric-key\\\": [%s]}}}",
"writeparams": []
},
"tags": [
"keystore"
],
"parameters": [
{
"in": "path",
"name": "name",
"description": "ID of name",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body_asymmetric-key",
"schema": {
"$ref": "#/definitions/asymmetric-key_listschema"
},
"description": "asymmetric-keybody object"
}
],
"responses": {
"200": {
"description": "Successful operation"
},
"400": {
"description": "Internal Error"
}
}
},
"get": {
"summary": "Read asymmetric-key by ID",
"description": "Read operation of resource: asymmetric-key",
"operationId": "readkeystoreasymmetric-keysasymmetric-keyByID",
"produces": [
"application/json"
],
"consumes": [
"application/json"
],
"x-cliParam": {
"paramKeys": [
{
"key": "name"
}
],
"readfmtstring": "/keystore/asymmetric-keys/asymmetric-key[name=%s]/",
"writefmtstring": "{\\\"keystore\\\": {\\\"asymmetric-keys\\\": {\\\"asymmetric-key\\\": [%s]}}}",
"writeparams": []
},
"tags": [
"keystore"
],
"parameters": [
{
"in": "path",
"name": "name",
"description": "ID of name",
"required": true,
"type": "string"
},
{
"description": "true queries un-committed configuration",
"in": "query",
"name": "working",
"type": "boolean"
}
],
"responses": {
"200": {
"description": "Successful operation",
"schema": {
"$ref": "#/definitions/asymmetric-key_listschema"
}
},
"400": {
"description": "Internal Error"
}
}
},
"put": {
"summary": "Update asymmetric-key by ID",
"description": "Update operation of resource: asymmetric-key",
"operationId": "updatekeystoreasymmetric-keysasymmetric-keyByID",
"produces": [
"application/json"
],
"consumes": [
"application/json"
],
"x-cliParam": {
"paramKeys": [
{
"key": "name"
}
],
"readfmtstring": "/keystore/asymmetric-keys/asymmetric-key[name=%s]/",
"writefmtstring": "{\\\"keystore\\\": {\\\"asymmetric-keys\\\": {\\\"asymmetric-key\\\": [%s]}}}",
"writeparams": []
},
"tags": [
"keystore"
],
"parameters": [
{
"in": "path",
"name": "name",
"description": "ID of name",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body_asymmetric-key",
"schema": {
"$ref": "#/definitions/asymmetric-key_listschema"
},
"description": "asymmetric-keybody object"
}
],
"responses": {
"200": {
"description": "Successful operation"
},
"400": {
"description": "Internal Error"
}
}
},
"delete": {
"summary": "Delete asymmetric-key by ID",
"description": "Delete operation of resource: asymmetric-key",
"operationId": "deletekeystoreasymmetric-keysasymmetric-keyByID",
"produces": [
"application/json"
],
"consumes": [
"application/json"
],
"x-cliParam": {
"paramKeys": [
{
"key": "name"
}
],
"readfmtstring": "/keystore/asymmetric-keys/asymmetric-key[name=%s]/",
"writefmtstring": "{\\\"keystore\\\": {\\\"asymmetric-keys\\\": {\\\"asymmetric-key\\\": [%s]}}}",
"writeparams": []
},
"tags": [
"keystore"
],
"parameters": [
{
"in": "path",
"name": "name",
"description": "ID of name",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Successful operation"
},
"400": {
"description": "Internal Error"
}
}
}
},
"/configuration/commit": {
"post": {
"responses": {
"200": {
"description": "Successful operation"
},
"400": {
"description": "Internal Error"
}
},
"description": "Commit configuration",
"parameters": [
{
"type": "boolean",
"description": "Check correctness of syntax; do not apply changes",
"name": "check",
"in": "query"
},
{
"type": "string",
"description": "Commit log",
"name": "log",
"in": "query"
}
],
"produces": [
"application/json"
],
"tags": [
"configuration"
],
"consumes": [
"application/json"
],
"operationId": "ConfigurationCommit",
"x-cliParam": {
"no-autogenerate": true
}
}
},
"/doc": {
"get": {
"responses": {
"200": {
"description": "Successful operation",
"schema": {
"type": "file"
}
},
"400": {
"description": "Internal Error"
}
},
"produces": [
"application/octet-stream"
],
"operationId": "Doc",
"x-cliParam": {
"no-autogenerate": true
},
"tags": [
"doc"
],
"consumes": [
"application/json"
],
"description": "Get swagger specification file in json format "
}
},
"/keystore/asymmetric-keys/asymmetric-key/{name}/certificates/": {
"post": {
"summary": "Create certificates",
"description": "Create operation of resource: certificates",
"operationId": "createkeystoreasymmetric-keysasymmetric-keycertificates",
"produces": [
"application/json"
],
"consumes": [
"application/json"
],
"x-cliParam": {
"paramKeys": [
{
"key": "name"
}
],
"readfmtstring": "/keystore/asymmetric-keys/asymmetric-key[name=%s]/certificates/",
"writefmtstring": "{\\\"keystore\\\": {\\\"asymmetric-keys\\\": {\\\"asymmetric-key\\\": [{\\\"name\\\": \\\"%s\\\", \\\"certificates\\\": %s}]}}}",
"writeparams": [
{
"key": "name"
}
]
},
"tags": [
"keystore"
],
"parameters": [
{
"in": "path",
"name": "name",
"description": "ID of name",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body_certificates",
"schema": {
"$ref": "#/definitions/certificates_schema"
},
"description": "certificatesbody object"
}
],
"responses": {
"200": {
"description": "Successful operation"
},
"400": {
"description": "Internal Error"
}
}
},
"get": {
"summary": "Read certificates",
"description": "Read operation of resource: certificates",
"operationId": "readkeystoreasymmetric-keysasymmetric-keycertificates",
"produces": [
"application/json"
],
"consumes": [
"application/json"
],
"x-cliParam": {
"paramKeys": [
{
"key": "name"
}
],
"readfmtstring": "/keystore/asymmetric-keys/asymmetric-key[name=%s]/certificates/",
"writefmtstring": "{\\\"keystore\\\": {\\\"asymmetric-keys\\\": {\\\"asymmetric-key\\\": [{\\\"name\\\": \\\"%s\\\", \\\"certificates\\\": %s}]}}}",
"writeparams": [
{
"key": "name"
}
]
},
"tags": [
"keystore"
],
"parameters": [
{
"in": "path",
"name": "name",
"description": "ID of name",
"required": true,
"type": "string"
},
{
"description": "true queries un-committed configuration",
"in": "query",
"name": "working",
"type": "boolean"
}
],
"responses": {
"200": {
"description": "Successful operation",
"schema": {
"$ref": "#/definitions/certificates_schema"
}
},
"400": {
"description": "Internal Error"
}
}
},
"put": {
"summary": "Update certificates",
"description": "Update operation of resource: certificates",
"operationId": "updatekeystoreasymmetric-keysasymmetric-keycertificates",
"produces": [
"application/json"
],
"consumes": [
"application/json"
],
"x-cliParam": {
"paramKeys": [
{
"key": "name"
}
],
"readfmtstring": "/keystore/asymmetric-keys/asymmetric-key[name=%s]/certificates/",
"writefmtstring": "{\\\"keystore\\\": {\\\"asymmetric-keys\\\": {\\\"asymmetric-key\\\": [{\\\"name\\\": \\\"%s\\\", \\\"certificates\\\": %s}]}}}",
"writeparams": [
{
"key": "name"
}
]
},
"tags": [
"keystore"
],
"parameters": [
{
"in": "path",
"name": "name",
"description": "ID of name",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body_certificates",
"schema": {
"$ref": "#/definitions/certificates_schema"
},
"description": "certificatesbody object"
}
],
"responses": {
"200": {
"description": "Successful operation"
},
"400": {
"description": "Internal Error"
}
}
},
"delete": {
"summary": "Delete certificates",
"description": "Delete operation of resource: certificates",
"operationId": "deletekeystoreasymmetric-keysasymmetric-keycertificates",
"produces": [
"application/json"
],
"consumes": [
"application/json"
],
"x-cliParam": {
"paramKeys": [
{
"key": "name"
}
],
"readfmtstring": "/keystore/asymmetric-keys/asymmetric-key[name=%s]/certificates/",
"writefmtstring": "{\\\"keystore\\\": {\\\"asymmetric-keys\\\": {\\\"asymmetric-key\\\": [{\\\"name\\\": \\\"%s\\\", \\\"certificates\\\": %s}]}}}",
"writeparams": [
{
"key": "name"
}
]
},
"tags": [
"keystore"
],
"parameters": [
{
"in": "path",
"name": "name",
"description": "ID of name",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Successful operation"
},
"400": {
"description": "Internal Error"
}
}
}
},
"/keystore/asymmetric-keys/asymmetric-key/{name}/certificates/certificate/": {
"post": {
"summary": "Create certificate",
"description": "Create operation of resource: certificate",
"operationId": "createkeystoreasymmetric-keysasymmetric-keycertificatescertificate",
"produces": [
"application/json"
],
"consumes": [
"application/json"
],
"x-cliParam": {
"paramKeys": [
{
"key": "name"
}
],
"readfmtstring": "/keystore/asymmetric-keys/asymmetric-key[name=%s]/certificates/certificate/",
"writefmtstring": "{\\\"keystore\\\": {\\\"asymmetric-keys\\\": {\\\"asymmetric-key\\\": [{\\\"name\\\": \\\"%s\\\", \\\"certificates\\\": {\\\"certificate\\\": %s}}]}}}",
"writeparams": [
{
"key": "name"
}
]
},
"tags": [
"keystore"
],
"parameters": [
{
"in": "path",
"name": "name",
"description": "ID of name",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body_certificate",
"schema": {
"$ref": "#/definitions/certificate_schema"
},
"description": "certificatebody object"
}
],
"responses": {
"200": {
"description": "Successful operation"
},
"400": {
"description": "Internal Error"
}
}
},
"get": {
"summary": "Read certificate",
"description": "Read operation of resource: certificate",
"operationId": "readkeystoreasymmetric-keysasymmetric-keycertificatescertificate",
"produces": [
"application/json"
],
"consumes": [
"application/json"
],
"x-cliParam": {
"paramKeys": [
{
"key": "name"
}
],
"readfmtstring": "/keystore/asymmetric-keys/asymmetric-key[name=%s]/certificates/certificate/",
"writefmtstring": "{\\\"keystore\\\": {\\\"asymmetric-keys\\\": {\\\"asymmetric-key\\\": [{\\\"name\\\": \\\"%s\\\", \\\"certificates\\\": {\\\"certificate\\\": %s}}]}}}",
"writeparams": [
{
"key": "name"
}
]
},
"tags": [
"keystore"
],
"parameters": [
{
"in": "path",
"name": "name",
"description": "ID of name",
"required": true,
"type": "string"
},
{
"description": "true queries un-committed configuration",
"in": "query",
"name": "working",
"type": "boolean"
}
],
"responses": {
"200": {
"description": "Successful operation",
"schema": {
"$ref": "#/definitions/certificate_schema"
}
},
"400": {
"description": "Internal Error"
}
}
},
"put": {
"summary": "Update certificate",
"description": "Update operation of resource: certificate",
"operationId": "updatekeystoreasymmetric-keysasymmetric-keycertificatescertificate",
"produces": [
"application/json"
],
"consumes": [
"application/json"
],
"x-cliParam": {
"paramKeys": [
{
"key": "name"
}
],
"readfmtstring": "/keystore/asymmetric-keys/asymmetric-key[name=%s]/certificates/certificate/",
"writefmtstring": "{\\\"keystore\\\": {\\\"asymmetric-keys\\\": {\\\"asymmetric-key\\\": [{\\\"name\\\": \\\"%s\\\", \\\"certificates\\\": {\\\"certificate\\\": %s}}]}}}",
"writeparams": [
{
"key": "name"
}
]
},
"tags": [
"keystore"
],
"parameters": [
{
"in": "path",
"name": "name",
"description": "ID of name",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body_certificate",
"schema": {
"$ref": "#/definitions/certificate_schema"
},
"description": "certificatebody object"
}
],
"responses": {
"200": {
"description": "Successful operation"
},
"400": {
"description": "Internal Error"
}
}
},
"delete": {
"summary": "Delete certificate",
"description": "Delete operation of resource: certificate",
"operationId": "deletekeystoreasymmetric-keysasymmetric-keycertificatescertificate",
"produces": [
"application/json"
],
"consumes": [
"application/json"
],
"x-cliParam": {
"paramKeys": [
{
"key": "name"
}
],
"readfmtstring": "/keystore/asymmetric-keys/asymmetric-key[name=%s]/certificates/certificate/",
"writefmtstring": "{\\\"keystore\\\": {\\\"asymmetric-keys\\\": {\\\"asymmetric-key\\\": [{\\\"name\\\": \\\"%s\\\", \\\"certificates\\\": {\\\"certificate\\\": %s}}]}}}",
"writeparams": [
{
"key": "name"
}
]
},
"tags": [
"keystore"
],
"parameters": [
{
"in": "path",
"name": "name",
"description": "ID of name",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Successful operation"
},
"400": {
"description": "Internal Error"
}
}
}
},
"/keystore/asymmetric-keys/asymmetric-key/{name}/certificates/certificate/{certificate_name}/": {
"post": {
"summary": "Create certificate by ID",
"description": "Create operation of resource: certificate",
"operationId": "createkeystoreasymmetric-keysasymmetric-keycertificatescertificateByID",
"produces": [
"application/json"
],
"consumes": [
"application/json"
],
"x-cliParam": {
"paramKeys": [
{
"key": "name"
},
{
"key": "certificate_name"
}
],
"readfmtstring": "/keystore/asymmetric-keys/asymmetric-key[name=%s]/certificates/certificate[name=%s]/",
"writefmtstring": "{\\\"keystore\\\": {\\\"asymmetric-keys\\\": {\\\"asymmetric-key\\\": [{\\\"name\\\": \\\"%s\\\", \\\"certificates\\\": {\\\"certificate\\\": [%s]}}]}}}",
"writeparams": [
{
"key": "name"
}
]
},
"tags": [
"keystore"
],
"parameters": [
{
"in": "path",
"name": "name",
"description": "ID of name",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "certificate_name",
"description": "ID of certificate_name",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body_certificate",
"schema": {
"$ref": "#/definitions/certificate_listschema"
},
"description": "certificatebody object"
}
],
"responses": {
"200": {
"description": "Successful operation"
},
"400": {
"description": "Internal Error"
}
}
},
"get": {
"summary": "Read certificate by ID",
"description": "Read operation of resource: certificate",
"operationId": "readkeystoreasymmetric-keysasymmetric-keycertificatescertificateByID",
"produces": [
"application/json"
],
"consumes": [
"application/json"
],
"x-cliParam": {
"paramKeys": [
{
"key": "name"
},
{
"key": "certificate_name"
}
],
"readfmtstring": "/keystore/asymmetric-keys/asymmetric-key[name=%s]/certificates/certificate[name=%s]/",
"writefmtstring": "{\\\"keystore\\\": {\\\"asymmetric-keys\\\": {\\\"asymmetric-key\\\": [{\\\"name\\\": \\\"%s\\\", \\\"certificates\\\": {\\\"certificate\\\": [%s]}}]}}}",
"writeparams": [
{
"key": "name"
}
]
},
"tags": [
"keystore"
],
"parameters": [
{
"in": "path",
"name": "name",
"description": "ID of name",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "certificate_name",
"description": "ID of certificate_name",
"required": true,
"type": "string"
},
{
"description": "true queries un-committed configuration",
"in": "query",
"name": "working",
"type": "boolean"
}
],
"responses": {
"200": {
"description": "Successful operation",
"schema": {
"$ref": "#/definitions/certificate_listschema"
}
},
"400": {
"description": "Internal Error"
}
}
},
"put": {
"summary": "Update certificate by ID",
"description": "Update operation of resource: certificate",
"operationId": "updatekeystoreasymmetric-keysasymmetric-keycertificatescertificateByID",
"produces": [
"application/json"
],
"consumes": [
"application/json"
],
"x-cliParam": {
"paramKeys": [
{
"key": "name"
},
{
"key": "certificate_name"
}
],
"readfmtstring": "/keystore/asymmetric-keys/asymmetric-key[name=%s]/certificates/certificate[name=%s]/",
"writefmtstring": "{\\\"keystore\\\": {\\\"asymmetric-keys\\\": {\\\"asymmetric-key\\\": [{\\\"name\\\": \\\"%s\\\", \\\"certificates\\\": {\\\"certificate\\\": [%s]}}]}}}",
"writeparams": [
{
"key": "name"
}
]
},
"tags": [
"keystore"
],
"parameters": [
{
"in": "path",
"name": "name",
"description": "ID of name",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "certificate_name",
"description": "ID of certificate_name",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body_certificate",
"schema": {
"$ref": "#/definitions/certificate_listschema"
},
"description": "certificatebody object"
}
],
"responses": {
"200": {
"description": "Successful operation"
},
"400": {
"description": "Internal Error"
}
}
},
"delete": {
"summary": "Delete certificate by ID",
"description": "Delete operation of resource: certificate",
"operationId": "deletekeystoreasymmetric-keysasymmetric-keycertificatescertificateByID",
"produces": [
"application/json"
],
"consumes": [
"application/json"
],
"x-cliParam": {
"paramKeys": [
{
"key": "name"
},
{
"key": "certificate_name"
}
],
"readfmtstring": "/keystore/asymmetric-keys/asymmetric-key[name=%s]/certificates/certificate[name=%s]/",
"writefmtstring": "{\\\"keystore\\\": {\\\"asymmetric-keys\\\": {\\\"asymmetric-key\\\": [{\\\"name\\\": \\\"%s\\\", \\\"certificates\\\": {\\\"certificate\\\": [%s]}}]}}}",
"writeparams": [
{
"key": "name"
}
]
},
"tags": [
"keystore"
],
"parameters": [
{
"in": "path",
"name": "name",
"description": "ID of name",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "certificate_name",
"description": "ID of certificate_name",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Successful operation"
},
"400": {
"description": "Internal Error"
}
}
}
},
"/keystore/symmetric-keys/": {
"post": {
"summary": "Create symmetric-keys",
"description": "Create operation of resource: symmetric-keys",
"operationId": "createkeystoresymmetric-keys",
"produces": [
"application/json"
],
"consumes": [
"application/json"
],
"x-cliParam": {
"paramKeys": [],
"readfmtstring": "/keystore/symmetric-keys/",
"writefmtstring": "{\\\"keystore\\\": {\\\"symmetric-keys\\\": %s}}",
"writeparams": []
},
"tags": [
"keystore"
],
"parameters": [
{
"in": "body",
"name": "body_symmetric-keys",
"schema": {
"$ref": "#/definitions/symmetric-keys_schema"
},
"description": "symmetric-keysbody object"
}
],
"responses": {
"200": {
"description": "Successful operation"
},
"400": {
"description": "Internal Error"
}
}
},
"get": {
"summary": "Read symmetric-keys",
"description": "Read operation of resource: symmetric-keys",
"operationId": "readkeystoresymmetric-keys",
"produces": [
"application/json"
],
"consumes": [
"application/json"
],
"x-cliParam": {
"paramKeys": [],
"readfmtstring": "/keystore/symmetric-keys/",
"writefmtstring": "{\\\"keystore\\\": {\\\"symmetric-keys\\\": %s}}",
"writeparams": []
},
"tags": [
"keystore"
],
"parameters": [
{
"description": "true queries un-committed configuration",
"in": "query",
"name": "working",
"type": "boolean"
}
],
"responses": {
"200": {
"description": "Successful operation",
"schema": {
"$ref": "#/definitions/symmetric-keys_schema"
}
},
"400": {
"description": "Internal Error"
}
}
},
"put": {
"summary": "Update symmetric-keys",
"description": "Update operation of resource: symmetric-keys",
"operationId": "updatekeystoresymmetric-keys",
"produces": [
"application/json"
],
"consumes": [
"application/json"
],
"x-cliParam": {
"paramKeys": [],
"readfmtstring": "/keystore/symmetric-keys/",
"writefmtstring": "{\\\"keystore\\\": {\\\"symmetric-keys\\\": %s}}",
"writeparams": []
},
"tags": [
"keystore"
],
"parameters": [
{
"in": "body",
"name": "body_symmetric-keys",
"schema": {
"$ref": "#/definitions/symmetric-keys_schema"
},
"description": "symmetric-keysbody object"
}
],
"responses": {
"200": {
"description": "Successful operation"
},
"400": {
"description": "Internal Error"
}
}
},
"delete": {
"summary": "Delete symmetric-keys",
"description": "Delete operation of resource: symmetric-keys",
"operationId": "deletekeystoresymmetric-keys",
"produces": [
"application/json"
],
"consumes": [
"application/json"
],
"x-cliParam": {
"paramKeys": [],
"readfmtstring": "/keystore/symmetric-keys/",
"writefmtstring": "{\\\"keystore\\\": {\\\"symmetric-keys\\\": %s}}",
"writeparams": []
},
"tags": [
"keystore"
],
"responses": {
"200": {
"description": "Successful operation"
},
"400": {
"description": "Internal Error"
}
}
}
},
"/keystore/symmetric-keys/symmetric-key/": {
"post": {
"summary": "Create symmetric-key",
"description": "Create operation of resource: symmetric-key",
"operationId": "createkeystoresymmetric-keyssymmetric-key",
"produces": [
"application/json"
],
"consumes": [
"application/json"
],
"x-cliParam": {
"paramKeys": [],
"readfmtstring": "/keystore/symmetric-keys/symmetric-key/",
"writefmtstring": "{\\\"keystore\\\": {\\\"symmetric-keys\\\": {\\\"symmetric-key\\\": %s}}}",
"writeparams": []
},
"tags": [
"keystore"
],
"parameters": [
{
"in": "body",
"name": "body_symmetric-key",
"schema": {
"$ref": "#/definitions/symmetric-key_schema"
},
"description": "symmetric-keybody object"
}
],
"responses": {
"200": {
"description": "Successful operation"
},
"400": {
"description": "Internal Error"
}
}
},
"get": {
"summary": "Read symmetric-key",
"description": "Read operation of resource: symmetric-key",
"operationId": "readkeystoresymmetric-keyssymmetric-key",
"produces": [
"application/json"
],
"consumes": [
"application/json"
],
"x-cliParam": {
"paramKeys": [],
"readfmtstring": "/keystore/symmetric-keys/symmetric-key/",
"writefmtstring": "{\\\"keystore\\\": {\\\"symmetric-keys\\\": {\\\"symmetric-key\\\": %s}}}",
"writeparams": []
},
"tags": [
"keystore"
],
"parameters": [
{
"description": "true queries un-committed configuration",
"in": "query",
"name": "working",
"type": "boolean"
}
],
"responses": {
"200": {
"description": "Successful operation",
"schema": {
"$ref": "#/definitions/symmetric-key_schema"
}
},
"400": {
"description": "Internal Error"
}
}
},
"put": {
"summary": "Update symmetric-key",
"description": "Update operation of resource: symmetric-key",
"operationId": "updatekeystoresymmetric-keyssymmetric-key",
"produces": [
"application/json"
],
"consumes": [
"application/json"
],
"x-cliParam": {
"paramKeys": [],
"readfmtstring": "/keystore/symmetric-keys/symmetric-key/",
"writefmtstring": "{\\\"keystore\\\": {\\\"symmetric-keys\\\": {\\\"symmetric-key\\\": %s}}}",
"writeparams": []
},
"tags": [
"keystore"
],
"parameters": [
{
"in": "body",
"name": "body_symmetric-key",
"schema": {
"$ref": "#/definitions/symmetric-key_schema"
},
"description": "symmetric-keybody object"
}
],
"responses": {
"200": {
"description": "Successful operation"
},
"400": {
"description": "Internal Error"
}
}
},
"delete": {
"summary": "Delete symmetric-key",
"description": "Delete operation of resource: symmetric-key",
"operationId": "deletekeystoresymmetric-keyssymmetric-key",
"produces": [
"application/json"
],
"consumes": [
"application/json"
],
"x-cliParam": {
"paramKeys": [],
"readfmtstring": "/keystore/symmetric-keys/symmetric-key/",
"writefmtstring": "{\\\"keystore\\\": {\\\"symmetric-keys\\\": {\\\"symmetric-key\\\": %s}}}",
"writeparams": []
},
"tags": [
"keystore"
],
"responses": {
"200": {
"description": "Successful operation"
},
"400": {
"description": "Internal Error"
}
}
}
},
"/keystore/symmetric-keys/symmetric-key/{name}/": {
"post": {
"summary": "Create symmetric-key by ID",
"description": "Create operation of resource: symmetric-key",
"operationId": "createkeystoresymmetric-keyssymmetric-keyByID",
"produces": [
"application/json"
],
"consumes": [
"application/json"
],
"x-cliParam": {
"paramKeys": [
{
"key": "name"
}
],
"readfmtstring": "/keystore/symmetric-keys/symmetric-key[name=%s]/",
"writefmtstring": "{\\\"keystore\\\": {\\\"symmetric-keys\\\": {\\\"symmetric-key\\\": [%s]}}}",
"writeparams": []
},
"tags": [
"keystore"
],
"parameters": [
{
"in": "path",
"name": "name",
"description": "ID of name",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body_symmetric-key",
"schema": {
"$ref": "#/definitions/symmetric-key_listschema"
},
"description": "symmetric-keybody object"
}
],
"responses": {
"200": {
"description": "Successful operation"
},
"400": {
"description": "Internal Error"
}
}
},
"get": {
"summary": "Read symmetric-key by ID",
"description": "Read operation of resource: symmetric-key",
"operationId": "readkeystoresymmetric-keyssymmetric-keyByID",
"produces": [
"application/json"
],
"consumes": [
"application/json"
],
"x-cliParam": {
"paramKeys": [
{
"key": "name"
}
],
"readfmtstring": "/keystore/symmetric-keys/symmetric-key[name=%s]/",
"writefmtstring": "{\\\"keystore\\\": {\\\"symmetric-keys\\\": {\\\"symmetric-key\\\": [%s]}}}",
"writeparams": []
},
"tags": [
"keystore"
],
"parameters": [
{
"in": "path",
"name": "name",
"description": "ID of name",
"required": true,
"type": "string"
},
{
"description": "true queries un-committed configuration",
"in": "query",
"name": "working",
"type": "boolean"
}
],
"responses": {
"200": {
"description": "Successful operation",
"schema": {
"$ref": "#/definitions/symmetric-key_listschema"
}
},
"400": {
"description": "Internal Error"
}
}
},
"put": {
"summary": "Update symmetric-key by ID",
"description": "Update operation of resource: symmetric-key",
"operationId": "updatekeystoresymmetric-keyssymmetric-keyByID",
"produces": [
"application/json"
],
"consumes": [
"application/json"
],
"x-cliParam": {
"paramKeys": [
{
"key": "name"
}
],
"readfmtstring": "/keystore/symmetric-keys/symmetric-key[name=%s]/",
"writefmtstring": "{\\\"keystore\\\": {\\\"symmetric-keys\\\": {\\\"symmetric-key\\\": [%s]}}}",
"writeparams": []
},
"tags": [
"keystore"
],
"parameters": [
{
"in": "path",
"name": "name",
"description": "ID of name",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body_symmetric-key",
"schema": {
"$ref": "#/definitions/symmetric-key_listschema"
},
"description": "symmetric-keybody object"
}
],
"responses": {
"200": {
"description": "Successful operation"
},
"400": {
"description": "Internal Error"
}
}
},
"delete": {
"summary": "Delete symmetric-key by ID",
"description": "Delete operation of resource: symmetric-key",
"operationId": "deletekeystoresymmetric-keyssymmetric-keyByID",
"produces": [
"application/json"
],
"consumes": [
"application/json"
],
"x-cliParam": {
"paramKeys": [
{
"key": "name"
}
],
"readfmtstring": "/keystore/symmetric-keys/symmetric-key[name=%s]/",
"writefmtstring": "{\\\"keystore\\\": {\\\"symmetric-keys\\\": {\\\"symmetric-key\\\": [%s]}}}",
"writeparams": []
},
"tags": [
"keystore"
],
"parameters": [
{
"in": "path",
"name": "name",
"description": "ID of name",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Successful operation"
},
"400": {
"description": "Internal Error"
}
}
}
}
},
"definitions": {
"key-reference-type-grouping": {
"description": "A reusable grouping for a choice for the type of key\nreferenced in the keystore.",
"properties": {
"@symmetric-key-ref": {
"description": "Meta data",
"properties": {
"protect": {
"type": "boolean",
"description": "True to protect and false to unprotect the hierarchy"
},
"inactive": {
"type": "boolean",
"description": "True to deactivate and false to activate the hierarchy"
},
"comment": {
"type": "string",
"description": "Comment"
}
}
},
"symmetric-key-ref": {
"type": "string",
"x-path": "/ks:keystore/ks:symmetric-keys/ks:symmetric-key/ks:name",
"description": "Identifies a symmetric key used to encrypt this key."
},
"@asymmetric-key-ref": {
"description": "Meta data",
"properties": {
"protect": {
"type": "boolean",
"description": "True to protect and false to unprotect the hierarchy"
},
"inactive": {
"type": "boolean",
"description": "True to deactivate and false to activate the hierarchy"
},
"comment": {
"type": "string",
"description": "Comment"
}
}
},
"asymmetric-key-ref": {
"type": "string",
"x-path": "/ks:keystore/ks:asymmetric-keys/ks:asymmetric-key/ks:name",
"description": "Identifies an asymmetric key used to encrypt this key."
}
}
},
"encrypted-value-grouping": {
"description": "A reusable grouping for a value that has been encrypted by\na symmetric or asymmetric key in the keystore.",
"allOf": [
{
"properties": {
"@value": {
"description": "Meta data",
"properties": {
"protect": {
"type": "boolean",
"description": "True to protect and false to unprotect the hierarchy"
},
"inactive": {
"type": "boolean",
"description": "True to deactivate and false to activate the hierarchy"
},
"comment": {
"type": "string",
"description": "Comment"
}
}
},
"value": {
"type": "string",
"description": "The private key, encrypted using the specified symmetric\nor asymmetric key."
}
}
},
{
"$ref": "#/definitions/key-reference-type-grouping"
}
],
"x-nullable": true
},
"symmetric-key-grouping": {
"$ref": "#/definitions/symmetric-key-grouping"
},
"asymmetric-key-pair-grouping": {
"$ref": "#/definitions/asymmetric-key-pair-grouping"
},
"asymmetric-key-pair-with-cert-grouping": {
"$ref": "#/definitions/asymmetric-key-pair-with-cert-grouping"
},
"asymmetric-key-pair-with-certs-grouping": {
"$ref": "#/definitions/asymmetric-key-pair-with-certs-grouping"
},
"asymmetric-key-certificate-ref-grouping": {
"description": "This grouping defines a reference to a specific certificate\nassociated with an asymmetric key stored in the keystore.",
"properties": {
"@asymmetric-key": {
"description": "Meta data",
"properties": {
"protect": {
"type": "boolean",
"description": "True to protect and false to unprotect the hierarchy"
},
"inactive": {
"type": "boolean",
"description": "True to deactivate and false to activate the hierarchy"
},
"comment": {
"type": "string",
"description": "Comment"
}
}
},
"asymmetric-key": {
"type": "string",
"description": "A reference to an asymmetric key in the keystore."
},
"@certificate": {
"description": "Meta data",
"properties": {
"protect": {
"type": "boolean",
"description": "True to protect and false to unprotect the hierarchy"
},
"inactive": {
"type": "boolean",
"description": "True to deactivate and false to activate the hierarchy"
},
"comment": {
"type": "string",
"description": "Comment"
}
}
},
"certificate": {
"type": "string",
"x-path": "/ks:keystore/ks:asymmetric-keys/ks:asymmetric-key[ks:name = current()/../asymmetric-key]/ks:certificates/ks:certificate/ks:name",
"description": "A reference to a specific certificate of the\nasymmetric key in the keystore."
}
}
},
"local-or-keystore-symmetric-key-grouping": {
"description": "A grouping that expands to allow the symmetric key to be\neither stored locally, within the using data model, or be\na reference to an symmetric key stored in the keystore.",
"properties": {
"local-definition": {
"description": "Container to hold the local key definition.",
"$ref": "#/definitions/symmetric-key-grouping"
},
"@keystore-reference": {
"description": "Meta data",
"properties": {
"protect": {
"type": "boolean",
"description": "True to protect and false to unprotect the hierarchy"
},
"inactive": {
"type": "boolean",
"description": "True to deactivate and false to activate the hierarchy"
},
"comment": {
"type": "string",
"description": "Comment"
}
}
},
"keystore-reference": {
"type": "string",
"description": "A reference to an symmetric key that exists in\nthe keystore."
}
}
},
"local-or-keystore-asymmetric-key-grouping": {
"description": "A grouping that expands to allow the asymmetric key to be\neither stored locally, within the using data model, or be\na reference to an asymmetric key stored in the keystore.",
"properties": {
"local-definition": {
"description": "Container to hold the local key definition.",
"$ref": "#/definitions/asymmetric-key-pair-grouping"
},
"@keystore-reference": {
"description": "Meta data",
"properties": {
"protect": {
"type": "boolean",
"description": "True to protect and false to unprotect the hierarchy"
},
"inactive": {
"type": "boolean",
"description": "True to deactivate and false to activate the hierarchy"
},
"comment": {
"type": "string",
"description": "Comment"
}
}
},
"keystore-reference": {
"type": "string",
"description": "A reference to an asymmetric key that exists in\nthe keystore. The intent is to reference just the\nasymmetric key without any regard for any certificates\nthat may be associated with it."
}
}
},
"local-or-keystore-asymmetric-key-with-certs-grouping": {
"description": "A grouping that expands to allow an asymmetric key and its\nassociated certificates to be either stored locally, within\nthe using data model, or be a reference to an asymmetric key\n(and its associated certificates) stored in the keystore.",
"properties": {
"local-definition": {
"description": "Container to hold the local key definition.",
"$ref": "#/definitions/asymmetric-key-pair-with-certs-grouping"
},
"@keystore-reference": {
"description": "Meta data",
"properties": {
"protect": {
"type": "boolean",
"description": "True to protect and false to unprotect the hierarchy"
},
"inactive": {
"type": "boolean",
"description": "True to deactivate and false to activate the hierarchy"
},
"comment": {
"type": "string",
"description": "Comment"
}
}
},
"keystore-reference": {
"type": "string",
"description": "A reference to an asymmetric-key (and all of its\nassociated certificates) in the keystore."
}
}
},
"local-or-keystore-end-entity-cert-with-key-grouping": {
"description": "A grouping that expands to allow an end-entity certificate\n(and its associated private key) to be either stored locally,\nwithin the using data model, or be a reference to a specific\ncertificate in the keystore.",
"properties": {
"local-definition": {
"description": "Container to hold the local key definition.",
"$ref": "#/definitions/asymmetric-key-pair-with-cert-grouping"
},
"keystore-reference": {
"description": "A reference to a specific certificate (and its\nassociated private key) in the keystore.",
"$ref": "#/definitions/asymmetric-key-certificate-ref-grouping"
}
}
},
"keystore-grouping": {
"description": "Grouping definition enables use in other contexts. If ever\ndone, implementations SHOULD augment new 'case' statements\ninto local-or-keystore 'choice' statements to supply leafrefs\nto the new location.",
"properties": {
"asymmetric-keys": {
"description": "A list of asymmetric keys.",
"properties": {
"asymmetric-key": {
"description": "An asymmetric key.",
"x-nullable": true,
"type": "array",
"x-omitempty": true,
"items": {
"allOf": [
{
"properties": {
"name": {
"type": "string",
"description": "An arbitrary name for the asymmetric key.",
"x-order": 0
}
}
},
{
"$ref": "#/definitions/asymmetric-key-pair-with-certs-grouping"
}
]
},
"x-key": [
"name"
]
},
"@": {
"description": "Meta data",
"properties": {
"protect": {
"type": "boolean",
"description": "True to protect and false to unprotect the hierarchy"
},
"inactive": {
"type": "boolean",
"description": "True to deactivate and false to activate the hierarchy"
},
"comment": {
"type": "string",
"description": "Comment"
}
}
}
}
},
"symmetric-keys": {
"description": "A list of symmetric keys.",
"properties": {
"symmetric-key": {
"description": "A symmetric key.",
"x-nullable": true,
"type": "array",
"x-omitempty": true,
"items": {
"allOf": [
{
"properties": {
"name": {
"type": "string",
"description": "An arbitrary name for the symmetric key.",
"x-order": 0
}
}
},
{
"$ref": "#/definitions/symmetric-key-grouping"
}
]
},
"x-key": [
"name"
]
},
"@": {
"description": "Meta data",
"properties": {
"protect": {
"type": "boolean",
"description": "True to protect and false to unprotect the hierarchy"
},
"inactive": {
"type": "boolean",
"description": "True to deactivate and false to activate the hierarchy"
},
"comment": {
"type": "string",
"description": "Comment"
}
}
}
}
}
}
},
"public-key-grouping": {
"description": "A public key and its associated algorithm.",
"properties": {
"@algorithm": {
"description": "Meta data",
"properties": {
"protect": {
"type": "boolean",
"description": "True to protect and false to unprotect the hierarchy"
},
"inactive": {
"type": "boolean",
"description": "True to deactivate and false to activate the hierarchy"
},
"comment": {
"type": "string",
"description": "Comment"
}
}
},
"algorithm": {
"type": "string",
"description": "Identifies the key's algorithm."
},
"@public-key-format": {
"description": "Meta data",
"properties": {
"protect": {
"type": "boolean",
"description": "True to protect and false to unprotect the hierarchy"
},
"inactive": {
"type": "boolean",
"description": "True to deactivate and false to activate the hierarchy"
},
"comment": {
"type": "string",
"description": "Comment"
}
}
},
"public-key-format": {
"type": "string",
"description": "Identifies the key's format."
},
"@public-key": {
"description": "Meta data",
"properties": {
"protect": {
"type": "boolean",
"description": "True to protect and false to unprotect the hierarchy"
},
"inactive": {
"type": "boolean",
"description": "True to deactivate and false to activate the hierarchy"
},
"comment": {
"type": "string",
"description": "Comment"
}
}
},
"public-key": {
"type": "string",
"description": "The binary value of the public key. The interpretation\nof the value is defined by 'public-key-format' field."
}
}
},
"trust-anchor-cert-grouping": {
"description": "A trust anchor certificate, and a notification for when\nit is about to (or already has) expire.",
"properties": {
"@cert": {
"description": "Meta data",
"properties": {
"protect": {
"type": "boolean",
"description": "True to protect and false to unprotect the hierarchy"
},
"inactive": {
"type": "boolean",
"description": "True to deactivate and false to activate the hierarchy"
},
"comment": {
"type": "string",
"description": "Comment"
}
}
},
"cert": {
"type": "string",
"description": "The binary certificate data for this certificate."
},
"certificate-expiration": {
"description": "A notification indicating that the configured certificate\nis either about to expire or has already expired. When to\nsend notifications is an implementation specific decision,\nbut it is RECOMMENDED that a notification be sent once a\nmonth for 3 months, then once a week for four weeks, and\nthen once a day thereafter until the issue is resolved.",
"properties": {
"@expiration-date": {
"description": "Meta data",
"properties": {
"protect": {
"type": "boolean",
"description": "True to protect and false to unprotect the hierarchy"
},
"inactive": {
"type": "boolean",
"description": "True to deactivate and false to activate the hierarchy"
},
"comment": {
"type": "string",
"description": "Comment"
}
}
},
"expiration-date": {
"type": "string",
"description": "Identifies the expiration date on the certificate."
}
}
}
}
},
"trust-anchor-certs-grouping": {
"description": "A list of trust anchor certificates, and a notification\nfor when one is about to (or already has) expire.",
"properties": {
"cert": {
"type": "array",
"items": {
"type": "string",
"description": "The binary certificate data for this certificate."
},
"x-omitempty": true
},
"certificate-expiration": {
"description": "A notification indicating that the configured certificate\nis either about to expire or has already expired. When to\nsend notifications is an implementation specific decision,\nbut it is RECOMMENDED that a notification be sent once a\nmonth for 3 months, then once a week for four weeks, and\nthen once a day thereafter until the issue is resolved.",
"properties": {
"@expiration-date": {
"description": "Meta data",
"properties": {
"protect": {
"type": "boolean",
"description": "True to protect and false to unprotect the hierarchy"
},
"inactive": {
"type": "boolean",
"description": "True to deactivate and false to activate the hierarchy"
},
"comment": {
"type": "string",
"description": "Comment"
}
}
},
"expiration-date": {
"type": "string",
"description": "Identifies the expiration date on the certificate."
}
}
}
}
},
"end-entity-cert-grouping": {
"description": "An end entity certificate, and a notification for when\nit is about to (or already has) expire. Implementations\nSHOULD assert that, where used, the end entity certificate\ncontains the expected public key.",
"properties": {
"@cert": {
"description": "Meta data",
"properties": {
"protect": {
"type": "boolean",
"description": "True to protect and false to unprotect the hierarchy"
},
"inactive": {
"type": "boolean",
"description": "True to deactivate and false to activate the hierarchy"
},
"comment": {
"type": "string",
"description": "Comment"
}
}
},
"cert": {
"type": "string",
"description": "The binary certificate data for this certificate."
},
"certificate-expiration": {
"description": "A notification indicating that the configured certificate\nis either about to expire or has already expired. When to\nsend notifications is an implementation specific decision,\nbut it is RECOMMENDED that a notification be sent once a\nmonth for 3 months, then once a week for four weeks, and\nthen once a day thereafter until the issue is resolved.",
"properties": {
"@expiration-date": {
"description": "Meta data",
"properties": {
"protect": {
"type": "boolean",
"description": "True to protect and false to unprotect the hierarchy"
},
"inactive": {
"type": "boolean",
"description": "True to deactivate and false to activate the hierarchy"
},
"comment": {
"type": "string",
"description": "Comment"
}
}
},
"expiration-date": {
"type": "string",
"description": "Identifies the expiration date on the certificate."
}
}
}
}
},
"end-entity-certs-grouping": {
"description": "A list of end entity certificates, and a notification for\nwhen one is about to (or already has) expire.",
"properties": {
"cert": {
"type": "array",
"items": {
"type": "string",
"description": "The binary certificate data for this certificate."
},
"x-omitempty": true
},
"certificate-expiration": {
"description": "A notification indicating that the configured certificate\nis either about to expire or has already expired. When to\nsend notifications is an implementation specific decision,\nbut it is RECOMMENDED that a notification be sent once a\nmonth for 3 months, then once a week for four weeks, and\nthen once a day thereafter until the issue is resolved.",
"properties": {
"@expiration-date": {
"description": "Meta data",
"properties": {
"protect": {
"type": "boolean",
"description": "True to protect and false to unprotect the hierarchy"
},
"inactive": {
"type": "boolean",
"description": "True to deactivate and false to activate the hierarchy"
},
"comment": {
"type": "string",
"description": "Comment"
}
}
},
"expiration-date": {
"type": "string",
"description": "Identifies the expiration date on the certificate."
}
}
}
}
},
"asymmetric-keys_schema": {
"description": "A list of asymmetric keys.",
"properties": {
"asymmetric-key": {
"description": "An asymmetric key.",
"x-nullable": true,
"type": "array",
"x-omitempty": true,
"items": {
"allOf": [
{
"properties": {
"name": {
"type": "string",
"description": "An arbitrary name for the asymmetric key.",
"x-order": 0
}
}
},
{
"$ref": "#/definitions/asymmetric-key-pair-with-certs-grouping"
}
]
},
"x-key": [
"name"
]
},
"@": {
"description": "Meta data",
"properties": {
"protect": {
"type": "boolean",
"description": "True to protect and false to unprotect the hierarchy"
},
"inactive": {
"type": "boolean",
"description": "True to deactivate and false to activate the hierarchy"
},
"comment": {
"type": "string",
"description": "Comment"
}
}
}
}
},
"asymmetric-key_schema": {
"description": "An asymmetric key.",
"x-nullable": true,
"type": "array",
"x-omitempty": true,
"items": {
"allOf": [
{
"properties": {
"name": {
"type": "string",
"description": "An arbitrary name for the asymmetric key.",
"x-order": 0
}
}
},
{
"$ref": "#/definitions/asymmetric-key-pair-with-certs-grouping"
}
]
},
"x-key": [
"name"
]
},
"asymmetric-key_listschema": {
"allOf": [
{
"properties": {
"name": {
"type": "string",
"description": "An arbitrary name for the asymmetric key.",
"x-order": 0
}
}
},
{
"$ref": "#/definitions/asymmetric-key-pair-with-certs-grouping"
}
]
},
"certificates_schema": {
"description": "Certificates associated with this asymmetric key.\nMore than one certificate supports, for instance,\na TPM-protected asymmetric key that has both IDevID\nand LDevID certificates associated.",
"properties": {
"certificate": {
"description": "A certificate for this asymmetric key.",
"x-nullable": true,
"type": "array",
"x-omitempty": true,
"items": {
"allOf": [
{
"properties": {
"name": {
"type": "string",
"description": "An arbitrary name for the certificate. If the name\nmatches the name of a certificate that exists\nindependently in <operational> (i.e., an IDevID),\nthen the 'cert' node MUST NOT be configured.",
"x-order": 0
}
}
},
{
"$ref": "#/definitions/end-entity-cert-grouping"
}
]
},
"x-key": [
"name"
]
},
"@": {
"description": "Meta data",
"properties": {
"protect": {
"type": "boolean",
"description": "True to protect and false to unprotect the hierarchy"
},
"inactive": {
"type": "boolean",
"description": "True to deactivate and false to activate the hierarchy"
},
"comment": {
"type": "string",
"description": "Comment"
}
}
}
}
},
"certificate_schema": {
"description": "A certificate for this asymmetric key.",
"x-nullable": true,
"type": "array",
"x-omitempty": true,
"items": {
"allOf": [
{
"properties": {
"name": {
"type": "string",
"description": "An arbitrary name for the certificate. If the name\nmatches the name of a certificate that exists\nindependently in <operational> (i.e., an IDevID),\nthen the 'cert' node MUST NOT be configured.",
"x-order": 0
}
}
},
{
"$ref": "#/definitions/end-entity-cert-grouping"
}
]
},
"x-key": [
"name"
]
},
"certificate_listschema": {
"allOf": [
{
"properties": {
"name": {
"type": "string",
"description": "An arbitrary name for the certificate. If the name\nmatches the name of a certificate that exists\nindependently in <operational> (i.e., an IDevID),\nthen the 'cert' node MUST NOT be configured.",
"x-order": 0
}
}
},
{
"$ref": "#/definitions/end-entity-cert-grouping"
}
]
},
"symmetric-keys_schema": {
"description": "A list of symmetric keys.",
"properties": {
"symmetric-key": {
"description": "A symmetric key.",
"x-nullable": true,
"type": "array",
"x-omitempty": true,
"items": {
"allOf": [
{
"properties": {
"name": {
"type": "string",
"description": "An arbitrary name for the symmetric key.",
"x-order": 0
}
}
},
{
"$ref": "#/definitions/symmetric-key-grouping"
}
]
},
"x-key": [
"name"
]
},
"@": {
"description": "Meta data",
"properties": {
"protect": {
"type": "boolean",
"description": "True to protect and false to unprotect the hierarchy"
},
"inactive": {
"type": "boolean",
"description": "True to deactivate and false to activate the hierarchy"
},
"comment": {
"type": "string",
"description": "Comment"
}
}
}
}
},
"symmetric-key_schema": {
"description": "A symmetric key.",
"x-nullable": true,
"type": "array",
"x-omitempty": true,
"items": {
"allOf": [
{
"properties": {
"name": {
"type": "string",
"description": "An arbitrary name for the symmetric key.",
"x-order": 0
}
}
},
{
"$ref": "#/definitions/symmetric-key-grouping"
}
]
},
"x-key": [
"name"
]
},
"symmetric-key_listschema": {
"allOf": [
{
"properties": {
"name": {
"type": "string",
"description": "An arbitrary name for the symmetric key.",
"x-order": 0
}
}
},
{
"$ref": "#/definitions/symmetric-key-grouping"
}
]
}
}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment