8000 Merge pull request #7543 from circleci/DOCTEAM-738_project_slug_defin… · marcoderama/circleci-docs@ab95625 · GitHub
[go: up one dir, main page]

Skip to content

Commit ab95625

Browse files
authored
Merge pull request circleci#7543 from circleci/DOCTEAM-738_project_slug_definition
Ensure consistency in project slug definition
2 parents c7ce724 + 921bd08 commit ab95625

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

jekyll/_cci2/api-developers-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ The following section details the steps you would need, from start to finish, to
153153
### Prerequisites
154154
{: #prerequisites }
155155

156-
* A GitHub or Bitbucket account with a repository to set up with CircleCI.
156+
* A GitHub, Bitbucket, or GitLab account with a repository to set up with CircleCI. **GitLab SaaS users:** Please note the [change in the definition](#gitlab-saas-support-projects) for the project slug references in the examples and use cases on the rest of this document.
157157
* Completion of the CircleCI [onboarding]({{ site.baseurl }}/getting-started).
158158

159159
### Steps

jekyll/_cci2/scheduled-pipelines.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,9 @@ curl --location --request GET "https://circleci.com/api/v2/project/<project-slug
180180
--header "circle-token: <PERSONAL_API_KEY>"
181181
```
182182

183-
`project-slug` takes the form of `vcs-slug/org-name/repo-name`, e.g. `gh/CircleCI-Public/api-preview-docs`.
183+
For GitHub and Bitbucket users: `project-slug` takes the form of `vcs-type/org-name/repo-name`, e.g. `gh/CircleCI-Public/api-preview-docs`.
184+
185+
For GitLab SaaS Support users: `project-slug` takes the form of `circleci/:slug-remainder`. Refer to the [Getting Started section]({{site.baseurl}}/api-developers-guide/#getting-started-with-the-api) of the API Developer's Guide for more information on the project slug format.
184186

185187
**Q:** Why is my scheduled pipeline not running?
186188

0 commit comments

Comments
 (0)
0