Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
VC
rust-gitlab
Commits
ebef8a5f
Commit
ebef8a5f
authored
Feb 28, 2017
by
Ben Boeckel
Browse files
docs: fix some nits
parent
83ad8162
Changes
1
Hide whitespace changes
Inline
Side-by-side
README.md
View file @
ebef8a5f
...
...
@@ -5,14 +5,14 @@ all API endpoints are implemented, but patches are welcome.
The API is based off of the 8.16.0 API and will likely aggressively track new
API additions, so the newest release may not support talking to older releases
where fields have been added.
.
where fields have been added.
All API types should be implemented in the
[
types
](
src/types.rs
.in
)
module.
These
types should generally be implemented based on the
`lib/api/entities.rb`
All API types should be implemented in the
[
types
](
src/types.rs
)
module.
These
types should generally be implemented based on the
`lib/api/entities.rb`
module in the Gitlab repository. However, in the interest of usability,
entities may be combined using
`Option`
to handle the differences. Generally,
this should be done where the difference is "small". As a concrete example,
the
`Project`
entity has dozens of fields and
`ProjectWithAccess`
has one
this should be done where the difference is "small". As a concrete example,
the
`Project`
entity has dozens of fields and
`ProjectWithAccess`
has one
additional field (
`permissions`
) which is added using
`Option`
rather than
creating a new
`ProjectWithAccess`
structure which only differs in this field.
...
...
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment