Skip to content

Commit e9e122c

Browse files
committed
Fix casing to "/Api"
1 parent 183cd94 commit e9e122c

6 files changed

Lines changed: 14 additions & 14 deletions

File tree

docs/_config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ baseurl: "" # the subpath of your site, e.g. /blog
2525
target_environment: "production"
2626

2727
sp_web_url: "https://app.signpath.io/Web"
28-
sp_api_url: "https://app.signpath.io/api"
28+
sp_api_url: "https://app.signpath.io/Api"
2929
job_portal_url: "https://signpath.jobs.personio.com"
3030

3131
#url: "" # the base hostname & protocol for your site, e.g. http://example.com

docs/_data/tables/trusted-build-systems.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ appveyor-setup:
3737
~~~ yaml
3838
deploy:
3939
- provider: Webhook
40-
url: https://app.signpath.io/API/v1/$ORGANIZATION_ID/Integrations/AppVeyor?ProjectSlug=$PROJECT_SLUG&SigningPolicySlug=$SIGNING_POLICY_SLUG&ArtifactConfigurationSlug=$ARTIFACT_CONFIGURATION_SLUG
40+
url: https://app.signpath.io/Api/v1/$ORGANIZATION_ID/Integrations/AppVeyor?ProjectSlug=$PROJECT_SLUG&SigningPolicySlug=$SIGNING_POLICY_SLUG&ArtifactConfigurationSlug=$ARTIFACT_CONFIGURATION_SLUG
4141
authorization:
4242
secure: $ENCRYPTED_SIGNPATH_API_TOKEN
4343
~~~

docs/build-system-integration.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ You need to provide these values for every single API request.
5050

5151
### API reference documentation
5252

53-
The full OpenAPI documentation is available at [app.signpath.io/api/swagger][swagger].
53+
The full OpenAPI documentation is available at [app.signpath.io/Api/swagger][swagger].
5454

5555
Read on for detailed information about the APIs for submitting and retrieving signing requests.
5656

@@ -89,7 +89,7 @@ curl -H "Authorization: Bearer $API_TOKEN" \
8989
-F "artifactConfigurationSlug=v2.4" \
9090
-F "artifact=@$PATH_TO_ARTIFACT" \
9191
-F "description=$DESCRIPTION" \
92-
https://app.signpath.io/API/v1/$ORGANIZATION_ID/SigningRequests/SubmitWithArtifact
92+
https://app.signpath.io/Api/v1/$ORGANIZATION_ID/SigningRequests/SubmitWithArtifact
9393
~~~
9494

9595
**Success result:** HTTP status code `201`. A HTTP `Location` response-header field is returned with the URL of the created entity.
@@ -142,7 +142,7 @@ Response:
142142

143143
~~~ bash
144144
curl -H "Authorization: Bearer $API_TOKEN" \
145-
https://app.signpath.io/API/v1/$ORGANIZATION_ID/SigningRequests/$SIGNING_REQUEST_ID
145+
https://app.signpath.io/Api/v1/$ORGANIZATION_ID/SigningRequests/$SIGNING_REQUEST_ID
146146
~~~
147147

148148
**Success result:** HTTP status code `200`. Signing request data in JSON format:
@@ -162,12 +162,12 @@ curl -H "Authorization: Bearer $API_TOKEN" \
162162
"signingPolicyId":"137ada35-fc11-4719-a3a4-269983692197",
163163
"signingPolicySlug":"test-signing",
164164
"signingPolicyName":"test-signing",
165-
"unsignedArtifactLink":"https://app.signpath.io/API/v1/c2099ac1-b4b5-4b30-934e-3933c2d9922d/SigningRequests/a4559e13-9e95-480a-9567-5b8a3252bb27/UnsignedArtifact",
166-
"signedArtifactLink":"https://app.signpath.io1/API/v1/c2099ac1-b4b5-4b30-934e-3933c2d9922d/SigningRequests/a4559e13-9e95-480a-9567-5b8a3252bb27/SignedArtifact",
165+
"unsignedArtifactLink":"https://app.signpath.io/Api/v1/c2099ac1-b4b5-4b30-934e-3933c2d9922d/SigningRequests/a4559e13-9e95-480a-9567-5b8a3252bb27/UnsignedArtifact",
166+
"signedArtifactLink":"https://app.signpath.io1/Api/v1/c2099ac1-b4b5-4b30-934e-3933c2d9922d/SigningRequests/a4559e13-9e95-480a-9567-5b8a3252bb27/SignedArtifact",
167167
"origin": {
168168
"buildData": {
169169
"buildSettingsFile": {
170-
"downloadLink": "https://app.signpath.io/API/v1/c2099ac1-b4b5-4b30-934e-3933c2d9922d/SigningRequests//a4559e13-9e95-480a-9567-5b8a3252bb27/BuildSettingsFile",
170+
"downloadLink": "https://app.signpath.io/Api/v1/c2099ac1-b4b5-4b30-934e-3933c2d9922d/SigningRequests//a4559e13-9e95-480a-9567-5b8a3252bb27/BuildSettingsFile",
171171
"fileName": "AppVeyorSettings.json"
172172
},
173173
"url": "https://ci.appveyor.com/project/TestUser/Test-Project/builds/12345678/job/03rba4p8tlr2t4f7"
@@ -206,7 +206,7 @@ Once the signing request is successfully completed, the status response contains
206206
~~~ bash
207207
curl -H "Authorization: Bearer $API_TOKEN" \
208208
-o $LOCAL_PATH_TO_DOWNLOADED_ARTIFACT \
209-
https://app.signpath.io/API/v1/$ORGANIZATION_ID/SigningRequests/$SIGNING_REQUEST_ID/SignedArtifact
209+
https://app.signpath.io/Api/v1/$ORGANIZATION_ID/SigningRequests/$SIGNING_REQUEST_ID/SignedArtifact
210210
~~~
211211

212212
**Success result:** HTTP status code `200`. Returns the binary content of the signed artifact.
@@ -231,7 +231,7 @@ curl -H "Authorization: Bearer $API_TOKEN" \
231231
-F "originalSigningRequestId=$ORIGINAL_SIGNING_REQUEST_ID" \
232232
-F "signingPolicySlug=release-signing" \
233233
-F "description=$DESCRIPTION" \
234-
https://app.signpath.io/API/v1/$ORGANIZATION_ID/SigningRequests/Resubmit
234+
https://app.signpath.io/Api/v1/$ORGANIZATION_ID/SigningRequests/Resubmit
235235
~~~
236236

237237
**Success result:** HTTP status code `201`. A HTTP `Location` response-header field is returned with the URL of the created entity.
@@ -290,6 +290,6 @@ A handler for this Webhook can use the Web API for further activities, such as p
290290
>
291291
> `Bearer JEAG1OrTXZ/t4URp5URt40DLBlA3WtcJmbwfeosyBkTABr6r`
292292
293-
[swagger]: https://app.signpath.io/api/swagger/index.html
293+
[swagger]: https://app.signpath.io/Api/swagger/index.html
294294
[powershellGalleryImage]: https://img.shields.io/powershellgallery/v/SignPath.svg?style=flat-square&label=PowerShell%20Gallery
295295
[powershellGalleryLink]: https://www.powershellgallery.com/packages/SignPath/

docs/crypto-providers/rest-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ This endpoint creates an artifact with the file name `HashSigningData.json`.
5353
#### Request
5454

5555
~~~ bash
56-
curl -X POST https://app.signpath.io/API/v1/$ORGANIZATION_ID/SigningRequests/SignHash \
56+
curl -X POST https://app.signpath.io/Api/v1/$ORGANIZATION_ID/SigningRequests/SignHash \
5757
-H "Authorization: Bearer $API_TOKEN" \
5858
-H "Content-Type: application/json" \
5959
-H "Accept: application/json" \

docs/powershell/Get-SignedArtifact.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ This cmdlet throws an exception if the signing request does not successfully com
3434
| `-OrganizationId` | `String` | ID of your SignPath organization |
3535
| `-ApiToken` | `String` | API token of an interactive or CI user |
3636
| `-ClientCertificate` | `X509Certificate2`| Client certificate used for a secure Web API request. Not directly supported by SignPath, use for proxies. | | {{ site.data.editions | where: "pipeline_integrity.trusted_build_systems", "Optional" | map: "name" | join: ", " }}
37-
| `-ApiUrl` | `String` | URL to the SignPath REST API | `https://app.signpath.io/api/`
37+
| `-ApiUrl` | `String` | URL to the SignPath REST API | `https://app.signpath.io/Api/`
3838
| `-SigningRequestId` | `String` | ID of the signing request |
3939
| `-OutputArtifactPath` | `String` | Specifies the target path for the downloaded signed artifact | `InputArtifactPath` with an added `.signed` extension
4040
| `-Force` | Switch | Allows the cmdlet to overwrite the file at OutputArtifactPath | `false`

docs/powershell/Submit-SigningRequest.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ Note: Use either slugs _or_ IDs, don't mix.
184184
| `-OrganizationId` | `String` | ID of your SignPath organization
185185
| `-ApiToken` | `String` | API token of an interactive or CI user
186186
| `-ClientCertificate` | `X509Certificate2`| Client certificate used for a secure Web API request. Not directly supported by SignPath, use for proxies. | | {{ site.data.editions | where: "pipeline_integrity.trusted_build_systems", "Optional" | map: "name" | join: ", " }}
187-
| `-ApiUrl` | `String` | URL to the SignPath REST API | `https://app.signpath.io/api/`
187+
| `-ApiUrl` | `String` | URL to the SignPath REST API | `https://app.signpath.io/Api/`
188188
| `-Description` | `String` | Optional description of the signing request
189189
| `-Parameters` | `Hashtable` | Values for [parameters defined in the artifact configuration](/artifact-configuration/syntax#parameters)
190190
| `-ServiceUnavailableTimeoutInSeconds` | `Int32` | Total time in seconds that the cmdlet will wait for a single service call to succeed (across several retries) | 600 seconds

0 commit comments

Comments
 (0)