api descriptions

This commit is contained in:
Michele Artini 2024-02-28 15:02:26 +01:00
parent 07cd4dda85
commit 7c672594c1
1 changed files with 11 additions and 14 deletions

View File

@ -92,10 +92,7 @@ public class CommunityApiController extends AbstractExporterController {
}
}
@GetMapping("/community/{id}"
)
@GetMapping("/community/{id}")
@Operation(summary = "get community profile", description = "get community profile", tags = {
C, R
})
@ -181,7 +178,7 @@ public class CommunityApiController extends AbstractExporterController {
}
@PostMapping("/community/{id}/projects")
@Operation(summary = "associate a project to the community", description = "associate a project to the community", tags = {
@Operation(summary = "associate a project to the community, provide all the fields or the method will overwrite with nulls the fields that are missing", description = "associate a project to the community, provide all the fields or the method will overwrite with nulls the fields that are missing", tags = {
C_PJ, W
})
@ApiResponses(value = {
@ -309,7 +306,7 @@ public class CommunityApiController extends AbstractExporterController {
}
@PostMapping("/community/{id}/datasources")
@Operation(summary = "associate a datasource to the community", description = "associate a datasource to the community", tags = {
@Operation(summary = "associate a datasource to the community, provide all the fields or the method will overwrite with nulls the fields that are missing", description = "associate a datasource to the community, provide all the fields or the method will overwrite with nulls the fields that are missing", tags = {
C_CP, W
})
@ApiResponses(value = {
@ -332,7 +329,7 @@ public class CommunityApiController extends AbstractExporterController {
}
@PostMapping("/community/{id}/datasources/deposit")
@Operation(summary = "associate a datasource to the community", description = "associate a datasource to the community", tags = {
@Operation(summary = "update the deposit and message filelds of a datasource associated to the community", description = "update the deposit and message filelds of a datasource associated to the community", tags = {
C_CP, W
})
@ApiResponses(value = {
@ -374,7 +371,7 @@ public class CommunityApiController extends AbstractExporterController {
}
@PostMapping("/community/{id}/datasourcesList")
@Operation(summary = "associate a list of datasources to the community", description = "associate a list of datasources to the community", tags = {
@Operation(summary = "associate a list of datasources to the community, provide all the fields or the method will overwrite with nulls the fields that are missing", description = "associate a list of datasources to the community, provide all the fields or the method will overwrite with nulls the fields that are missing", tags = {
C_CP, W
})
@ApiResponses(value = {
@ -436,7 +433,7 @@ public class CommunityApiController extends AbstractExporterController {
@Deprecated
@PostMapping("/community/{id}/contentproviders")
@Operation(summary = "associate a datasource to the community", description = "associate a datasource to the community", tags = {
@Operation(summary = "associate a datasource to the community, provide all the fields or the method will overwrite with nulls the fields that are missing", description = "associate a datasource to the community, provide all the fields or the method will overwrite with nulls the fields that are missing", tags = {
C_CP, W
})
@ApiResponses(value = {
@ -467,7 +464,7 @@ public class CommunityApiController extends AbstractExporterController {
@Deprecated
@PostMapping("/community/{id}/contentprovidersList")
@Operation(summary = "associate a list of datasources to the community", description = "associate a list of datasources to the community", tags = {
@Operation(summary = "associate a list of datasources to the community, provide all the fields or the method will overwrite with nulls the fields that are missing", description = "associate a list of datasources to the community, provide all the fields or the method will overwrite with nulls the fields that are missing", tags = {
C_CP, W
})
@ApiResponses(value = {
@ -519,7 +516,7 @@ public class CommunityApiController extends AbstractExporterController {
}
@PostMapping("/community/{id}/organizations")
@Operation(summary = "associate an organization to the community", description = "associate an organization to the community", tags = {
@Operation(summary = "associate an organization to the community, provide all the fields or the method will overwrite with nulls the fields that are missing", description = "associate an organization to the community, provide all the fields or the method will overwrite with nulls the fields that are missing", tags = {
C_O, W
})
@ApiResponses(value = {
@ -541,7 +538,7 @@ public class CommunityApiController extends AbstractExporterController {
}
@PostMapping("/community/{id}/organizationList")
@Operation(summary = "associate a list of organizations to the community", description = "associate a list of organizations to the community", tags = {
@Operation(summary = "associate a list of organizations to the community, provide all the fields or the method will overwrite with nulls the fields that are missing", description = "associate a list of organizations to the community, provide all the fields or the method will overwrite with nulls the fields that are missing", tags = {
C_O, W
})
@ApiResponses(value = {
@ -999,7 +996,7 @@ public class CommunityApiController extends AbstractExporterController {
}
@PostMapping("/community/{id}/subcommunities")
@Operation(summary = "associate a subcommunity to the community", description = "associate a subcommunity to the community", tags = {
@Operation(summary = "associate a subcommunity to the community, provide all the fields or the method will overwrite with nulls the fields that are missing", description = "associate a subcommunity to the community, provide all the fields or the method will overwrite with nulls the fields that are missing", tags = {
C_SUB, W
})
@ApiResponses(value = {
@ -1021,7 +1018,7 @@ public class CommunityApiController extends AbstractExporterController {
}
@PostMapping("/community/{id}/subcommunitiesList")
@Operation(summary = "associate a list of subcommunities to the community", description = "associate a list of subcommunities to the community", tags = {
@Operation(summary = "associate a list of subcommunities to the community, provide all the fields or the method will overwrite with nulls the fields that are missing", description = "associate a list of subcommunities to the community, provide all the fields or the method will overwrite with nulls the fields that are missing", tags = {
C_SUB, W
})
@ApiResponses(value = {