fix distribution set tag api doc (#1219)
Signed-off-by: Natalia Kislicyn <natalia.kislicyn@bosch.io>
This commit is contained in:
@@ -26,7 +26,7 @@ include::{snippets}/distributionsettag/get-distribution-set-tags/curl-request.ad
|
|||||||
|
|
||||||
==== Request URL
|
==== Request URL
|
||||||
|
|
||||||
A `GET` request is used to access the distribution set tags
|
A `GET` request is used to access the distribution set tags.
|
||||||
|
|
||||||
include::{snippets}/distributionsettag/get-distribution-set-tags/http-request.adoc[]
|
include::{snippets}/distributionsettag/get-distribution-set-tags/http-request.adoc[]
|
||||||
|
|
||||||
@@ -76,7 +76,7 @@ include::{snippets}/distributionsettag/get-distribution-set-tag/curl-request.ado
|
|||||||
|
|
||||||
==== Request URL
|
==== Request URL
|
||||||
|
|
||||||
A `GET` request is used to access the distribution set tag
|
A `GET` request is used to access the distribution set tag.
|
||||||
|
|
||||||
include::{snippets}/distributionsettag/get-distribution-set-tag/http-request.adoc[]
|
include::{snippets}/distributionsettag/get-distribution-set-tag/http-request.adoc[]
|
||||||
|
|
||||||
@@ -153,6 +153,7 @@ include::../errors/415.adoc[]
|
|||||||
include::../errors/429.adoc[]
|
include::../errors/429.adoc[]
|
||||||
|===
|
|===
|
||||||
|
|
||||||
|
|
||||||
== PUT /rest/v1/distributionsettags/{distributionsetTagId}
|
== PUT /rest/v1/distributionsettags/{distributionsetTagId}
|
||||||
|
|
||||||
=== Implementation Notes
|
=== Implementation Notes
|
||||||
@@ -247,7 +248,7 @@ include::../errors/429.adoc[]
|
|||||||
|===
|
|===
|
||||||
|
|
||||||
|
|
||||||
== GET /rest/v1/distributionsettags/{distributionsetTagId}/distributionsets
|
== GET /rest/v1/distributionsettags/{distributionsetTagId}/assigned
|
||||||
|
|
||||||
=== Implementation Notes
|
=== Implementation Notes
|
||||||
|
|
||||||
@@ -292,13 +293,14 @@ include::../errors/429.adoc[]
|
|||||||
|===
|
|===
|
||||||
|
|
||||||
|
|
||||||
== POST /rest/v1/distributionsettags/{distributionsetTagId}/distributionsets/toggleTagAssignment
|
== POST /rest/v1/distributionsettags/{distributionsetTagId}/assigned/toggleTagAssignment
|
||||||
|
|
||||||
=== Implementation Notes
|
=== Implementation Notes
|
||||||
|
|
||||||
Handles the POST request of toogle distribution assignment. The request body must always be a list of controller ids.
|
Handles the POST request of toggle distribution assignment.
|
||||||
|
The request body must always be a list of distribution set ids.
|
||||||
|
|
||||||
=== Toogle distribution assignment
|
=== Toggle distribution assignment
|
||||||
|
|
||||||
==== CURL
|
==== CURL
|
||||||
|
|
||||||
@@ -337,7 +339,8 @@ include::../errors/415.adoc[]
|
|||||||
include::../errors/429.adoc[]
|
include::../errors/429.adoc[]
|
||||||
|===
|
|===
|
||||||
|
|
||||||
== POST /rest/v1/distributionsettags/{distributionsetTagId}/distributionsets
|
|
||||||
|
== POST /rest/v1/distributionsettags/{distributionsetTagId}/assigned
|
||||||
|
|
||||||
=== Implementation Notes
|
=== Implementation Notes
|
||||||
|
|
||||||
@@ -382,11 +385,12 @@ include::../errors/415.adoc[]
|
|||||||
include::../errors/429.adoc[]
|
include::../errors/429.adoc[]
|
||||||
|===
|
|===
|
||||||
|
|
||||||
== DELETE /rest/v1/distributionsettags/{distributionsetTagId}/distributionsets/{distributionsetId}
|
|
||||||
|
== DELETE /rest/v1/distributionsettags/{distributionsetTagId}/assigned/{distributionsetId}
|
||||||
|
|
||||||
=== Implementation Notes
|
=== Implementation Notes
|
||||||
|
|
||||||
Handles the DELETE request of unassign the given distribution.
|
Handles the DELETE request of unassign the given distribution.
|
||||||
|
|
||||||
=== Unassign a distribution
|
=== Unassign a distribution
|
||||||
|
|
||||||
@@ -422,6 +426,7 @@ include::../errors/406.adoc[]
|
|||||||
include::../errors/429.adoc[]
|
include::../errors/429.adoc[]
|
||||||
|===
|
|===
|
||||||
|
|
||||||
|
|
||||||
== Additional content
|
== Additional content
|
||||||
|
|
||||||
[[error-body]]
|
[[error-body]]
|
||||||
|
|||||||
@@ -65,6 +65,7 @@ public final class MgmtApiModelProperties {
|
|||||||
public static final String DS_ASSIGNED_TARGETS = "Targets that have this distribution set assigned.";
|
public static final String DS_ASSIGNED_TARGETS = "Targets that have this distribution set assigned.";
|
||||||
public static final String DS_INSTALLED_TARGETS = "Targets that have this distribution set installed.";
|
public static final String DS_INSTALLED_TARGETS = "Targets that have this distribution set installed.";
|
||||||
public static final String DS_LIST = "List of distribution sets.";
|
public static final String DS_LIST = "List of distribution sets.";
|
||||||
|
public static final String DS_TAG_LIST = "List of distribution set tags";
|
||||||
public static final String DS_NEW_ASSIGNED_TARGETS = "Targets that now have this distribution set assigned.";
|
public static final String DS_NEW_ASSIGNED_TARGETS = "Targets that now have this distribution set assigned.";
|
||||||
public static final String DS_ALREADY_ASSIGNED_TARGETS = "Targets that had this distribution set already assigned (in \"offline\" case this includes targets that have arbitrary updates running)";
|
public static final String DS_ALREADY_ASSIGNED_TARGETS = "Targets that had this distribution set already assigned (in \"offline\" case this includes targets that have arbitrary updates running)";
|
||||||
public static final String DS_TOTAL_ASSIGNED_TARGETS = "Overall assigned as part of this request.";
|
public static final String DS_TOTAL_ASSIGNED_TARGETS = "Overall assigned as part of this request.";
|
||||||
@@ -127,6 +128,8 @@ public final class MgmtApiModelProperties {
|
|||||||
|
|
||||||
public static final String TARGET_LIST = "List of provisioning targets.";
|
public static final String TARGET_LIST = "List of provisioning targets.";
|
||||||
|
|
||||||
|
public static final String TARGET_TAG_LIST = "List of target tags";
|
||||||
|
|
||||||
public static final String TARGET_TYPE_LIST = "List of target types";
|
public static final String TARGET_TYPE_LIST = "List of target types";
|
||||||
|
|
||||||
public static final String SM_LIST = "List of software modules.";
|
public static final String SM_LIST = "List of software modules.";
|
||||||
|
|||||||
@@ -76,7 +76,7 @@ public class DistributionSetTagResourceDocumentationTest extends AbstractApiRest
|
|||||||
.andDo(this.document.document(getResponseFieldsTag(true,
|
.andDo(this.document.document(getResponseFieldsTag(true,
|
||||||
fieldWithPath("size").type(JsonFieldType.NUMBER).description(ApiModelPropertiesGeneric.SIZE),
|
fieldWithPath("size").type(JsonFieldType.NUMBER).description(ApiModelPropertiesGeneric.SIZE),
|
||||||
fieldWithPath("total").description(ApiModelPropertiesGeneric.TOTAL_ELEMENTS),
|
fieldWithPath("total").description(ApiModelPropertiesGeneric.TOTAL_ELEMENTS),
|
||||||
fieldWithPath("content").description(MgmtApiModelProperties.TARGET_LIST))));
|
fieldWithPath("content").description(MgmtApiModelProperties.DS_TAG_LIST))));
|
||||||
}
|
}
|
||||||
|
|
||||||
@Test
|
@Test
|
||||||
@@ -173,7 +173,7 @@ public class DistributionSetTagResourceDocumentationTest extends AbstractApiRest
|
|||||||
fieldWithPath("size").type(JsonFieldType.NUMBER)
|
fieldWithPath("size").type(JsonFieldType.NUMBER)
|
||||||
.description(ApiModelPropertiesGeneric.SIZE),
|
.description(ApiModelPropertiesGeneric.SIZE),
|
||||||
fieldWithPath("total").description(ApiModelPropertiesGeneric.TOTAL_ELEMENTS),
|
fieldWithPath("total").description(ApiModelPropertiesGeneric.TOTAL_ELEMENTS),
|
||||||
fieldWithPath("content").description(MgmtApiModelProperties.TARGET_LIST))));
|
fieldWithPath("content").description(MgmtApiModelProperties.DS_TAG_LIST))));
|
||||||
}
|
}
|
||||||
|
|
||||||
@Test
|
@Test
|
||||||
|
|||||||
@@ -77,7 +77,7 @@ public class TargetTagResourceDocumentationTest extends AbstractApiRestDocumenta
|
|||||||
.andDo(this.document.document(getResponseFieldTargetTag(true,
|
.andDo(this.document.document(getResponseFieldTargetTag(true,
|
||||||
fieldWithPath("size").type(JsonFieldType.NUMBER).description(ApiModelPropertiesGeneric.SIZE),
|
fieldWithPath("size").type(JsonFieldType.NUMBER).description(ApiModelPropertiesGeneric.SIZE),
|
||||||
fieldWithPath("total").description(ApiModelPropertiesGeneric.TOTAL_ELEMENTS),
|
fieldWithPath("total").description(ApiModelPropertiesGeneric.TOTAL_ELEMENTS),
|
||||||
fieldWithPath("content").description(MgmtApiModelProperties.TARGET_LIST))));
|
fieldWithPath("content").description(MgmtApiModelProperties.TARGET_TAG_LIST))));
|
||||||
}
|
}
|
||||||
|
|
||||||
@Test
|
@Test
|
||||||
@@ -169,7 +169,7 @@ public class TargetTagResourceDocumentationTest extends AbstractApiRestDocumenta
|
|||||||
fieldWithPath("size").type(JsonFieldType.NUMBER)
|
fieldWithPath("size").type(JsonFieldType.NUMBER)
|
||||||
.description(ApiModelPropertiesGeneric.SIZE),
|
.description(ApiModelPropertiesGeneric.SIZE),
|
||||||
fieldWithPath("total").description(ApiModelPropertiesGeneric.TOTAL_ELEMENTS),
|
fieldWithPath("total").description(ApiModelPropertiesGeneric.TOTAL_ELEMENTS),
|
||||||
fieldWithPath("content").description(MgmtApiModelProperties.TARGET_LIST))));
|
fieldWithPath("content").description(MgmtApiModelProperties.TARGET_TAG_LIST))));
|
||||||
}
|
}
|
||||||
|
|
||||||
@Test
|
@Test
|
||||||
|
|||||||
Reference in New Issue
Block a user