Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: use 'external identity' terminology to align with c8y docs #227

Merged
merged 1 commit into from
Mar 5, 2023
Merged

docs: use 'external identity' terminology to align with c8y docs #227

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions api/spec/json/identity.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
{
"information": {
"name": "identity",
"description": "Cumulocity identity",
"descriptionLong": "REST endpoint to interact with Cumulocity identity objects",
"description": "Cumulocity external identity",
"descriptionLong": "REST endpoint to interact with Cumulocity external identity objects",
"link": "https://cumulocity.com/guides/reference/identity/"
},
"endpoints": [
{
"name": "getExternalIDCollection",
"method": "GET",
"description": "Get external id collection",
"description": "Get external identity collection",
"descriptionLong": "Get a collection of external ids related to an existing managed object",
"path": "identity/globalIds/{device}/externalIds",
"accept": "application/vnd.com.nsn.cumulocity.externalIdCollection+json",
Expand Down Expand Up @@ -67,7 +67,7 @@
},
{
"name": "getExternalID",
"description": "Get external id",
"description": "Get external identity",
"descriptionLong": "Get an external identity object. An external identify will include the reference to a single device managed object\n",
"method": "GET",
"path": "/identity/externalIds/{type}/{name}",
Expand Down Expand Up @@ -121,7 +121,7 @@
},
{
"name": "deleteExternalID",
"description": "Delete external id",
"description": "Delete external identity",
"descriptionLong": "Delete an existing external id. This does not delete the device managed object",
"method": "DELETE",
"path": "/identity/externalIds/{type}/{name}",
Expand Down Expand Up @@ -188,7 +188,7 @@
"method": "POST",
"path": "identity/globalIds/{device}/externalIds",
"accept": "application/vnd.com.nsn.cumulocity.externalId+json",
"description": "Create external id",
"description": "Create external identity",
"descriptionLong": "Create a new external id for an existing managed object",
"alias": {
"go": "create",
Expand Down
12 changes: 6 additions & 6 deletions api/spec/yaml/identity.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@
---
information:
name: identity
description: Cumulocity identity
descriptionLong: 'REST endpoint to interact with Cumulocity identity objects'
description: Cumulocity external identity
descriptionLong: 'REST endpoint to interact with Cumulocity external identity objects'
link: https://cumulocity.com/guides/reference/identity/

endpoints:
- name: getExternalIDCollection
method: GET
description: Get external id collection
description: Get external identity collection
descriptionLong: Get a collection of external ids related to an existing managed object
path: identity/globalIds/{device}/externalIds
accept: application/vnd.com.nsn.cumulocity.externalIdCollection+json
Expand Down Expand Up @@ -53,7 +53,7 @@ endpoints:


- name: getExternalID
description: Get external id
description: Get external identity
descriptionLong: |
Get an external identity object. An external identify will include the reference to a single device managed object
method: GET
Expand Down Expand Up @@ -93,7 +93,7 @@ endpoints:
- id

- name: deleteExternalID
description: Delete external id
description: Delete external identity
descriptionLong: Delete an existing external id. This does not delete the device managed object
method: DELETE
path: /identity/externalIds/{type}/{name}
Expand Down Expand Up @@ -144,7 +144,7 @@ endpoints:
method: POST
path: identity/globalIds/{device}/externalIds
accept: application/vnd.com.nsn.cumulocity.externalId+json
description: Create external id
description: Create external identity
descriptionLong: Create a new external id for an existing managed object
alias:
go: create
Expand Down
4 changes: 2 additions & 2 deletions pkg/cmd/identity/create/create.auto.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions pkg/cmd/identity/delete/delete.auto.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions pkg/cmd/identity/get/get.auto.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions pkg/cmd/identity/identity.auto.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ func NewSubCommand(f *cmdutil.Factory) *SubCmdIdentity {

cmd := &cobra.Command{
Use: "identity",
Short: "Cumulocity identity",
Long: `REST endpoint to interact with Cumulocity identity objects`,
Short: "Cumulocity external identity",
Long: `REST endpoint to interact with Cumulocity external identity objects`,
}

// Subcommands
Expand Down
4 changes: 2 additions & 2 deletions pkg/cmd/identity/list/list.auto.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion tools/PSc8y/Public/Get-ExternalId.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Function Get-ExternalId {
<#
.SYNOPSIS
Get external id
Get external identity

.DESCRIPTION
Get an external identity object. An external identify will include the reference to a single device managed object
Expand Down
2 changes: 1 addition & 1 deletion tools/PSc8y/Public/Get-ExternalIdCollection.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Function Get-ExternalIdCollection {
<#
.SYNOPSIS
Get external id collection
Get external identity collection

.DESCRIPTION
Get a collection of external ids related to an existing managed object
Expand Down
2 changes: 1 addition & 1 deletion tools/PSc8y/Public/New-ExternalId.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Function New-ExternalId {
<#
.SYNOPSIS
Create external id
Create external identity

.DESCRIPTION
Create a new external id for an existing managed object
Expand Down
2 changes: 1 addition & 1 deletion tools/PSc8y/Public/Remove-ExternalId.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Function Remove-ExternalId {
<#
.SYNOPSIS
Delete external id
Delete external identity

.DESCRIPTION
Delete an existing external id. This does not delete the device managed object
Expand Down