[api] API v2.3.0 Documentation #176
Conversation
abellotti
commented
Nov 16, 2016
abellotti
commented
- Updated Versioning page to talk about v2.3.0 and its features
- /api/automate model queries
- /api/automate_domains queries and related actions
- OPTIONS on /api/:collection for fetching collection metadata
- Service Power operations
- Picture Creation via /api/pictures
- Deleting Service Dialogs
- Bulk Queries
- /api/notifications Support
- /api/blueprints Support and Tagging
- Provider custom attributes
- Entrypoint Details
- /api/arbitration_profiles CRUD
- /api/arbitration_rules CRUD
- /api/arbitration_settings CRUD
- /api/virtual_templates Queries
- Cloud Networks subcollection of Providers
- Service Creation
- /api/orchestration_templates CRUD
- Renamed/Removed Deprecated Attributes
- Approving/Denying service requests
- /api/requests Create/Edit/Approve/Deny
|
@imtayadeway @mfeifer please review content/english when you get a chance. /cc @Fryguy @gtanzillo |
| The following is an example for the *groups* collection: | ||
|
|
||
| ---- | ||
| OPTIONS /api/:collection |
There was a problem hiding this comment.
Should this be OPTIONS /api/groups?
| "users", | ||
| "vms" | ||
| ], | ||
| "data": { |
There was a problem hiding this comment.
Do we have an example of what data is used for?
There was a problem hiding this comment.
I've added a Optional Metadata section in this page
| "EQUAL" : { | ||
| "field" : "User-userid", | ||
| "value" : "admin" | ||
| " |
There was a problem hiding this comment.
I'm unfamiliar with this markup, but is this supposed to be }?
|
Thanks @imtayadeway updated as per your comments and pushed updated PR. |
|
@abellotti content looks good. Great effort! I avoided looking at English as @mfeifer is better qualified to do that 👍 |
|
Thanks @imtayadeway @mfeifer when you get a chance for ye-old English. |
| |======================================================================= | ||
|
|
||
| Select other attributes can also be used as identifying attributes | ||
| as shown in the following table: |
There was a problem hiding this comment.
Do you mean "Some attributes can also be used....."?
| ---- | ||
|
|
||
| Syntax for a filter is as follows: | ||
|
|
||
| ---- | ||
| filter[]="attribute op value" | ||
| filter[]=attribute op value | ||
| ---- | ||
|
|
||
| By default, filters are logically anded together, for a logical or, prefix the attribute with "or" as follows: | ||
|
|
There was a problem hiding this comment.
Might want to italicize, quote, or bold "anded" and "or".
|
Thanks @mfeifer for the review, I've updated and re-pushed the PR. |
|
LGTM |
|
@adahms Hi Andrew, we need this PR merged when you get a chance. Thanks!! /cc @mfeifer @imtayadeway |
- Updated Versioning page to talk about v2.3.0 and its features - /api/automate model queries - /api/automate_domains queries and related actions - OPTIONS on /api/:collection for fetching collection metadata - Service Power operations - Picture Creation via /api/pictures - Deleting Service Dialogs - Bulk Queries - /api/notifications Support - /api/blueprints Support and Tagging - Provider custom attributes - Entrypoint Details - /api/arbitration_profiles CRUD - /api/arbitration_rules CRUD - /api/arbitration_settings CRUD - /api/virtual_templates Queries - Cloud Networks subcollection of Providers - Service Creation - /api/orchestration_templates CRUD - Renamed/Removed Deprecated Attributes - Approving/Denying service requests - /api/requests Create/Edit/Approve/Deny
- JSON syntax fix - Options metadata details
- Incorrect wording in bulk query page - Italicized anded and or in filtering page
|
ping @adahms |
|
Looks good to me; merging! |
