diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 21977a9..86f4d4d 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -88,6 +88,9 @@ jobs: CODE_SAMPLES_PHP_DIR: ${{ runner.temp }}/php run: node tests/reference-code-samples.cjs + - name: Check reference links + run: node tests/reference-links.cjs + - name: Dry run release env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/api.oas3.yaml b/api.oas3.yaml index 252f970..a2a40f6 100644 --- a/api.oas3.yaml +++ b/api.oas3.yaml @@ -259,6 +259,12 @@ components: RichTextAnimation: $ref: "./schemas/richtextproperties.yaml#/RichTextAnimation" + RichTextBorder: + $ref: "./schemas/richtextproperties.yaml#/RichTextBorder" + + RichTextPadding: + $ref: "./schemas/richtextproperties.yaml#/RichTextPadding" + CaptionFont: $ref: "./schemas/captionproperties.yaml#/CaptionFont" diff --git a/build-docs.sh b/build-docs.sh index d52c0df..a12ea3a 100755 --- a/build-docs.sh +++ b/build-docs.sh @@ -39,6 +39,9 @@ sed -i -e 's/\/edit\/{version}\/assets/\/serve\/{version}\/assets/g' .shins/sour sed -i -e 's/\/edit\/{version}\/sources/\/ingest\/{version}\/sources/g' .shins/source/index.html.md sed -i -e 's/\/edit\/{version}\/upload/\/ingest\/{version}\/upload/g' .shins/source/index.html.md +# Base URLs hold a {version} placeholder, so they are shown as code rather than as links that can't open +sed -i -e 's#\1#`\1`#g' .shins/source/index.html.md + # Build the Shins docs HTML cd .shins rm -f index.html diff --git a/paths/assetsrenderid.yaml b/paths/assetsrenderid.yaml index 3ffa103..b59b1d2 100644 --- a/paths/assetsrenderid.yaml +++ b/paths/assetsrenderid.yaml @@ -8,7 +8,7 @@ $ref: "../schemas/responses/assetrenderresponse.yaml#/AssetRenderResponse" description: | A render may generate more than one file, such as a video, thumbnail and poster image. When the assets are - created the only known id is the render id returned by the original [render request](#render-video), status + created the only known id is the render id returned by the original [render request](#render-asset), status request or webhook. This endpoint lets you look up one or more assets by the render id. **Base URL:** https://api.shotstack.io/serve/{version} diff --git a/paths/render.yaml b/paths/render.yaml index 9470dce..0e533f9 100644 --- a/paths/render.yaml +++ b/paths/render.yaml @@ -18,7 +18,7 @@ **Video Preprocessing:** Video assets undergo automatic preprocessing to ensure compatibility. You can force - preprocessing by setting `"transcode": true` on video assets. See [Preprocessing](#preprocessing) + preprocessing by setting `"transcode": true` on video assets. See [VideoAsset](#tocs_videoasset) for more details. **Base URL:** https://api.shotstack.io/edit/{version} diff --git a/paths/upload.yaml b/paths/upload.yaml index f45b4d5..b802e37 100644 --- a/paths/upload.yaml +++ b/paths/upload.yaml @@ -10,7 +10,7 @@ Request a signed URL to upload a file to. The response returns a signed URL that you use to upload the file to. The signed URL looks similar to: - https://shotstack-ingest-api-stage-sources.s3.ap-southeast-2.amazonaws.com/5ca6hu7s9k/zzytey4v-32km-kq1z-aftr-3kcuqi0brad2/source?AWSAccessKeyId=ASIAWJV7UWDMGTZLHTXP&Expires=1677209777&Signature=PKR4dGDDdOuMTAQmDASzLGmLOeo%3D&x-amz-acl=public-read&x-amz-security-token=IQoJb3JpZ2luX2VjEGMaDmFwLX......56osBGByztm7WZdbmXzO09KR + `https://shotstack-ingest-api-stage-sources.s3.ap-southeast-2.amazonaws.com/5ca6hu7s9k/zzytey4v-32km-kq1z-aftr-3kcuqi0brad2/source?AWSAccessKeyId=ASIAWJV7UWDMGTZLHTXP&Expires=1677209777&Signature=PKR4dGDDdOuMTAQmDASzLGmLOeo%3D&x-amz-acl=public-read&x-amz-security-token=IQoJb3JpZ2luX2VjEGMaDmFwLX......56osBGByztm7WZdbmXzO09KR` In a separate API call, use this signed URL to send a PUT request with the binary file. Using cURL you can use a command like: diff --git a/schemas/destinations/akamaiNetStorageDestination.yaml b/schemas/destinations/akamaiNetStorageDestination.yaml index b7c418c..5a62503 100644 --- a/schemas/destinations/akamaiNetStorageDestination.yaml +++ b/schemas/destinations/akamaiNetStorageDestination.yaml @@ -1,6 +1,6 @@ AkamaiNetStorageDestination: description: >- - Send videos and assets to [Akamai NetStorage](https://techdocs.akamai.com/netstorage-usage/docs). Send files to + Send videos and assets to [Akamai NetStorage](https://techdocs.akamai.com/netstorage/docs). Send files to your NetStorage upload directory with a custom path and filename. Akamai credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/akamai-netstorage), not in the request. properties: diff --git a/schemas/destinations/muxDestination.yaml b/schemas/destinations/muxDestination.yaml index 2bedf29..a2bca12 100644 --- a/schemas/destinations/muxDestination.yaml +++ b/schemas/destinations/muxDestination.yaml @@ -1,6 +1,6 @@ MuxDestination: description: >- - Send videos to the [Mux](https://shotstack.io/docs/guide/serving-assets/destinations/mux/) video hosting + Send videos to the [Mux](https://www.mux.com/docs) video hosting and streaming service. Mux credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/mux), not in the request. properties: diff --git a/schemas/edit.yaml b/schemas/edit.yaml index fff18c6..0e5c29f 100644 --- a/schemas/edit.yaml +++ b/schemas/edit.yaml @@ -29,7 +29,7 @@ description: | **Notice: This option is now deprecated and will be removed. Disk types are handled automatically. Setting a disk type has no effect.** - The disk type to use for storing footage and assets for each render. See [disk types](https://shotstack.io/docs/guide/architecting-an-application/disk-types/) for more details. + The disk type to use for storing footage and assets for each render.