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

Adjust OpenAPI Files for Discovery Service Profiles #229

Merged

Conversation

sebbader-sap
Copy link
Contributor

@sebbader-sap sebbader-sap commented Feb 19, 2024

The names of the files did not match to the version (v3.1) in which they are going to be published.

Copy link
Collaborator

@BirgitBoss BirgitBoss left a comment

Choose a reason for hiding this comment

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

V3.0_SSP-001.yaml is not identical to the corresponding file in release 3.0 but it should, no? Or is it V3.0.2?

@BirgitBoss
Copy link
Collaborator

We need to check versions of API-operations: will version increase to V3.1 if payload changed due to changes in Part 1? We need to check this.

@sebbader-sap
Copy link
Contributor Author

We need to check versions of API-operations: will version increase to V3.1 if payload changed due to changes in Part 1? We need to check this.

Yes, this is an unavoidable consequence: If Part 1 V3.1 is published, the SwaggerHub Domain Part 1 Version 3.1 will be created. As all SwaggerHub APIs, e.g., DiscoveryServiceSpecification V3.0.1, explicitly link to one and only one version of a Domain (for now Part 2 V3.0.1, which referencers Part 1 V3.0.1), we need to release a equivalent version (V3.1.0) for each API, too.

@sebbader-sap
Copy link
Contributor Author

V3.0_SSP-001.yaml is not identical to the corresponding file in release 3.0 but it should, no? Or is it V3.0.2?

It should, or am I missing anything? See also my comment above.

@BirgitBoss
Copy link
Collaborator

Can you please add the milestone this PR belongs to?

@BirgitBoss BirgitBoss added this to the 3.1 milestone Mar 4, 2024
- url: 'https://admin-shell.io/api/v3.1'
- url: 'https://example.com/'

- url: '{protocol}://{host_name}:{port}/api/{version_prefix}'
Copy link
Collaborator

Choose a reason for hiding this comment

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

Didn't we decide to support very flexible URL, just {protocol}://{base-url}. + Text: We recommend to use major version of API version only. After version it is still possible that there is a tenant-ID or a different order...

Copy link
Collaborator

@BirgitBoss BirgitBoss Mar 5, 2024

Choose a reason for hiding this comment

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

This is 3.0.1 but 3.0.1 is already released: I am getting confused…

- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/parameters/AssetIds'
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/parameters/Limit'
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/parameters/Cursor'
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.1#/components/parameters/AssetIds'
Copy link
Collaborator

Choose a reason for hiding this comment

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

this is not parameter any longer but part of the request body

Copy link
Collaborator

Choose a reason for hiding this comment

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

This 3.0.1

@BirgitBoss BirgitBoss removed this from the 3.1 milestone Mar 4, 2024
Copy link
Collaborator

@BirgitBoss BirgitBoss left a comment

Choose a reason for hiding this comment

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

see minor improvements

@sebbader-sap sebbader-sap added this to the 3.1 milestone Mar 12, 2024
@@ -11,83 +11,62 @@ info:
license:
name: CC BY 4.0
url: https://creativecommons.org/licenses/by/4.0/
version: V3.1.0_SSP-001
x-profile-identifier: https://admin-shell.io/aas/API/3/1/DiscoveryServiceSpecification/SSP-001
version: V3.0.1_SSP-001
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
version: V3.0.1_SSP-001
version: V3.1.0_SSP-001

Copy link
Collaborator

@BirgitBoss BirgitBoss Apr 9, 2024

Choose a reason for hiding this comment

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

It is now V3.1, no? But all changes are for V3.0.1 but you want to merge it to branch of V3.1?

@sebbader-sap
Copy link
Contributor Author

increase version from 3.0 to 3.1 also for logical operations?

I haven't done this yet as long as the operation had no changes compared to the V3.0.3 version (apart of the reference links to the Part 1 and Part 2 domains...).

@sebbader-sap
Copy link
Contributor Author

Why did V3.1_SSP-002.yaml not changes?

That's fixing an error in the current IDTA-01002-3-1_preparation branch: The profile file was already there for a long time, but the filename was wrong (was: V3.0_SSP-002.yaml but actually will be introduced with V3.1 for the first time).

@sebbader-sap
Copy link
Contributor Author

@BirgitBoss I think I have incorporated your requests so far. For the x-semanticIds .../3/0 vs. .../3/1 see my comment above. Please have a look again.

Copy link
Collaborator

@BirgitBoss BirgitBoss left a comment

Choose a reason for hiding this comment

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

Thanks for the changes. We should discuss the following points for all profiles, not specific to discovery:

  • versioning of API-operations in case of increased class versions
  • examples and recommndations for correct servers

@sebbader-sap
Copy link
Contributor Author

I documented the two problems in #363 and #364.

@sebbader-sap sebbader-sap merged commit 4d221ed into IDTA-01002-3-1_preparation Jan 5, 2025
1 check passed
@sebbader-sap sebbader-sap deleted the SeBa-rename-discovery-openapi branch January 5, 2025 12:07
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.

2 participants