Task/apm 7372 tamara api reference

.github/CODEOWNERS

@@ -0,0 +1,10 @@
+* @adam-young-cko @weronika-castiglione-cko 
+
+/abc_spec/ @cko-web/docs-writers
+/nas_spec/ @cko-web/docs-writers
+
+/abc_spec/components/schemas/Payments/ @cko-web/gateway-product-cko
+/nas_spec/components/schemas/Payments/ @cko-web/gateway-product-cko
+
+/nas_spec/components/schemas/PaymentLinks/ @cko-web/payment-experience-cko
+/nas_spec/components/schemas/HostedPayments/ @cko-web/payment-experience-cko

.github/actions/push-to-another-repository/Dockerfile

@@ -0,0 +1,7 @@
+FROM alpine:latest
+
+RUN apk add --no-cache git git-lfs openssh-client
+
+COPY entrypoint.sh /entrypoint.sh
+
+ENTRYPOINT ["/entrypoint.sh"]

.github/actions/push-to-another-repository/README.md

@@ -0,0 +1,3 @@
+Based on [push-to-another-repository](https://github.com/marketplace/actions/push-directory-to-another-repository) action.
+
+See [documentation](https://cpina.github.io/push-to-another-repository-docs/overview.html)

.github/actions/push-to-another-repository/action.yml

@@ -0,0 +1,69 @@
+name: Push directory to another repository
+description: >-
+  Useful to push files to another repository to be used, for example, via github
+  pages
+inputs:
+  source-before-directory:
+    description: Source before directory from the origin directory
+    required: false
+  source-directory:
+    description: Source directory from the origin directory
+    required: true
+  destination-github-username:
+    description: Name of the destination username/organization
+    required: true
+  destination-repository-name:
+    description: Destination repository
+    required: true
+  user-email:
+    description: Email for the git commit
+    required: true
+  github-server:
+    description: 'Github server'
+    default: 'github.com'
+    required: false
+  user-name:
+    description: >-
+      [Optional] Name for the git commit. Defaults to the destination
+      username/organization name
+    required: false
+    default: ''
+  destination-repository-username:
+    description: '[Optional] Username/organization for the destination repository'
+    required: false
+    default: ''
+  target-branch:
+    description: >-
+      [Optional] set target branch name for the destination repository. Defaults
+      to "main"
+    default: main
+    required: false
+  commit-message:
+    description: >-
+      [Optional] commit message for the output repository. ORIGIN_COMMIT is
+      replaced by the URL@commit in the origin repo
+    default: Update from ORIGIN_COMMIT
+    required: false
+  target-directory:
+    description: '[Optional] The directory to wipe and replace in the target repository'
+    default: ''
+    required: false
+
+runs:
+  using: docker
+  image: Dockerfile
+  args:
+    - '${{ inputs.source-before-directory }}'
+    - '${{ inputs.source-directory }}'
+    - '${{ inputs.destination-github-username }}'
+    - '${{ inputs.destination-repository-name }}'
+    - '${{ inputs.github-server }}'
+    - '${{ inputs.user-email }}'
+    - '${{ inputs.user-name }}'
+    - '${{ inputs.destination-repository-username }}'
+    - '${{ inputs.target-branch }}'
+    - '${{ inputs.commit-message }}'
+    - '${{ inputs.target-directory }}'
+branding:
+  icon: git-commit
+  color: green

.github/actions/push-to-another-repository/entrypoint.sh

@@ -0,0 +1,152 @@
+#!/bin/sh -l
+
+set -e  # if a command fails it stops the execution
+set -u  # script fails if trying to access to an undefined variable
+
+echo "[+] Action start"
+SOURCE_BEFORE_DIRECTORY="${1}"
+SOURCE_DIRECTORY="${2}"
+DESTINATION_GITHUB_USERNAME="${3}"
+DESTINATION_REPOSITORY_NAME="${4}"
+GITHUB_SERVER="${5}"
+USER_EMAIL="${6}"
+USER_NAME="${7}"
+DESTINATION_REPOSITORY_USERNAME="${8}"
+TARGET_BRANCH="${9}"
+COMMIT_MESSAGE="${10}"
+TARGET_DIRECTORY="${11}"
+
+if [ -z "$DESTINATION_REPOSITORY_USERNAME" ]
+then
+	DESTINATION_REPOSITORY_USERNAME="$DESTINATION_GITHUB_USERNAME"
+fi
+
+if [ -z "$USER_NAME" ]
+then
+	USER_NAME="$DESTINATION_GITHUB_USERNAME"
+fi
+
+# Verify that there (potentially) some access to the destination repository
+# and set up git (with GIT_CMD variable) and GIT_CMD_REPOSITORY
+if [ -n "${SSH_DEPLOY_KEY:=}" ]
+then
+	echo "[+] Using SSH_DEPLOY_KEY"
+
+	# Inspired by https://github.com/leigholiver/commit-with-deploy-key/blob/main/entrypoint.sh , thanks!
+	mkdir --parents "$HOME/.ssh"
+	DEPLOY_KEY_FILE="$HOME/.ssh/deploy_key"
+	echo "${SSH_DEPLOY_KEY}" > "$DEPLOY_KEY_FILE"
+	chmod 600 "$DEPLOY_KEY_FILE"
+
+	SSH_KNOWN_HOSTS_FILE="$HOME/.ssh/known_hosts"
+	ssh-keyscan -H "$GITHUB_SERVER" > "$SSH_KNOWN_HOSTS_FILE"
+
+	export GIT_SSH_COMMAND="ssh -i "$DEPLOY_KEY_FILE" -o UserKnownHostsFile=$SSH_KNOWN_HOSTS_FILE"
+
+	GIT_CMD_REPOSITORY="git@$GITHUB_SERVER:$DESTINATION_REPOSITORY_USERNAME/$DESTINATION_REPOSITORY_NAME.git"
+
+elif [ -n "${API_TOKEN_GITHUB:=}" ]
+then
+	echo "[+] Using API_TOKEN_GITHUB"
+	GIT_CMD_REPOSITORY="https://$DESTINATION_REPOSITORY_USERNAME:$API_TOKEN_GITHUB@$GITHUB_SERVER/$DESTINATION_REPOSITORY_USERNAME/$DESTINATION_REPOSITORY_NAME.git"
+else
+	echo "::error::API_TOKEN_GITHUB and SSH_DEPLOY_KEY are empty. Please fill one (recommended the SSH_DEPLOY_KEY)"
+	exit 1
+fi
+
+
+CLONE_DIR=$(mktemp -d)
+
+echo "[+] Git version"
+git --version
+
+echo "[+] Enable git lfs"
+git lfs install
+
+echo "[+] Cloning destination git repository $DESTINATION_REPOSITORY_NAME"
+# Setup git
+git config --global user.email "$USER_EMAIL"
+git config --global user.name "$USER_NAME"
+
+{
+	git clone --single-branch --depth 1 --branch "$TARGET_BRANCH" "$GIT_CMD_REPOSITORY" "$CLONE_DIR"
+} || {
+	echo "::error::Could not clone the destination repository. Command:"
+	echo "::error::git clone --single-branch --branch $TARGET_BRANCH $GIT_CMD_REPOSITORY $CLONE_DIR"
+	echo "::error::(Note that if they exist USER_NAME and API_TOKEN is redacted by GitHub)"
+	echo "::error::Please verify that the target repository exist AND that it contains the destination branch name, and is accesible by the API_TOKEN_GITHUB OR SSH_DEPLOY_KEY"
+	exit 1
+
+}
+ls -la "$CLONE_DIR"
+
+TEMP_DIR=$(mktemp -d)
+# This mv has been the easier way to be able to remove files that were there
+# but not anymore. Otherwise we had to remove the files from "$CLONE_DIR",
+# including "." and with the exception of ".git/"
+mv "$CLONE_DIR/.git" "$TEMP_DIR/.git"
+
+# $TARGET_DIRECTORY is '' by default
+ABSOLUTE_TARGET_DIRECTORY="$CLONE_DIR/$TARGET_DIRECTORY/"
+
+echo "[+] Deleting $ABSOLUTE_TARGET_DIRECTORY"
+rm -rf "$ABSOLUTE_TARGET_DIRECTORY"
+
+echo "[+] Creating (now empty) $ABSOLUTE_TARGET_DIRECTORY"
+mkdir -p "$ABSOLUTE_TARGET_DIRECTORY"
+
+echo "[+] Listing Current Directory Location"
+ls -al
+
+echo "[+] Listing root Location"
+ls -al /
+
+mv "$TEMP_DIR/.git" "$CLONE_DIR/.git"
+
+echo "[+] List contents of $SOURCE_DIRECTORY"
+ls "$SOURCE_DIRECTORY"
+
+echo "[+] Checking if local $SOURCE_DIRECTORY exist"
+if [ ! -d "$SOURCE_DIRECTORY" ]
+then
+	echo "ERROR: $SOURCE_DIRECTORY does not exist"
+	echo "This directory needs to exist when push-to-another-repository is executed"
+	echo
+	echo "In the example it is created by ./build.sh: https://github.com/cpina/push-to-another-repository-example/blob/main/.github/workflows/ci.yml#L19"
+	echo
+	echo "If you want to copy a directory that exist in the source repository"
+	echo "to the target repository: you need to clone the source repository"
+	echo "in a previous step in the same build section. For example using"
+	echo "actions/checkout@v2. See: https://github.com/cpina/push-to-another-repository-example/blob/main/.github/workflows/ci.yml#L16"
+	exit 1
+fi
+
+echo "[+] Copying contents of source repository folder $SOURCE_DIRECTORY to folder $TARGET_DIRECTORY in git repo $DESTINATION_REPOSITORY_NAME"
+cp -ra "$SOURCE_DIRECTORY"/. "$CLONE_DIR/$TARGET_DIRECTORY"
+cd "$CLONE_DIR"
+
+echo "[+] Files that will be pushed"
+ls -la
+
+ORIGIN_COMMIT="https://$GITHUB_SERVER/$GITHUB_REPOSITORY/commit/$GITHUB_SHA"
+COMMIT_MESSAGE="${COMMIT_MESSAGE/ORIGIN_COMMIT/$ORIGIN_COMMIT}"
+COMMIT_MESSAGE="${COMMIT_MESSAGE/\$GITHUB_REF/$GITHUB_REF}"
+
+echo "[+] Set directory is safe ($CLONE_DIR)"
+# Related to https://github.com/cpina/github-action-push-to-another-repository/issues/64 and https://github.com/cpina/github-action-push-to-another-repository/issues/64
+# TODO: review before releasing it as a version
+git config --global --add safe.directory "$CLONE_DIR"
+
+echo "[+] Adding git commit"
+git add .
+
+echo "[+] git status:"
+git status
+
+echo "[+] git diff-index:"
+# git diff-index : to avoid doing the git commit failing if there are no changes to be commit
+git diff-index --quiet HEAD || git commit --message "$COMMIT_MESSAGE"
+
+echo "[+] Pushing git commit"
+# --set-upstream: sets de branch when pushing to a branch that does not exist
+git push "$GIT_CMD_REPOSITORY" --set-upstream "$TARGET_BRANCH"

.github/pull_request_template.md

@@ -0,0 +1,10 @@
+# Description of changes in PR
+
+[//]: # 'Please add your description here'
+
+## Checklist
+
+- [ ] Added a changelog entry to the `changelog.md` file in either `abc_spec` or `nas_spec`
+- [ ] Contacted the Tech Docs team about any corresponding guides that need to be updated for www.checkout.com/docs
+
+**Contributing options**: Look at [our documentation](https://checkout.atlassian.net/wiki/spaces/PD/pages/2169506663/API+ref+publication+process) for options to contribute to the API reference.

.github/workflows/actions.yaml

@@ -0,0 +1,33 @@
+name: Node.js CI
+
+on: [ pull_request ]
+
+env:
+  CI: true
+
+jobs:
+  run-checks:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
+
+      - name: Install node modules
+        run: npm ci --ignore-scripts
+
+      - name: Build ABC & NAS specs
+        run: npm run build:all
+
+      - name: Validate schema
+        run: |
+          npm run test:abc
+          npm run test:nas
+
+      - uses: actions/upload-artifact@master
+        with:
+          name: my-artifact
+          path: web_deploy

.github/workflows/apm-pr.yaml

@@ -0,0 +1,90 @@
+# This is a basic workflow to help you get started with Actions
+
+name: Creates a PR for APM changes in documentation around APM
+
+on:
+  push:
+    branches:      
+      - 'main'  
+
+env:
+  CI: true
+  PAT: ${{ secrets.PAT }}
+
+jobs:
+  upload-spec:
+    runs-on: ubuntu-latest
+    steps: 
+      - name: Extract branch name
+        shell: bash
+        run: echo "##[set-output name=branch;]$(echo ${GITHUB_REF#refs/heads/})"
+        id: extract_branch
+
+      - uses: actions/checkout@v3
+        with:
+          persist-credentials: true
+          repository: your_team/checkout-api-reference
+          ref: ${{ steps.extract_branch.outputs.branch }}                   
+
+      - name: Delete non-Demo files
+        run: |
+          echo ********** Listing contents of spec/ ************
+          ls spec/*/**
+          echo ********** Created an empty folder ************
+          mkdir newspec
+          echo ********** Copying over what we need into the new folder ************
+          mkdir -p newspec/components/schemas
+          cp -r spec/components/**/Demo newspec/components/schemas
+          mkdir -p newspec/paths
+          cp spec/paths/demo*.* newspec/paths          
+          echo ********** Listing contents of newspec/ ************
+          ls spec/*/**   
+          echo ********** Creating copies of spec for ABC and NAS ************
+          cp -r newspec/ nas_spec/
+          cp -r newspec/ abc_spec/
+          echo ********** Ready to upload specs ************
+
+      - uses: actions/upload-artifact@v3
+        with:
+          name: specification
+          path: newspec/
+
+  publish-spec:
+    runs-on: ubuntu-latest
+    needs: upload-spec
+    steps:
+      - uses: actions/download-artifact@v3
+        with:
+          name: specification
+          path: src_spec
+
+      - name: Fetch Checkout Api Reference repository
+        uses: actions/checkout@v3
+        with:
+          repository: checkout/checkout-api-reference
+          ref: master
+          token: ${{ env.PAT }}
+          path: src
+
+      - name: Commit Api specification
+        working-directory: src
+        run: |
+          git config user.email "[email protected]" && git config user.name "$GITHUB_ACTOR"
+          git branch -m "{{team}}/Api-Spec"
+          rsync -a ../src_spec/ abc_spec/
+          rsync -a ../src_spec/ nas_spec/
+          git add .
+          git commit -m 'Publish new API Specification'
+          git push origin HEAD
+
+      - uses: actions/github-script@v4
+        with:
+          github-token: ${{ env.PAT }}
+          script: |
+            await github.pulls.create({
+              owner: 'checkout',
+              repo: 'checkout-api-reference',
+              head: "{{team}}/Api-Spec",
+              base: 'master',
+              title: "{team}: Update API Specification"
+            });