CIPD L&D show Ignite session 14th May - From lurker to learner
Lurker Demo Application - GitHub Pagesrazum2um.github.io/lurker/lurker_demo_application.pdf ·...
Transcript of Lurker Demo Application - GitHub Pagesrazum2um.github.io/lurker/lurker_demo_application.pdf ·...
user listing
Lurker Demo Application APIReferenceThis is an autogenerated documentation stub. You can edit it in:lurker/LurkerAppRails42.service.md
[title] 1 of 22 Lurker Demo Application API Reference
user listing
GET /api/v1/users
This is an autogenerated documentation stub. You can edit it in: lurker/api/v1/users-GET.md
Response Example[ { "id": 1, "name": "razum2um", "surname": "Marley" }]
Request SchemaadditionalProperties: falselimit
Required: noType: stringExample: "1"
Response SchemaType: arrayItems
Required: noadditionalProperties: falseid
Required: noType: integerExample: 1
nameRequired: noType: stringExample: "razum2um"
surnameRequired: noType: stringExample: "Marley"
[title] 2 of 22 Lurker Demo Application API Reference
[title] 3 of 22 Lurker Demo Application API Reference
user creation
POST /api/v1/users
This is an autogenerated documentation stub. You can edit it in: lurker/api/v1/users-POST.md
Response Example{ "id": 1, "name": "Bob"}
Request SchemaadditionalProperties: falseuser
Required: noadditionalProperties: falsename
Required: noType: stringExample: "Bob"
Response SchemaadditionalProperties: falseid
Required: noType: integerExample: 1
nameRequired: noType: stringExample: "Bob"
user deletion
[title] 4 of 22 user creation
user deletion
DELETE /api/v1/users/:id
This is an autogenerated documentation stub. You can edit it in:lurker/api/v1/users/__id-DELETE.md
Response Example{}
Request SchemaadditionalProperties: falseid
Required: noType: integerExample: 1
Response SchemaadditionalProperties: false
user
[title] 5 of 22 user creation
user
GET /api/v1/users/:id
This is an autogenerated documentation stub. You can edit it in:lurker/api/v1/users/__id-GET.md
Response Example{ "id": 1, "name": "razum2um", "surname": "Marley"}
Request SchemaadditionalProperties: false
Response SchemaadditionalProperties: falseid
Required: noType: integerExample: 1
nameRequired: noType: stringExample: "razum2um"
surnameRequired: noType: stringExample: "Marley"
user updating
[title] 6 of 22 user
user updating
PATCH /api/v1/users/:id
This is an autogenerated documentation stub. You can edit it in:lurker/api/v1/users/__id-PATCH.md
Response Example{ "id": 1, "name": "Bob", "surname": "Marley"}
Request SchemaadditionalProperties: falseid
Required: noType: integerExample: 1
userRequired: noadditionalProperties: falsename
Required: noType: stringExample: "Bob"
Response SchemaadditionalProperties: falseid
Required: noType: integerExample: 1
nameRequired: noType: stringExample: "Bob"
surnameRequired: noType: string
[title] 7 of 22 user
Example: "Marley"
[title] 8 of 22 user
repo listing
GET /api/v1/users/:user_id/repos
This is an autogenerated documentation stub. You can edit it in:lurker/api/v1/users/__user_id/repos-GET.md
Response Example[ { "id": 1, "name": "lurker", "user_id": 1 }]
Request SchemaadditionalProperties: falselimit
Required: noType: integerExample: 1
Response SchemaType: arrayItems
Required: noadditionalProperties: falseid
Required: noType: integerExample: 1
nameRequired: noType: stringExample: "lurker"
user_idRequired: noType: integerExample: 1
[title] 9 of 22 repo listing
[title] 10 of 22 repo listing
repo creation
POST /api/v1/users/:user_id/repos
This is an autogenerated documentation stub. You can edit it in:lurker/api/v1/users/__user_id/repos-POST.md
Response Example{ "id": 1, "name": "new-gem", "user": { "id": 1, "name": "razum2um", "surname": "Unknown" }}
Request SchemaadditionalProperties: falseuser_id
Required: noType: stringExample: 1
repoRequired: noadditionalProperties: falsename
Required: noType: stringExample: "new-gem"
Response SchemaadditionalProperties: falseid
Required: noType: integerExample: 1
nameRequired: noType: string
[title] 11 of 22 repo creation
Example: "new-gem"user
Required: noadditionalProperties: falseid
Required: noType: integerExample: 1
nameRequired: noType: stringExample: "razum2um"
surnameRequired: noType: stringExample: "Unknown"
repo descruction
[title] 12 of 22 repo descruction
repo descruction
DELETE /api/v1/users/:user_id/repos/:id
This is an autogenerated documentation stub. You can edit it in:lurker/api/v1/users/__user_id/repos/__id-DELETE.md
Response Example{}
Request SchemaadditionalProperties: false
Response SchemaadditionalProperties: false
repo
[title] 13 of 22 repo
repo
GET /api/v1/users/:user_id/repos/:id
This is an autogenerated documentation stub. You can edit it in:lurker/api/v1/users/__user_id/repos/__id-GET.md
Response Example{ "id": 1, "name": "lurker", "user_id": 1}
Request SchemaadditionalProperties: false
Response SchemaadditionalProperties: falseid
Required: noType: integerExample: 1
nameRequired: noType: stringExample: "lurker"
user_idRequired: noType: integerExample: 1
repo updating
[title] 14 of 22 repo
repo updating
PATCH /api/v1/users/:user_id/repos/:id
This is an autogenerated documentation stub. You can edit it in:lurker/api/v1/users/__user_id/repos/__id-PATCH.md
Response Example{ "id": 1, "name": "updated-name", "user_id": 1}
Request SchemaadditionalProperties: falseid
Required: noType: stringExample: 1
user_idRequired: noType: stringExample: "razum2um"
repoRequired: noadditionalProperties: falsename
Required: noType: stringExample: "updated-name"
Response SchemaadditionalProperties: falseid
Required: noType: integerExample: 1
nameRequired: noType: string
[title] 15 of 22 repo updating
Example: "updated-name"user_id
Required: noType: integerExample: 1
[title] 16 of 22 repo updating
failed repo updating
PATCH /api/v1/users/:user_id/repos/:id-failed
This is an autogenerated documentation stub. You can edit it in:lurker/api/v1/users/__user_id/repos/__id-failed-PATCH.md
Response Example{ "errors": { "name": [ "can't be blank" ] }}
Request SchemaadditionalProperties: falseid
Required: noType: stringExample: 1
user_idRequired: noType: stringExample: "razum2um"
repoRequired: noadditionalProperties: falsename
Required: noType: stringExample: ""
Response SchemaadditionalProperties: falseerrors
Required: noExample: 1additionalProperties: falsename
[title] 17 of 22 failed repo updating
Required: noType: arrayItems
Required: noType: stringExample: "can't be blank"
[title] 18 of 22 failed repo updating
user updating
PATCH /api/v2/users/:id
This is an autogenerated documentation stub. You can edit it in:lurker/api/v2/users/__id-PATCH.md
Response Example{ "id": 1, "name": "razum2um", "surname": "Unknown"}
Request SchemaadditionalProperties: falseuser
Required: noadditionalProperties: falsename
Required: noType: stringExample: "Bob"
surnameRequired: noType: stringExample: "Marley"
Response SchemaadditionalProperties: falseid
Required: noType: integerExample: 1
nameRequired: noType: stringExample: "razum2um"
surnameRequired: noType: string
[title] 19 of 22 user updating
Example: "Unknown"
[title] 20 of 22 user updating
user updating
PATCH /api/v3/users/:id
This is an autogenerated documentation stub. You can edit it in:lurker/api/v3/users/__id-PATCH.md
Response Example{ "id": 1, "name": "razum2um", "surname": "Unknown"}
Request SchemaadditionalProperties: falseuser
Required: noadditionalProperties: falsename
Required: noType: stringExample: "Bob"
surnameRequired: noType: stringExample: "Marley"
Response SchemaadditionalProperties: falseid
Required: noType: integerExample: 1
nameRequired: noType: stringExample: "razum2um"
surnameRequired: noType: string
[title] 21 of 22 user updating
Example: "Unknown"
[title] 22 of 22 user updating