An update will be applied December 9th, between 12PM and 1:00PM EST (UTC -5:00). The site may be slow during that time.

Commit ebef8a5f authored by Ben Boeckel's avatar Ben Boeckel
Browse files

docs: fix some nits

parent 83ad8162
......@@ -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.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment