Skip to content
Snippets Groups Projects
Commit b6cdde21 authored by Lars Johansson's avatar Lars Johansson
Browse files

Update Javadoc and Swagger documentation

parent 9382dc9b
No related branches found
No related tags found
No related merge requests found
Pipeline #168698 passed
Stage: compile
Stage: test
Stage: package
Stage: image
Stage: release
Stage: deploy
Hide whitespace changes
Inline Side-by-side
src/main/java/org/openepics/names/rest/api/v1/IHistory.java
+ 28
− 14
View file @ b6cdde21
......@@ -98,9 +98,10 @@ public interface IHistory {
/**
* Find history for name (search).
* History consists of lines of uuid.
* The line of uuid is not broken in retrieving history. If combination of parameters is found in name entries, the entire lines of uuid are returned.
* Return paged list of name elements.
* History consists of lines of uuid.
* The line of uuid is not broken in retrieving history.
* If combination of parameters is found in name entries, the entire lines of uuid are returned.
*
* @param name name
* @param systemStructure system structure mnemonic path
......@@ -118,9 +119,11 @@ public interface IHistory {
summary = "Find history for name (search)",
description = """
Find history for name (search).
History consists of lines of uuid.
The line of uuid is not broken in retrieving history. If combination of parameters is found in name entries, the entire lines of uuid are returned.
Return paged array of name elements.
History consists of lines of uuid.
The line of uuid is not broken in retrieving history.
If combination of parameters is found in name entries, the entire lines of uuid are returned.
"""
)
@ApiResponses(value = {
......@@ -166,9 +169,10 @@ public interface IHistory {
/**
* Find history for name by uuid (exact match).
* History consists of line of uuid.
* The line of uuid is not broken in retrieving history. If the uuid is found in a name entry, the entire line of uuid is returned.
* Return paged list of name elements.
* History consists of line of uuid.
* The line of uuid is not broken in retrieving history.
* If the uuid is found in a name entry, the entire line of uuid is returned.
*
* @param uuid uuid
* @param orderBy order by field
......@@ -181,9 +185,11 @@ public interface IHistory {
summary = "Find history for name by uuid (exact match)",
description = """
Find history for name by uuid (exact match).
History consists of line of uuid.
The line of uuid is not broken in retrieving history. If the uuid is found in a name entry, the entire line of uuid is returned.
Return paged array of name elements.
History consists of line of uuid.
The line of uuid is not broken in retrieving history.
If the uuid is found in a name entry, the entire line of uuid is returned.
"""
)
@ApiResponses(value = {
......@@ -226,9 +232,10 @@ public interface IHistory {
/**
* Find history for structure (search).
* History consists of lines of uuid.
* The line of uuid is not broken in retrieving history. If combination of parameters is found in structure entries, the entire lines of uuid are returned.
* Return paged list of structure elements.
* History consists of lines of uuid.
* The line of uuid is not broken in retrieving history.
* If combination of parameters is found in structure entries, the entire lines of uuid are returned.
*
* @param type type of structure
* @param parent parent uuid
......@@ -246,8 +253,11 @@ public interface IHistory {
summary = "Find history for structure (search)",
description = """
Find history for structure (search).
History consists of lines of uuid. The line of uuid is not broken in retrieving history. If combination of parameters is found in structure entries, the entire lines of uuid are returned.
Return paged array of structure elements.
History consists of lines of uuid.
The line of uuid is not broken in retrieving history.
If combination of parameters is found in structure entries, the entire lines of uuid are returned.
"""
)
@ApiResponses(value = {
......@@ -293,9 +303,10 @@ public interface IHistory {
/**
* Find history for structure by uuid (exact match).
* History consists of line of uuid.
* The line of uuid is not broken in retrieving history. If the uuid is found in a structure entry, the entire line of uuid is returned.
* Return paged list of structure elements.
* History consists of line of uuid.
* The line of uuid is not broken in retrieving history.
* If the uuid is found in a structure entry, the entire line of uuid is returned.
*
* @param uuid uuid
* @param type type of structure to search in
......@@ -309,8 +320,11 @@ public interface IHistory {
summary = "Find history for structure by uuid (exact match)",
description = """
Find history for structure by uuid (exact match).
History consists of line of uuid. The line of uuid is not broken in retrieving history. If the uuid is found in a structure entry, the entire line of uuid is returned.
Return paged array of structure elements.
History consists of line of uuid.
The line of uuid is not broken in retrieving history.
If the uuid is found in a structure entry, the entire line of uuid is returned.
"""
)
@ApiResponses(value = {
......
src/main/java/org/openepics/names/rest/api/v1/INames.java
+ 14
− 0
View file @ b6cdde21
......@@ -430,11 +430,25 @@ public interface INames {
@Parameter(in = ParameterIn.QUERY, description = "page starting from 0, offset") @RequestParam(required = false, defaultValue = DEFAULT_PAGE) Integer page,
@Parameter(in = ParameterIn.QUERY, description = "page size, limit") @RequestParam(required = false, defaultValue = DEFAULT_PAGE_SIZE) Integer pageSize);
/**
* Find valid legacy names (search).
* Return paged array of name elements.
* A name is considered legacy name if it is active and has a deleted parent.
*
* @param name name
* @param orderBy order by field
* @param isAsc sort order, ascending or descending
* @param page page starting from 0, offset
* @param pageSize page size, limit
* @return paged list of name elements
*/
@Operation(
summary = "Find valid legacy names (search)",
description = """
Find valid legacy names (search).
Return paged array of name elements.
A name is considered legacy name if it is active and has a deleted parent.
"""
)
@ApiResponses(value = {
......
src/main/java/org/openepics/names/rest/api/v1/IStructures.java
+ 7
− 0
View file @ b6cdde21
......@@ -294,6 +294,7 @@ public interface IStructures {
description = """
Find valid structure by type and uuid (exact match).
Return paged list of structure elements.
Maximum number of elements will be two (PENDING, APPROVED) for given uuid.
"""
)
......@@ -397,6 +398,7 @@ public interface IStructures {
/**
* Find valid structures by mnemonic (search).
* Additional conditions are APPROVED and not deleted.
* Return paged list of structure elements.
*
* @param mnemonic mnemonic
......@@ -411,6 +413,8 @@ public interface IStructures {
description = """
Find valid structures by mnemonic (search).
Return paged array of structure elements.
Additional conditions are APPROVED and not deleted.
"""
)
@ApiResponses(value = {
......@@ -451,6 +455,7 @@ public interface IStructures {
/**
* Find valid structures by mnemonic path (search).
* Additional conditions are APPROVED and not deleted.
* Return paged list of structure elements.
*
* @param mnemonicPath mnemonic path
......@@ -465,6 +470,8 @@ public interface IStructures {
description = """
Find valid structures by mnemonic path (search).
Return paged array of structure elements.
Additional conditions are APPROVED and not deleted.
"""
)
@ApiResponses(value = {
......
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