Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API documentation, testdata and registry client library #227

Merged
merged 36 commits into from
Oct 26, 2023

Conversation

ds-jhartmann
Copy link
Contributor

@ds-jhartmann ds-jhartmann commented Oct 25, 2023

Description

  • Updated default values for API documentation
  • Updated testdata
  • New release process for digital-twin-registry-client library

Pre-review checks

Please ensure to do as many of the following checks as possible, before asking for committer review:

ds-jhartmann and others added 30 commits October 17, 2023 09:17
…ent-1.3.2-SNAPSHOT

Update irs-registry-client to 1.3.2-SNAPSHOT
chore(testing): update ESS investigation request
…-documentation-with-example-value

feat:[TRI-1685]: added example values to open api yaml, fixed problem…
@ds-jhartmann ds-jhartmann changed the title API documentation and testdata API documentation, testdata and registry client library Oct 26, 2023
public class Permission {

@Schema(implementation = PolicyType.class, example = "ACCESS")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we use "USE" instead because that leads more to the use as access is directly handled by MIW and EDC. ACCESS policies are not used in this context.


@NotNull
@Size(min = JOB_ID_FIELD_MAX_LENGTH, max = JOB_ID_FIELD_MAX_LENGTH)
@Schema(description = "Id of the job.", minLength = JOB_ID_FIELD_MAX_LENGTH,
maxLength = JOB_ID_FIELD_MAX_LENGTH, implementation = UUID.class,
pattern = "/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i")
pattern = "/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

recommendation to extract this into a static constant

@Min(0)
@Max(Integer.MAX_VALUE)
private Integer depth;

@Schema(implementation = String.class)
@Schema(implementation = String.class, example = "BPNL00000003AYRE")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Using constants instead of stings in annotations?

private BomLifecycle lifecycleContext;

@Schema(description = "Datetime of assembly.", implementation = ZonedDateTime.class)
@Schema(description = "Datetime of assembly.", implementation = ZonedDateTime.class, example = "2022-02-03T14:48:54.709Z")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

using a constant - probably with a reason date

@@ -37,11 +38,13 @@ public class MeasurementUnit {
/**
* dataTypeURI
*/
@Schema(implementation = String.class, example = "urn:bamm:io.openmanufacturing:meta-model:1.0.0#piece")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

constants

@ds-jhartmann ds-jhartmann merged commit ffd4459 into eclipse-tractusx:main Oct 26, 2023
17 of 18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants