Initial admin documentation #350
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bogdanromanx
suggested changes
Jan 16, 2019
| Organizations are rooted in the `/v1/orgs` and are used to group and categorize its sub-resources. | ||
| An organization it is validated against the [organization schema](https://bluebrain.github.io/nexus/schemas/organization.json). | ||
| Organizations are rooted in the `/v1/orgs` path and are used to group and categorize sub-resources. | ||
| They are validated against the [organization schema](https://bluebrain.github.io/nexus/schemas/organization.json). |
There was a problem hiding this comment.
Remove because it's no longer accurate.
| @@ -1,34 +1,36 @@ | |||
| # Projects | |||
|
|
|||
| Projects are rooted in the `/v1/projects/{org_label}` and are used to group and categorize its sub-resources. Relevant roles of a projects are: | |||
| Projects belong to an `organization` and are rooted in the corresponding `/v1/projects/{org_label}` path. | |||
| They are validated against the [project schema](https://bluebrain.github.io/nexus/schemas/project.json). | |||
| @@ -1,5 +1,6 @@ | |||
| { | |||
There was a problem hiding this comment.
please sort all fields as per the following example:
{
"@context": [
"https://bluebrain.github.io/nexus/contexts/admin.json",
"https://bluebrain.github.io/nexus/contexts/resource.json"
],
"@type": "ProjectCreated",
"description": "the project description",
"base": "http://localhost:8080/base/",
"vocab": "http://localhost:8080/vocab/",
"apiMappings": [
{
"prefix": "nxv",
"namespace": "https://bluebrain.github.io/nexus/vocabulary/"
},
{
"prefix": "rdf",
"namespace": "http://www.w3.org/1999/02/22-rdf-syntax-ns#"
}
],
"_uuid": "94463ac0-3e9b-4261-80f5-e4253956eee2",
"_label": "theprojectlabel",
"_organizationUuid": "d8cf3015-1bce-4dda-ba80-80cd4b5281e5",
"_organizationLabel": "thelabel",
"_rev": 1,
"_instant": "1970-01-01T00:00:00Z",
"_subject": "http://localhost:8080/v1/realms/myrealm/users/uuid"
}
| @@ -1,9 +1,11 @@ | |||
| { | |||
There was a problem hiding this comment.
please sort all fields as per the following example:
{
"@context": [
"https://bluebrain.github.io/nexus/contexts/admin.json",
"https://bluebrain.github.io/nexus/contexts/resource.json"
],
"@type": "OrganizationCreated",
"description": "the description",
"_uuid": "d8cf3015-1bce-4dda-ba80-80cd4b5281e5",
"_label": "thelabel",
"_rev": 1,
"_instant": "1970-01-01T00:00:00Z",
"_subject": "http://localhost:8080/v1/realms/myrealm/users/uuid"
}
bogdanromanx
approved these changes
Jan 17, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.