Skip to content

Commit 8d45847

Browse files
nadermannaderman
authored
Merge pull request #29 from packagist/t/projects-rename
Subrepositories: rename object + endpoints from projects
2 parents cf9515f + 86cdcc7 commit 8d45847

14 files changed

+983
-314
lines changed

‎README.md

+94-94
Original file line numberDiff line numberDiff line change
@@ -144,228 +144,228 @@ $composerRepository = $client->customers()->regenerateToken($customerId, $confir
144144
```
145145
Returns the edited Composer repository.
146146

147-
#### Project
147+
#### Subrepository
148148

149-
##### List an organization's projects
149+
##### List an organization's subrepositories
150150
```php
151-
$projects = $client->projects()->all();
151+
$subrepositories = $client->subrepositories()->all();
152152
```
153-
Returns an array of projects.
153+
Returns an array of subrepositories.
154154

155-
##### Show a project
155+
##### Show a subrepository
156156
```php
157-
$projectName = 'project';
158-
$project = $client->projects()->show($projectName);
157+
$subrepositoryName = 'subrepository';
158+
$subrepository = $client->subrepositories()->show($subrepositoryName);
159159
```
160-
Returns a single project.
160+
Returns a single subrepository.
161161

162-
##### Create a project
162+
##### Create a subrepository
163163
```php
164-
$project = $client->projects()->create('New project name');
164+
$subrepository = $client->subrepositories()->create('New subrepository name');
165165
```
166-
Returns the project.
166+
Returns the subrepository.
167167

168-
##### Delete a project
168+
##### Delete a subrepository
169169
```php
170-
$projectName = 'project';
171-
$client->projects()->remove($projectName);
170+
$subrepositoryName = 'subrepository';
171+
$client->subrepositories()->remove($subrepositoryName);
172172
```
173173

174-
##### List a projects's teams
174+
##### List a subrepositories's teams
175175
```php
176-
$projectName = 'project';
177-
$teams = $client->projects()->listTeams($projectName);
176+
$subrepositoryName = 'subrepository';
177+
$teams = $client->subrepositories()->listTeams($subrepositoryName);
178178
```
179-
Returns an array of projects teams.
179+
Returns an array of subrepositories teams.
180180

181-
##### Add a team to a project or edit the permission
181+
##### Add a team to a subrepository or edit the permission
182182
```php
183-
$projectName = 'project';
183+
$subrepositoryName = 'subrepository';
184184
$teams = [
185185
[
186186
'id' => 12,
187187
'permission' => 'owner',
188188
],
189189
];
190-
$teams = $client->projects()->addOrEditTeams($projectName, $teams);
190+
$teams = $client->subrepositories()->addOrEditTeams($subrepositoryName, $teams);
191191
```
192-
Returns an array of added project teams.
192+
Returns an array of added subrepository teams.
193193

194194

195-
##### Remove a team from a project
195+
##### Remove a team from a subrepository
196196
```php
197-
$projectName = 'project';
197+
$subrepositoryName = 'subrepository';
198198
$teamId = 12;
199-
$client->projects()->removeTeam($projectName, $teamId);
199+
$client->subrepositories()->removeTeam($subrepositoryName, $teamId);
200200
```
201201

202-
##### List a projects's packages
202+
##### List a subrepositories's packages
203203
```php
204-
$projectName = 'project';
205-
$packages = $client->projects()->packages()->all($projectName);
204+
$subrepositoryName = 'subrepository';
205+
$packages = $client->subrepositories()->packages()->all($subrepositoryName);
206206
```
207-
Returns an array of projects packages.
207+
Returns an array of subrepositories packages.
208208

209-
##### Show a project package
209+
##### Show a subrepository package
210210
```php
211-
$projectName = 'project';
212-
$package = $client->projects()->packages()->show($projectName, 'acme-website/package');
211+
$subrepositoryName = 'subrepository';
212+
$package = $client->subrepositories()->packages()->show($subrepositoryName, 'acme-website/package');
213213
```
214214
Returns the package.
215215

216-
##### Create a vcs package in a project
216+
##### Create a vcs package in a subrepository
217217
```php
218-
$projectName = 'project';
219-
$job = $client->projects()->packages()->createVcsPackage($projectName, 'https://github.com/acme-website/package');
218+
$subrepositoryName = 'subrepository';
219+
$job = $client->subrepositories()->packages()->createVcsPackage($subrepositoryName, 'https://github.com/acme-website/package');
220220
```
221221
Returns a new job.
222222

223-
##### Create a vcs package with credentials in a project
223+
##### Create a vcs package with credentials in a subrepository
224224
```php
225-
$projectName = 'project';
225+
$subrepositoryName = 'subrepository';
226226
$credentialId = 42;
227-
$job = $client->projects()->packages()->createVcsPackage($projectName,'https://github.com/acme-website/package', $credentialId);
227+
$job = $client->subrepositories()->packages()->createVcsPackage($subrepositoryName,'https://github.com/acme-website/package', $credentialId);
228228
```
229229
Returns a new job.
230230

231-
##### Create a custom package in a project
231+
##### Create a custom package in a subrepository
232232
```php
233-
$projectName = 'project';
234-
$packageDefinition = '{...}'
235-
$job = $client->projects()->packages()->createCustomPackage($projectName, $packageDefinition);
233+
$subrepositoryName = 'subrepository';
234+
$packageDefinition = '{...}';
235+
$job = $client->subrepositories()->packages()->createCustomPackage($subrepositoryName, $packageDefinition);
236236
```
237237
Returns a new job.
238238

239-
##### Create a custom package with credentials in a project
239+
##### Create a custom package with credentials in a subrepository
240240
```php
241-
$projectName = 'project';
242-
$packageDefinition = '{...}'
241+
$subrepositoryName = 'subrepository';
242+
$packageDefinition = '{...}';
243243
$credentialId = 42;
244-
$job = $client->projects()->packages()->createCustomPackage($projectName, $packageDefinition, $credentialId);
244+
$job = $client->subrepositories()->packages()->createCustomPackage($subrepositoryName, $packageDefinition, $credentialId);
245245
```
246246
Returns a new job.
247247

248-
##### Edit a vcs package in a project in a project
248+
##### Edit a vcs package in a subrepository in a subrepository
249249
```php
250-
$projectName = 'project';
251-
$job = $client->projects()->packages()->editVcsPackage($projectName, 'acme-website/package', 'https://github.com/acme-website/package');
250+
$subrepositoryName = 'subrepository';
251+
$job = $client->subrepositories()->packages()->editVcsPackage($subrepositoryName, 'acme-website/package', 'https://github.com/acme-website/package');
252252
```
253253
Returns a new job.
254254

255-
##### Edit a custom package in a project
255+
##### Edit a custom package in a subrepository
256256
```php
257-
$projectName = 'project';
258-
$packageDefinition = '{...}'
259-
$job = $client->projects()->packages()->editCustomPackage($projectName, 'acme-website/package', $packageDefinition);
257+
$subrepositoryName = 'subrepository';
258+
$packageDefinition = '{...}';
259+
$job = $client->subrepositories()->packages()->editCustomPackage($subrepositoryName, 'acme-website/package', $packageDefinition);
260260
```
261261
Returns a new job.
262262

263-
##### Delete a package from a project
263+
##### Delete a package from a subrepository
264264
```php
265-
$projectName = 'project';
266-
$client->projects()->packages()->remove($projectName, 'acme-website/package');
265+
$subrepositoryName = 'subrepository';
266+
$client->subrepositories()->packages()->remove($subrepositoryName, 'acme-website/package');
267267
```
268268

269-
##### List a projects's authentication tokens
269+
##### List a subrepositories's authentication tokens
270270
```php
271-
$projectName = 'project';
272-
$tokens = $client->projects()->listTokens($projectName);
271+
$subrepositoryName = 'subrepository';
272+
$tokens = $client->subrepositories()->listTokens($subrepositoryName);
273273
```
274274
Returns an array of authentication tokens.
275275

276-
##### Create a project authentication token
276+
##### Create a subrepository authentication token
277277
```php
278-
$projectName = 'project';
278+
$subrepositoryName = 'subrepository';
279279
$data = [
280-
'description' => 'Project Token',
280+
'description' => 'Subrepository Token',
281281
'access' => 'read',
282282
];
283-
$token = $client->projects()->createToken($projectName, $data);
283+
$token = $client->subrepositories()->createToken($subrepositoryName, $data);
284284
```
285285
Returns the authentication token.
286286

287-
##### Delete a project authentication token
287+
##### Delete a subrepository authentication token
288288
```php
289-
$projectName = 'project';
289+
$subrepositoryName = 'subrepository';
290290
$tokenId = 33;
291-
$client->projects()->removeToken($projectName, $tokenId);
291+
$client->subrepositories()->removeToken($subrepositoryName, $tokenId);
292292
```
293293

294-
##### Regenerate a project authentication token
294+
##### Regenerate a subrepository authentication token
295295
```php
296-
$projectName = 'project';
296+
$subrepositoryName = 'subrepository';
297297
$tokenId = 33;
298298
$confirmation = [
299299
'IConfirmOldTokenWillStopWorkingImmediately' => true,
300300
];
301-
$token = $client->projects()->regenerateToken($projectName, $confirmation);
301+
$token = $client->subrepositories()->regenerateToken($subrepositoryName, $confirmation);
302302
```
303303
Returns the authentication token.
304304

305-
##### List a projects's mirrored repositories
305+
##### List a subrepositories's mirrored repositories
306306
```php
307-
$projectName = 'project';
308-
$mirroredRepositories = $client->projects()->mirroredRepositories()->all($projectName);
307+
$subrepositoryName = 'subrepository';
308+
$mirroredRepositories = $client->subrepositories()->mirroredRepositories()->all($subrepositoryName);
309309
```
310310
Returns an array of mirrored repositories.
311311

312312
##### Show a mirrored repository
313313
```php
314-
$projectName = 'project';
314+
$subrepositoryName = 'subrepository';
315315
$mirroredRepositoryId = 42;
316-
$mirroredRepository = $client->projects()->mirroredRepositories()->show($projectName, $mirroredRepositoryId);
316+
$mirroredRepository = $client->subrepositories()->mirroredRepositories()->show($subrepositoryName, $mirroredRepositoryId);
317317
```
318318
Returns the mirrored repository.
319319

320-
##### Add mirrored repositories to a project
320+
##### Add mirrored repositories to a subrepository
321321
```php
322-
$projectName = 'project';
322+
$subrepositoryName = 'subrepository';
323323
$mirroredRepositoriesToAdd = [
324324
['id' => 12, 'mirroringBehavior' => 'add_on_use'],
325325
];
326-
$mirroredRepository = $client->projects()->mirroredRepositories()->add($projectName, $mirroredRepositoriesToAdd);
326+
$mirroredRepository = $client->subrepositories()->mirroredRepositories()->add($subrepositoryName, $mirroredRepositoriesToAdd);
327327
```
328328
Returns a list of added mirrored repositories.
329329

330-
##### Edit the mirroring behaviour of mirrored repository in a project
330+
##### Edit the mirroring behaviour of mirrored repository in a subrepository
331331
```php
332-
$projectName = 'project';
332+
$subrepositoryName = 'subrepository';
333333
$mirroredRepositoryId = 42;
334-
$mirroredRepository = $client->projects()->mirroredRepositories()->create($projectName, $mirroredRepositoryId, 'add_on_use');
334+
$mirroredRepository = $client->subrepositories()->mirroredRepositories()->create($subrepositoryName, $mirroredRepositoryId, 'add_on_use');
335335
```
336336
Returns the edited mirrored repository.
337337

338-
##### Delete a mirrored repository from a project
338+
##### Delete a mirrored repository from a subrepository
339339
```php
340-
$projectName = 'project';
340+
$subrepositoryName = 'subrepository';
341341
$mirroredRepositoryId = 42;
342-
$client->projects()->mirroredRepositories()->remove($projectName, $mirroredRepositoryId);
342+
$client->subrepositories()->mirroredRepositories()->remove($subrepositoryName, $mirroredRepositoryId);
343343
```
344344

345-
##### List all mirrored packages from a mirrored repository in a project
345+
##### List all mirrored packages from a mirrored repository in a subrepository
346346
```php
347-
$projectName = 'project';
347+
$subrepositoryName = 'subrepository';
348348
$mirroredRepositoryId = 42;
349-
$packages = $client->projects()->mirroredRepositories()->listPackages($projectName, $mirroredRepositoryId);
349+
$packages = $client->subrepositories()->mirroredRepositories()->listPackages($subrepositoryName, $mirroredRepositoryId);
350350
```
351351
Returns an array of packages.
352352

353-
##### Add mirrored packages from one mirrored repository to a project
353+
##### Add mirrored packages from one mirrored repository to a subrepository
354354
```php
355-
$projectName = 'project';
355+
$subrepositoryName = 'subrepository';
356356
$mirroredRepositoryId = 42;
357357
$packages = [
358358
'acme/cool-lib
359359
];
360-
$jobs = $client->projects()->mirroredRepositories()->addPackages($projectName, $mirroredRepositoryId, $packages);
360+
$jobs = $client->subrepositories()->mirroredRepositories()->addPackages($subrepositoryName, $mirroredRepositoryId, $packages);
361361
```
362362
Returns an array of jobs.
363363

364-
##### Remove all mirrored packages from one mirrored repository in a project
364+
##### Remove all mirrored packages from one mirrored repository in a subrepository
365365
```php
366-
$projectName = 'project';
366+
$subrepositoryName = 'subrepository';
367367
$mirroredRepositoryId = 42;
368-
$client->projects()->mirroredRepositories()->removePackages($projectName, $mirroredRepositoryId);
368+
$client->subrepositories()->mirroredRepositories()->removePackages($subrepositoryName, $mirroredRepositoryId);
369369
```
370370

371371
#### Package
@@ -400,14 +400,14 @@ Returns a new job.
400400

401401
##### Create a custom package
402402
```php
403-
$packageDefinition = '{...}'
403+
$packageDefinition = '{...}';
404404
$job = $client->packages()->createCustomPackage($packageDefinition);
405405
```
406406
Returns a new job.
407407

408408
##### Create a custom package with credentials
409409
```php
410-
$packageDefinition = '{...}'
410+
$packageDefinition = '{...}';
411411
$credentialId = 42;
412412
$job = $client->packages()->createCustomPackage($packageDefinition, $credentialId);
413413
```

0 commit comments

Comments
 (0)