diff --git a/.doc_gen/metadata/cloudfront-functions_metadata.yaml b/.doc_gen/metadata/cloudfront-functions_metadata.yaml new file mode 100644 index 0000000..6946d1c --- /dev/null +++ b/.doc_gen/metadata/cloudfront-functions_metadata.yaml @@ -0,0 +1,188 @@ +cloudfront-functions_add_cache_control_header: + title: Add a cache control header to a &CF; Functions viewer response event + title_abbrev: Add a cache control header + synopsis: add a cache control header to a &CF; Functions viewer response event. + + category: CloudFront Functions examples + languages: + JavaScript: + versions: + - sdk_version: 2 + github: https://github.com/aws-samples/amazon-cloudfront-functions/blob/main/add-cache-control-header + excerpts: + - description: + snippet_files: + - index.js + services: + cloudfront: +cloudfront-functions_add_cors_header: + title: Add a CORS header to a &CF; Functions viewer response event + title_abbrev: Add a CORS header + synopsis: add a CORS header to a &CF; Functions viewer response event. + + category: CloudFront Functions examples + languages: + JavaScript: + versions: + - sdk_version: 2 + github: https://github.com/aws-samples/amazon-cloudfront-functions/blob/main/add-cors-header + excerpts: + - description: + snippet_files: + - index.js + services: + cloudfront: +cloudfront-functions_add_origin_header: + title: Add an origin header to a &CF; Functions viewer request event + title_abbrev: Add an origin header + synopsis: add an origin header to a &CF; Functions viewer request event. + + category: CloudFront Functions examples + languages: + JavaScript: + versions: + - sdk_version: 2 + github: https://github.com/aws-samples/amazon-cloudfront-functions/blob/main/add-origin-header + excerpts: + - description: + snippet_files: + - index.js + services: + cloudfront: +cloudfront-functions_add_security_headers: + title: Add HTTP security headers to a &CF; Functions viewer response event + title_abbrev: Add HTTP security headers + synopsis: add HTTP security headers to a &CF; Functions viewer response event. + + category: CloudFront Functions examples + languages: + JavaScript: + versions: + - sdk_version: 2 + github: https://github.com/aws-samples/amazon-cloudfront-functions/blob/main/add-security-headers + excerpts: + - description: + snippet_files: + - index.js + services: + cloudfront: +cloudfront-functions_add_true_client_ip_header: + title: Add a true client IP header to a &CF; Functions viewer request event + title_abbrev: Add a true client IP header + synopsis: add a true client IP header to a &CF; Functions viewer request event. + + category: CloudFront Functions examples + languages: + JavaScript: + versions: + - sdk_version: 2 + github: https://github.com/aws-samples/amazon-cloudfront-functions/blob/main/add-true-client-ip-header + excerpts: + - description: + snippet_files: + - index.js + services: + cloudfront: +cloudfront-functions_kvs_conditional_read: + title: Rewrite a request URI based on KeyValueStore configuration for a &CF; Functions viewer request event + title_abbrev: Rewrite a request URI + synopsis: rewrite a request URI based on KeyValueStore configuration for a &CF; Functions viewer request event. + + category: CloudFront Functions examples + languages: + JavaScript: + versions: + - sdk_version: 2 + github: https://github.com/aws-samples/amazon-cloudfront-functions/blob/main/kvs-conditional-read + excerpts: + - description: + snippet_files: + - ABUriMappingFunction.js + services: + cloudfront: +cloudfront-functions_kvs_jwt_verify: + title: Validate a simple token in a &CF; Functions viewer request + title_abbrev: Validate a simple token + synopsis: validate a simple token in a &CF; Functions viewer request. + + category: CloudFront Functions examples + languages: + JavaScript: + versions: + - sdk_version: 2 + github: https://github.com/aws-samples/amazon-cloudfront-functions/blob/main/kvs-jwt-verify + excerpts: + - description: + snippet_files: + - verify-jwt.js + services: + cloudfront: +cloudfront-functions_kvs_key_value_pairs: + title: Use key-value pairs in a &CF; Functions viewer request + title_abbrev: Use key-value pairs + synopsis: use key-value pairs in a &CF; Functions viewer request. + + category: CloudFront Functions examples + languages: + JavaScript: + versions: + - sdk_version: 2 + github: https://github.com/aws-samples/amazon-cloudfront-functions/blob/main/kvs-key-value-pairs + excerpts: + - description: + snippet_files: + - kvs-key-value-pairs.js + services: + cloudfront: +cloudfront-functions_normalize_query_string_parameters: + title: Normalize query string parameters in a &CF; Functions viewer request + title_abbrev: Normalize query string parameters + synopsis: normalize query string parameters in a &CF; Functions viewer request. + + category: CloudFront Functions examples + languages: + JavaScript: + versions: + - sdk_version: 2 + github: https://github.com/aws-samples/amazon-cloudfront-functions/blob/main/normalize-query-string-parameters + excerpts: + - description: + snippet_files: + - normalize-query-string.js + services: + cloudfront: +cloudfront-functions_redirect_based_on_country: + title: Redirect to a new URL in a &CF; Functions viewer request event + title_abbrev: Redirect to a new URL + synopsis: redirect to a new URL in a &CF; Functions viewer request event. + + category: CloudFront Functions examples + languages: + JavaScript: + versions: + - sdk_version: 2 + github: https://github.com/aws-samples/amazon-cloudfront-functions/blob/main/redirect-based-on-country + excerpts: + - description: + snippet_files: + - index.js + services: + cloudfront: +cloudfront-functions_url_rewrite_single_page_apps: + title: Add index.html to request URLs without a file name in a &CF; Functions viewer request event + title_abbrev: Add index.html to request URLs + synopsis: add index.html to request URLs without a file name in a &CF; Functions viewer request event. + + category: CloudFront Functions examples + languages: + JavaScript: + versions: + - sdk_version: 2 + github: https://github.com/aws-samples/amazon-cloudfront-functions/blob/main/url-rewrite-single-page-apps + excerpts: + - description: + snippet_files: + - index.js + services: + cloudfront: + diff --git a/.doc_gen/metadata/services.yaml b/.doc_gen/metadata/services.yaml new file mode 100644 index 0000000..ed61972 --- /dev/null +++ b/.doc_gen/metadata/services.yaml @@ -0,0 +1,15 @@ +cloudfront-functions: + bundle: cloudfront + long: "&CFlong; Functions" + short: "&CF; Functions" + sort: CloudFront Functions + expanded: + long: Amazon CloudFront Functions + short: CloudFront Functions + blurb: helps you write lightweight functions in JavaScript for high-scale, latency-sensitive CDN customizations. + guide: + subtitle: Developer Guide + url: AmazonCloudFront/latest/DeveloperGuide/cloudfront-functions.html + tags: + product_categories: { "Networking & Content Delivery" } + version: 1 \ No newline at end of file diff --git a/.github/workflows/validate.yaml b/.github/workflows/validate.yaml new file mode 100644 index 0000000..7e7c381 --- /dev/null +++ b/.github/workflows/validate.yaml @@ -0,0 +1,22 @@ +name: Validate Documentation Metadata + +on: # yamllint disable-line rule:truthy + workflow_dispatch: + push: + branches: [main] + pull_request: + branches: [main] + +jobs: + validate-doc-metadata: + name: Validate Doc Metadata + runs-on: ubuntu-latest + + steps: + - name: checkout repo content + uses: actions/checkout@v4 + - name: validate metadata + uses: awsdocs/aws-doc-sdk-examples-tools@2024-09-13-B + with: + doc_gen_only: "False" + strict_titles: "True" \ No newline at end of file