Crypto Server
    Preparing search index...

    Variable OPENAPI_DOCUMENTConst

    OPENAPI_DOCUMENT: {
        openapi: string;
        info: {
            title: string;
            description: string;
            license: { name: string; identifier: string };
        };
        components: {
            securitySchemes: {
                apiKey: {
                    type: "apiKey";
                    name: "x-api-key";
                    in: "header";
                    description: "The static key in CRYPTO_API_KEY. It holds crypto:admin, which grants every scope except crypto:keys:export.";
                };
                bearerAuth: {
                    type: "http";
                    scheme: "bearer";
                    bearerFormat: "JWT";
                    description: "An HS256 JWT signed with JWT_SECRET. Claims: sub (required; not api-key or anonymous), iat and exp (required; lifetime at most JWT_MAX_AGE seconds, default 3600), iss and aud (when JWT_ISSUER and JWT_AUDIENCE are set, as production requires), scopes (array of scope strings). Tried first when the Authorization header carries a Bearer token.";
                };
            };
        };
        security: Requirement[];
    } = ...

    The OpenAPI document's fixed parts; paths come from the routes.

    Type Declaration

    • openapi: string
    • info: {
          title: string;
          description: string;
          license: { name: string; identifier: string };
      }
    • components: {
          securitySchemes: {
              apiKey: {
                  type: "apiKey";
                  name: "x-api-key";
                  in: "header";
                  description: "The static key in CRYPTO_API_KEY. It holds crypto:admin, which grants every scope except crypto:keys:export.";
              };
              bearerAuth: {
                  type: "http";
                  scheme: "bearer";
                  bearerFormat: "JWT";
                  description: "An HS256 JWT signed with JWT_SECRET. Claims: sub (required; not api-key or anonymous), iat and exp (required; lifetime at most JWT_MAX_AGE seconds, default 3600), iss and aud (when JWT_ISSUER and JWT_AUDIENCE are set, as production requires), scopes (array of scope strings). Tried first when the Authorization header carries a Bearer token.";
              };
          };
      }
    • security: Requirement[]