Skip to content

Commit ef60771

Browse files
committed
Add more descriptions to SSL certificate API
1 parent 086a253 commit ef60771

File tree

5 files changed

+56
-2
lines changed

5 files changed

+56
-2
lines changed

output/openapi/elasticsearch-openapi.json

Lines changed: 10 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/schema/schema.json

Lines changed: 17 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

specification/_doc_ids/table.csv

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -672,6 +672,7 @@ security-api-update-key,https://www.elastic.co/guide/en/elasticsearch/reference/
672672
security-api-update-user-data,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-update-user-profile-data.html
673673
security-privileges,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-privileges.html
674674
security-api-update-settings,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-update-settings.html
675+
security-encrypt-internode,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-basic-setup.html#encrypt-internode-communication
675676
service-accounts,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/service-accounts.html
676677
set-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/set-processor.html
677678
shape,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/shape.html

specification/ssl/certificates/GetCertificatesRequest.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,9 @@ import { RequestBase } from '@_types/Base'
4040
* @rest_spec_name ssl.certificates
4141
* @availability stack since=6.2.0 stability=stable
4242
* @availability serverless stability=stable visibility=private
43+
* @cluster_privileges monitor
4344
* @doc_tag security
4445
* @doc_id security-api-ssl
46+
* @ext_doc_id security-encrypt-internode
4547
*/
4648
export interface Request extends RequestBase {}

specification/ssl/certificates/types.ts

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,38 @@
2020
import { DateTime } from '@_types/Time'
2121

2222
export class CertificateInformation {
23+
/**
24+
* If the path refers to a container file (a jks keystore, or a PKCS#12 file), it is the alias of the certificate.
25+
* Otherwise, it is null.
26+
*/
2327
alias: string | null
28+
/**
29+
* The ISO formatted date of the certificate's expiry (not-after) date.
30+
*/
2431
expiry: DateTime
32+
/**
33+
* The format of the file.
34+
* Valid values include `jks`, `PKCS12`, and `PEM`.
35+
*/
2536
format: string
37+
/**
38+
* Indicates whether Elasticsearch has access to the private key for this certificate.
39+
*/
2640
has_private_key: boolean
41+
/**
42+
* The Distinguished Name of the certificate's issuer.
43+
*/
2744
issuer?: string
45+
/**
46+
* The path to the certificate, as configured in the `elasticsearch.yml` file.
47+
*/
2848
path: string
49+
/**
50+
* The hexadecimal representation of the certificate's serial number.
51+
*/
2952
serial_number: string
53+
/**
54+
* The Distinguished Name of the certificate's subject.
55+
*/
3056
subject_dn: string
3157
}

0 commit comments

Comments
 (0)