Skip to content

Commit

Permalink
Merge pull request bigfix#9 from lentebloem/fc
Browse files Browse the repository at this point in the history
Improve documentation for create-analysis
  • Loading branch information
gnawhleinad committed Jun 4, 2015
2 parents 044ae35 + 5002553 commit 83a215a
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 1 deletion.
29 changes: 28 additions & 1 deletion create-analysis/cURL/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,34 @@
Equivalent Action in Console
---
* Right-click an Analysis and select "Create New Analysis.."

![image](create-analysis-from-panel.png)

* Or, from Menu bar, select "Tool", then choose "Create New Analysis..."

![image](create-analysis-from-menu.png)

Explanation of [`analysis.xml`](./analysis.xml)
---
* Title - (Permissible Values: any string) The title of your custom analysis
* Description - (Permissible Values: any string)The updated description of your custom analysis
* Relevance - (Permissible Values: any relevance expression that evaluates to true or false) A relevance statement that evaluates to true for computers that this Fixlet should run on. All Relevance tags must evaluate to `true` in order for the Fixlet to run.
* Source - (Optional, default to `""`) (Permissible Values: any string)
* SourceReleaseDate - (Optional, default to the date of sourse release) (Permissible Values: a date in `yyyy-mm-dd` format)
* MIMEField - (Optional, default to
```
</MIMEField>
<Name>x-fixlet-modification-time</Name>
<Value>TIME WHEN CREATED</Value>
</MIMEField>
```
* Domain - (Optional)
* Proprety - (Optional) (Permissible Values: an existed property name) Name of the property that is analyzed. (When adding a new property, increase its ID in the new tag, eg.`<Property Name="New Property2" ID="2">local time zone</Property>`)

Usage
---

This command will POST the file `analysis.xml` to the server to create a new analysis called `My Custom Analysis' for a custom site named `Test-Site`.
This command will POST the file [`analysis.xml`](./analysis.xml) to the server to create a new analysis called `My Custom Analysis` for a custom site named `Test-Site`.

curl -X POST --data-binary @analysis.xml --user username:password https://server:port/api/analyses/custom/Test-Site

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 83a215a

Please sign in to comment.