-
Notifications
You must be signed in to change notification settings - Fork 7
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
Adjust OpenAPI Files for Discovery Service Profiles #229
Conversation
There was a problem hiding this 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?
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. |
Co-authored-by: Birgit Boss <[email protected]>
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. |
It should, or am I missing anything? See also my comment above. |
Can you please add the milestone this PR belongs to? |
- url: 'https://admin-shell.io/api/v3.1' | ||
- url: 'https://example.com/' | ||
|
||
- url: '{protocol}://{host_name}:{port}/api/{version_prefix}' |
There was a problem hiding this comment.
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...
There was a problem hiding this comment.
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' |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This 3.0.1
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
see minor improvements
@@ -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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
version: V3.0.1_SSP-001 | |
version: V3.1.0_SSP-001 |
There was a problem hiding this comment.
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?
Co-authored-by: Birgit Boss <[email protected]>
Co-authored-by: Birgit Boss <[email protected]>
Co-authored-by: Birgit Boss <[email protected]>
Co-authored-by: Birgit Boss <[email protected]>
Co-authored-by: Birgit Boss <[email protected]>
Co-authored-by: Birgit Boss <[email protected]>
Co-authored-by: Birgit Boss <[email protected]>
…min-shell-io/aas-specs-api into SeBa-rename-discovery-openapi
Co-authored-by: Birgit Boss <[email protected]>
Co-authored-by: Birgit Boss <[email protected]>
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...). |
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). |
@BirgitBoss I think I have incorporated your requests so far. For the x-semanticIds |
There was a problem hiding this 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
The names of the files did not match to the version (v3.1) in which they are going to be published.