Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
N
naming-backend
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Iterations
Wiki
Jira
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
This is an archived project. Repository and other project resources are read-only.
Show more breadcrumbs
ics-software
naming-backend
Commits
b499a5bc
Commit
b499a5bc
authored
3 years ago
by
Lars Johansson
Browse files
Options
Downloads
Patches
Plain Diff
Add default values for page and page size in paged response
parent
c96d41e4
No related branches found
No related tags found
No related merge requests found
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
src/main/java/org/openepics/names/rest/api/v1/INames.java
+13
-10
13 additions, 10 deletions
src/main/java/org/openepics/names/rest/api/v1/INames.java
src/main/java/org/openepics/names/rest/api/v1/IStructures.java
+13
-10
13 additions, 10 deletions
...ain/java/org/openepics/names/rest/api/v1/IStructures.java
with
26 additions
and
20 deletions
src/main/java/org/openepics/names/rest/api/v1/INames.java
+
13
−
10
View file @
b499a5bc
...
...
@@ -106,6 +106,9 @@ public interface INames {
read GET /names/{name} - both name and uuid (name - exact and search, uuid exact)
*/
public
static
final
String
DEFAULT_PAGE
=
"0"
;
public
static
final
String
DEFAULT_PAGE_SIZE
=
"100"
;
/**
* Create names by list of name elements.
* Return list of created name elements.
...
...
@@ -176,8 +179,8 @@ public interface INames {
@Parameter
(
in
=
ParameterIn
.
QUERY
,
description
=
"search values corresponding to search fields"
)
@RequestParam
(
required
=
false
)
String
[]
queryValues
,
@Parameter
(
in
=
ParameterIn
.
QUERY
,
description
=
"order by field"
)
@RequestParam
(
required
=
false
)
FieldName
orderBy
,
@Parameter
(
in
=
ParameterIn
.
QUERY
,
description
=
"sort order, ascending or descending"
)
@RequestParam
(
required
=
false
)
Boolean
isAsc
,
@Parameter
(
in
=
ParameterIn
.
QUERY
,
description
=
"page starting from 0, offset"
)
@RequestParam
(
required
=
false
)
Integer
page
,
@Parameter
(
in
=
ParameterIn
.
QUERY
,
description
=
"page size, limit"
)
@RequestParam
(
required
=
false
)
Integer
pageSize
);
@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 names by name or uuid (search).
...
...
@@ -208,8 +211,8 @@ public interface INames {
@Parameter
(
in
=
ParameterIn
.
PATH
,
description
=
"name or uuid to search for"
)
@PathVariable
(
"name"
)
String
name
,
@Parameter
(
in
=
ParameterIn
.
QUERY
,
description
=
"order by field"
)
@RequestParam
(
required
=
false
)
FieldName
orderBy
,
@Parameter
(
in
=
ParameterIn
.
QUERY
,
description
=
"sort order, ascending or descending"
)
@RequestParam
(
required
=
false
)
Boolean
isAsc
,
@Parameter
(
in
=
ParameterIn
.
QUERY
,
description
=
"page starting from 0, offset"
)
@RequestParam
(
required
=
false
)
Integer
page
,
@Parameter
(
in
=
ParameterIn
.
QUERY
,
description
=
"page size, limit"
)
@RequestParam
(
required
=
false
)
Integer
pageSize
);
@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 names by system structure mnemonic path (search).
...
...
@@ -240,8 +243,8 @@ public interface INames {
@Parameter
(
in
=
ParameterIn
.
PATH
,
description
=
"mnemonic path to search for"
)
@PathVariable
(
"mnemonicpath"
)
String
mnemonicpath
,
@Parameter
(
in
=
ParameterIn
.
QUERY
,
description
=
"order by field"
)
@RequestParam
(
required
=
false
)
FieldName
orderBy
,
@Parameter
(
in
=
ParameterIn
.
QUERY
,
description
=
"sort order, ascending or descending"
)
@RequestParam
(
required
=
false
)
Boolean
isAsc
,
@Parameter
(
in
=
ParameterIn
.
QUERY
,
description
=
"page starting from 0, offset"
)
@RequestParam
(
required
=
false
)
Integer
page
,
@Parameter
(
in
=
ParameterIn
.
QUERY
,
description
=
"page size, limit"
)
@RequestParam
(
required
=
false
)
Integer
pageSize
);
@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 names by device structure mnemonic path (search).
...
...
@@ -272,8 +275,8 @@ public interface INames {
@Parameter
(
in
=
ParameterIn
.
PATH
,
description
=
"mnemonic path to search for"
)
@PathVariable
(
"mnemonicpath"
)
String
mnemonicpath
,
@Parameter
(
in
=
ParameterIn
.
QUERY
,
description
=
"order by field"
)
@RequestParam
(
required
=
false
)
FieldName
orderBy
,
@Parameter
(
in
=
ParameterIn
.
QUERY
,
description
=
"sort order, ascending or descending"
)
@RequestParam
(
required
=
false
)
Boolean
isAsc
,
@Parameter
(
in
=
ParameterIn
.
QUERY
,
description
=
"page starting from 0, offset"
)
@RequestParam
(
required
=
false
)
Integer
page
,
@Parameter
(
in
=
ParameterIn
.
QUERY
,
description
=
"page size, limit"
)
@RequestParam
(
required
=
false
)
Integer
pageSize
);
@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 history for name by uuid (exact match).
...
...
@@ -304,8 +307,8 @@ public interface INames {
@Parameter
(
in
=
ParameterIn
.
PATH
,
description
=
"uuid to find history for"
)
@PathVariable
(
"uuid"
)
String
uuid
,
@Parameter
(
in
=
ParameterIn
.
QUERY
,
description
=
"order by field"
)
@RequestParam
(
required
=
false
)
FieldName
orderBy
,
@Parameter
(
in
=
ParameterIn
.
QUERY
,
description
=
"sort order, ascending or descending"
)
@RequestParam
(
required
=
false
)
Boolean
isAsc
,
@Parameter
(
in
=
ParameterIn
.
QUERY
,
description
=
"page starting from 0, offset"
)
@RequestParam
(
required
=
false
)
Integer
page
,
@Parameter
(
in
=
ParameterIn
.
QUERY
,
description
=
"page size, limit"
)
@RequestParam
(
required
=
false
)
Integer
pageSize
);
@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
);
// ----------------------------------------------------------------------------------------------------
...
...
This diff is collapsed.
Click to expand it.
src/main/java/org/openepics/names/rest/api/v1/IStructures.java
+
13
−
10
View file @
b499a5bc
...
...
@@ -113,6 +113,9 @@ public interface IStructures {
update PATCH /structures/reject - rejectStructures (List<StructureElement>)
*/
public
static
final
String
DEFAULT_PAGE
=
"0"
;
public
static
final
String
DEFAULT_PAGE_SIZE
=
"100"
;
/**
* Create (propose) structures by list of structure elements.
* Return list of created structure elements (proposals).
...
...
@@ -197,8 +200,8 @@ public interface IStructures {
@Parameter
(
in
=
ParameterIn
.
QUERY
,
description
=
"search values corresponding to search fields"
)
@RequestParam
(
required
=
false
)
String
[]
queryValues
,
@Parameter
(
in
=
ParameterIn
.
QUERY
,
description
=
"order by field"
)
@RequestParam
(
required
=
false
)
FieldStructure
orderBy
,
@Parameter
(
in
=
ParameterIn
.
QUERY
,
description
=
"sort order, ascending or descending"
)
@RequestParam
(
required
=
false
)
Boolean
isAsc
,
@Parameter
(
in
=
ParameterIn
.
QUERY
,
description
=
"page starting from 0, offset"
)
@RequestParam
(
required
=
false
)
Integer
page
,
@Parameter
(
in
=
ParameterIn
.
QUERY
,
description
=
"page size, limit"
)
@RequestParam
(
required
=
false
)
Integer
pageSize
);
@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 children structures by type and parent uuid (exact match).
...
...
@@ -231,8 +234,8 @@ public interface IStructures {
@Parameter
(
in
=
ParameterIn
.
PATH
,
description
=
"uuid to find structure for"
)
@PathVariable
(
"uuid"
)
String
uuid
,
@Parameter
(
in
=
ParameterIn
.
QUERY
,
description
=
"order by field"
)
@RequestParam
(
required
=
false
)
FieldStructure
orderBy
,
@Parameter
(
in
=
ParameterIn
.
QUERY
,
description
=
"sort order, ascending or descending"
)
@RequestParam
(
required
=
false
)
Boolean
isAsc
,
@Parameter
(
in
=
ParameterIn
.
QUERY
,
description
=
"page starting from 0, offset"
)
@RequestParam
(
required
=
false
)
Integer
page
,
@Parameter
(
in
=
ParameterIn
.
QUERY
,
description
=
"page size, limit"
)
@RequestParam
(
required
=
false
)
Integer
pageSize
);
@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 structures by mnemonic (search).
...
...
@@ -264,8 +267,8 @@ public interface IStructures {
@Parameter
(
in
=
ParameterIn
.
PATH
,
description
=
"mnemonic to search for"
)
@PathVariable
(
"mnemonic"
)
String
mnemonic
,
@Parameter
(
in
=
ParameterIn
.
QUERY
,
description
=
"order by field"
)
@RequestParam
(
required
=
false
)
FieldStructure
orderBy
,
@Parameter
(
in
=
ParameterIn
.
QUERY
,
description
=
"sort order, ascending or descending"
)
@RequestParam
(
required
=
false
)
Boolean
isAsc
,
@Parameter
(
in
=
ParameterIn
.
QUERY
,
description
=
"page starting from 0, offset"
)
@RequestParam
(
required
=
false
)
Integer
page
,
@Parameter
(
in
=
ParameterIn
.
QUERY
,
description
=
"page size, limit"
)
@RequestParam
(
required
=
false
)
Integer
pageSize
);
@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 structures by mnemonic path (search).
...
...
@@ -297,8 +300,8 @@ public interface IStructures {
@Parameter
(
in
=
ParameterIn
.
PATH
,
description
=
"mnemonic path to search for"
)
@PathVariable
(
"mnemonicpath"
)
String
mnemonicpath
,
@Parameter
(
in
=
ParameterIn
.
QUERY
,
description
=
"order by field"
)
@RequestParam
(
required
=
false
)
FieldStructure
orderBy
,
@Parameter
(
in
=
ParameterIn
.
QUERY
,
description
=
"sort order, ascending or descending"
)
@RequestParam
(
required
=
false
)
Boolean
isAsc
,
@Parameter
(
in
=
ParameterIn
.
QUERY
,
description
=
"page starting from 0, offset"
)
@RequestParam
(
required
=
false
)
Integer
page
,
@Parameter
(
in
=
ParameterIn
.
QUERY
,
description
=
"page size, limit"
)
@RequestParam
(
required
=
false
)
Integer
pageSize
);
@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 history for structure by uuid (exact match).
...
...
@@ -331,8 +334,8 @@ public interface IStructures {
@Parameter
(
in
=
ParameterIn
.
QUERY
,
description
=
"type of structure to search in"
)
@RequestParam
(
required
=
false
)
Type
type
,
@Parameter
(
in
=
ParameterIn
.
QUERY
,
description
=
"order by field"
)
@RequestParam
(
required
=
false
)
FieldStructure
orderBy
,
@Parameter
(
in
=
ParameterIn
.
QUERY
,
description
=
"sort order, ascending or descending"
)
@RequestParam
(
required
=
false
)
Boolean
isAsc
,
@Parameter
(
in
=
ParameterIn
.
QUERY
,
description
=
"page starting from 0, offset"
)
@RequestParam
(
required
=
false
)
Integer
page
,
@Parameter
(
in
=
ParameterIn
.
QUERY
,
description
=
"page size, limit"
)
@RequestParam
(
required
=
false
)
Integer
pageSize
);
@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
);
// ----------------------------------------------------------------------------------------------------
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment