feat: add api docs

.prettierignore

@@ -27,3 +27,4 @@ website/static/katex/katex.min.css
 
 website/changelog/_swizzle_theme_tests
 website/_dogfooding/_swizzle_theme_tests
+content/docs/api/

content/docs/api/pomerium-api.info.mdx

@@ -0,0 +1,59 @@
+---
+id: pomerium-api
+title: "Pomerium API"
+description: "API for managing Pomerium configuration."
+sidebar_label: Introduction
+sidebar_position: 0
+hide_title: true
+custom_edit_url: null
+---
+
+import ApiLogo from "@theme/ApiLogo";
+import Heading from "@theme/Heading";
+import SchemaTabs from "@theme/SchemaTabs";
+import TabItem from "@theme/TabItem";
+import Export from "@theme/ApiExplorer/Export";
+
+<span
+  className={"theme-doc-version-badge badge badge--secondary"}
+  children={"Version: v0.32.5-rc.1"}
+>
+</span>
+
+<Heading
+  as={"h1"}
+  className={"openapi__heading"}
+  children={"Pomerium API"}
+>
+</Heading>
+
+
+
+API for managing Pomerium configuration.
+
+<div
+  style={{"display":"flex","flexDirection":"column","marginBottom":"var(--ifm-paragraph-margin-bottom)"}}
+>
+  <h3
+    style={{"marginBottom":"0.25rem"}}
+  >
+    Contact
+  </h3><span>
+    Pomerium: [support@pomerium.com](mailto:support@pomerium.com)
+  </span><span>
+    URL: [https://github.com/pomerium](https://github.com/pomerium)
+  </span>
+</div><div
+  style={{"marginBottom":"var(--ifm-paragraph-margin-bottom)"}}
+>
+  <h3
+    style={{"marginBottom":"0.25rem"}}
+  >
+    License
+  </h3><a
+    href={"https://github.com/pomerium/pomerium/blob/main/LICENSE"}
+  >
+    Apache License 2.0
+  </a>
+</div>
+

content/docs/api/pomerium-config-config-service-create-key-pair.ParamsDetails.json

@@ -0,0 +1 @@
+{"parameters":[{"name":"Connect-Protocol-Version","in":"header","required":true,"schema":{"type":"number","title":"Connect-Protocol-Version","enum":[1],"description":"Define the version of the Connect protocol","const":1}},{"name":"Connect-Timeout-Ms","in":"header","schema":{"type":"number","title":"Connect-Timeout-Ms","description":"Define the timeout, in ms"}}]}

content/docs/api/pomerium-config-config-service-create-key-pair.RequestSchema.json

@@ -0,0 +1 @@
+{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"keyPair":{"title":"key_pair","description":"The key pair to create.","type":"object","properties":{"id":{"type":["string","null"],"examples":["019e8e96-0959-7dc2-b45f-e32dcafcf95b"],"title":"id","description":"ID of the key pair."},"namespaceId":{"type":["string","null"],"examples":["019e8e96-87b4-78b9-9830-19874b518d60"],"title":"namespace_id","description":"Namespace of the key pair."},"originatorId":{"type":["string","null"],"examples":["your-custom-app"],"title":"originator_id","description":"Originator of the key pair."},"name":{"type":["string","null"],"examples":["TLS Certificate for www.example.com"],"title":"name","description":"The name of the key pair."},"certificate":{"type":["string","null"],"examples":["-----BEGIN CERTIFICATE-----\nEXAMPLE\n-----END CERTIFICATE-----"],"title":"certificate","format":"byte","description":"The key pair certificate raw bytes."},"key":{"type":["string","null"],"examples":["-----BEGIN EC PRIVATE KEY-----\nEXAMPLE\n-----END EC PRIVATE KEY-----"],"title":"key","format":"byte","description":"The key pair private key raw bytes."},"createdAt":{"title":"created_at","description":"When the key pair was created.","readOnly":true,"type":"string","examples":["2023-01-15T01:30:15.01Z","2024-12-25T12:00:00Z"],"format":"date-time"},"modifiedAt":{"title":"modified_at","description":"When the key pair was last modified.","readOnly":true,"type":"string","examples":["2023-01-15T01:30:15.01Z","2024-12-25T12:00:00Z"],"format":"date-time"},"status":{"title":"status","description":"The status of the key pair.","readOnly":true,"type":"string","enum":["KEY_PAIR_STATUS_UNKNOWN","KEY_PAIR_STATUS_READY","KEY_PAIR_STATUS_PENDING"]},"origin":{"title":"origin","description":"The origin of the key pair.","readOnly":true,"type":"string","enum":["KEY_PAIR_ORIGIN_UNKNOWN","KEY_PAIR_ORIGIN_USER","KEY_PAIR_ORIGIN_SYSTEM"]},"certificateInfo":{"type":"array","items":{"type":"object","properties":{"version":{"type":["integer","string"],"title":"version","format":"int64","description":"X.509 certificate format version (3 for modern certificates)."},"serial":{"type":"string","title":"serial","description":"Certificate serial number, formatted as a decimal integer string."},"issuer":{"title":"issuer","description":"Issuer distinguished name (the CA that signed this certificate).","type":"object","properties":{"country":{"type":"array","items":{"type":"string"},"title":"country","description":"Two-letter ISO country codes from the C= relative distinguished name."},"organization":{"type":"array","items":{"type":"string"},"title":"organization","description":"Organization (O=) entries."},"organizationalUnit":{"type":"array","items":{"type":"string"},"title":"organizational_unit","description":"Organizational unit (OU=) entries."},"locality":{"type":"array","items":{"type":"string"},"title":"locality","description":"Locality (L=) entries — typically a city."},"province":{"type":"array","items":{"type":"string"},"title":"province","description":"State or province (ST=) entries."},"streetAddress":{"type":"array","items":{"type":"string"},"title":"street_address","description":"Street address (STREET=) entries."},"postalCode":{"type":"array","items":{"type":"string"},"title":"postal_code","description":"Postal code (postalCode=) entries."},"serialNumber":{"type":"string","title":"serial_number","description":"X.509 serialNumber attribute of the name (not the certificate serial)."},"commonName":{"type":"string","title":"common_name","description":"Common name (CN=)."}},"additionalProperties":false},"subject":{"title":"subject","description":"Subject distinguished name (the identity the certificate vouches for).","type":"object","properties":{"country":{"type":"array","items":{"type":"string"},"title":"country","description":"Two-letter ISO country codes from the C= relative distinguished name."},"organization":{"type":"array","items":{"type":"string"},"title":"organization","description":"Organization (O=) entries."},"organizationalUnit":{"type":"array","items":{"type":"string"},"title":"organizational_unit","description":"Organizational unit (OU=) entries."},"locality":{"type":"array","items":{"type":"string"},"title":"locality","description":"Locality (L=) entries — typically a city."},"province":{"type":"array","items":{"type":"string"},"title":"province","description":"State or province (ST=) entries."},"streetAddress":{"type":"array","items":{"type":"string"},"title":"street_address","description":"Street address (STREET=) entries."},"postalCode":{"type":"array","items":{"type":"string"},"title":"postal_code","description":"Postal code (postalCode=) entries."},"serialNumber":{"type":"string","title":"serial_number","description":"X.509 serialNumber attribute of the name (not the certificate serial)."},"commonName":{"type":"string","title":"common_name","description":"Common name (CN=)."}},"additionalProperties":false},"notBefore":{"title":"not_before","description":"First instant the certificate is valid.","type":"string","examples":["2023-01-15T01:30:15.01Z","2024-12-25T12:00:00Z"],"format":"date-time"},"notAfter":{"title":"not_after","description":"First instant the certificate is no longer valid.","type":"string","examples":["2023-01-15T01:30:15.01Z","2024-12-25T12:00:00Z"],"format":"date-time"},"keyUsage":{"title":"key_usage","description":"Decoded KeyUsage and ExtKeyUsage extensions on the certificate.","type":"object","properties":{"digitalSignature":{"type":"boolean","title":"digital_signature","description":"Certificate authorizes verifying digital signatures."},"contentCommitment":{"type":"boolean","title":"content_commitment","description":"Certificate authorizes non-repudiation of signed data."},"keyEncipherment":{"type":"boolean","title":"key_encipherment","description":"Certificate authorizes key transport (encryption of session keys)."},"dataEncipherment":{"type":"boolean","title":"data_encipherment","description":"Certificate authorizes direct encryption of arbitrary data."},"keyAgreement":{"type":"boolean","title":"key_agreement","description":"Certificate authorizes Diffie-Hellman style key agreement."},"certSign":{"type":"boolean","title":"cert_sign","description":"Certificate authorizes signing other certificates (CA)."},"crlSign":{"type":"boolean","title":"crl_sign","description":"Certificate authorizes signing certificate revocation lists."},"encipherOnly":{"type":"boolean","title":"encipher_only","description":"With key_agreement, restricts use to encipherment only."},"decipherOnly":{"type":"boolean","title":"decipher_only","description":"With key_agreement, restricts use to decipherment only."},"serverAuth":{"type":"boolean","title":"server_auth","description":"Extended usage: server authentication (TLS server certificates)."},"clientAuth":{"type":"boolean","title":"client_auth","description":"Extended usage: client authentication (TLS client certificates)."}},"additionalProperties":false},"dnsNames":{"type":"array","items":{"type":"string"},"title":"dns_names","description":"DNS names in the Subject Alternative Name extension."},"emailAddresses":{"type":"array","items":{"type":"string"},"title":"email_addresses","description":"Email addresses in the Subject Alternative Name extension."},"ipAddresses":{"type":"array","items":{"type":"string"},"title":"ip_addresses","description":"IP addresses in the Subject Alternative Name extension, formatted as\n strings (IPv4 dotted-decimal or IPv6 colon-hex)."},"uris":{"type":"array","items":{"type":"string"},"title":"uris","description":"URIs in the Subject Alternative Name extension."},"permittedDnsDomainsCritical":{"type":"boolean","title":"permitted_dns_domains_critical","description":"When true the permitted/excluded DNS-domain name-constraints are marked\n critical and clients must understand them or reject the certificate."},"permittedDnsDomains":{"type":"array","items":{"type":"string"},"title":"permitted_dns_domains","description":"Name constraints: DNS domains the certificate is permitted to assert."},"excludedDnsDomains":{"type":"array","items":{"type":"string"},"title":"excluded_dns_domains","description":"Name constraints: DNS domains the certificate must not assert."},"permittedIpRanges":{"type":"array","items":{"type":"string"},"title":"permitted_ip_ranges","description":"Name constraints: IP-range CIDRs the certificate is permitted to assert."},"excludedIpRanges":{"type":"array","items":{"type":"string"},"title":"excluded_ip_ranges","description":"Name constraints: IP-range CIDRs the certificate must not assert."},"permittedEmailAddresses":{"type":"array","items":{"type":"string"},"title":"permitted_email_addresses","description":"Name constraints: email addresses (or domains) the certificate is\n permitted to assert."},"excludedEmailAddresses":{"type":"array","items":{"type":"string"},"title":"excluded_email_addresses","description":"Name constraints: email addresses (or domains) the certificate must not\n assert."},"permittedUriDomains":{"type":"array","items":{"type":"string"},"title":"permitted_uri_domains","description":"Name constraints: URI domains the certificate is permitted to assert."},"excludedUriDomains":{"type":"array","items":{"type":"string"},"title":"excluded_uri_domains","description":"Name constraints: URI domains the certificate must not assert."}},"title":"CertificateInfo","additionalProperties":false,"description":"CertificateInfo is a .proto reflection of\n https://golang.org/pkg/crypto/x509/#Certificate"},"title":"certificate_info","description":"Info about any certificates the key pair has.","readOnly":true}},"additionalProperties":false}},"title":"CreateKeyPairRequest","additionalProperties":false}}},"required":true}}