Skip to content
This repository was archived by the owner on Dec 3, 2019. It is now read-only.

Issue #219 Added Scholarship documentations - #231

Merged
hpjaj merged 8 commits into
OperationCode:masterfrom
apex-omontgomery:api_2
Jan 7, 2018
Merged

hpjaj merged 8 commits into
OperationCode:masterfrom
apex-omontgomery:api_2

Conversation

@apex-omontgomery

@apex-omontgomery apex-omontgomery commented Jan 5, 2018 •

Copy link
Copy Markdown
Contributor

Description of changes
Completes request for Issue #219 adds documentation for:
api/v1/scholarships_controller#index
api/v1/scholarships_controller#show
api/v1/scholarship_applications_controller#create

Issue Resolved
Fixes #219

@apex-omontgomery apex-omontgomery changed the title Added Scholarship documentations Issue #218 Added Scholarship documentations Jan 5, 2018
@apex-omontgomery apex-omontgomery changed the title Issue #218 Added Scholarship documentations Issue #219 Added Scholarship documentations Jan 5, 2018
Comment thread apiary.apib Outdated
## Scholarships | Show [/api/v1/code_schools/{scholarship_id}]
+ Parameters

+ scholarship_id (number) - ID of the Scholarship in the form of an integer

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add the "required" to this

Comment thread apiary.apib Outdated
error: 'No such record'
}

## Scholarship Applications | Create [/api/v1/code_schools/{?scholarship_application,reason,terms_accepted,scholarship_id}]

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The URL is /api/v1/scholarship_applications

Comment thread apiary.apib
## Scholarship Applications | Create [/api/v1/code_schools/{?scholarship_application,reason,terms_accepted,scholarship_id}]
+ Parameters

+ scholarship_application (string, required) - Name of the Scholarship in the form of a string

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

user_id is a required param

Comment thread apiary.apib
+ Body

{
"scholarship_application": "Scholarship for kids who want to learn how to program",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

user_id is required

Comment thread apiary.apib Outdated
}
]

## Scholarships | Show [/api/v1/code_schools/{scholarship_id}]

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The URL is /api/v1/scholarships

Comment thread apiary.apib Outdated

+ scholarship_id (number) - ID of the Scholarship in the form of an integer

### Get an Existing CodeSchool [GET]

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Scholarship not CodeSchool

@hpjaj
hpjaj merged commit db1dabc into OperationCode:master Jan 7, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants